From fd1c63103fbd051b74ed758635049621283bb2b2 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 12 Apr 2025 03:23:36 +0000 Subject: [PATCH] classref: Sync with current master branch (215acd5) --- classes/class_@gdscript.rst | 4 +- classes/class_@globalscope.rst | 2 +- classes/class_acceptdialog.rst | 10 +- classes/class_animatedsprite2d.rst | 2 +- classes/class_animatedsprite3d.rst | 2 +- classes/class_animationmixer.rst | 2 +- classes/class_animationplayer.rst | 4 +- classes/class_array.rst | 6 +- classes/class_audioeffectphaser.rst | 2 +- classes/class_audiostreamplayer3d.rst | 6 +- classes/class_basematerial3d.rst | 2 +- classes/class_boneattachment3d.rst | 2 +- classes/class_button.rst | 19 + classes/class_camera2d.rst | 19 + classes/class_cameraserver.rst | 36 + classes/class_canvasitem.rst | 98 +- classes/class_canvaslayer.rst | 2 +- classes/class_characterbody2d.rst | 4 +- classes/class_characterbody3d.rst | 4 +- classes/class_checkbox.rst | 66 +- classes/class_checkbutton.rst | 66 +- classes/class_codeedit.rst | 6 +- classes/class_color.rst | 8 + classes/class_colorpicker.rst | 142 +- classes/class_container.rst | 2 +- classes/class_control.rst | 158 +- classes/class_csgshape3d.rst | 14 +- classes/class_dictionary.rst | 15 +- classes/class_diraccess.rst | 14 + classes/class_displayserver.rst | 3630 +++++++++++++---- classes/class_editorexportplatform.rst | 8 +- classes/class_editorexportplatformandroid.rst | 2 +- classes/class_editorexportplatformios.rst | 4 +- classes/class_editorexportplugin.rst | 18 + classes/class_editorexportpreset.rst | 24 +- classes/class_editorinspector.rst | 2 + classes/class_editorinterface.rst | 20 +- classes/class_editorplugin.rst | 30 +- classes/class_editorproperty.rst | 52 +- .../class_editorsceneformatimporterblend.rst | 2 +- classes/class_editorselection.rst | 20 +- classes/class_editorsettings.rst | 158 +- classes/class_fileaccess.rst | 40 +- classes/class_foldablecontainer.rst | 601 +++ classes/class_foldablegroup.rst | 130 + classes/class_fontfile.rst | 19 + classes/class_gltfaccessor.rst | 4 +- classes/class_gltflight.rst | 6 +- classes/class_gltfnode.rst | 2 +- classes/class_gltfobjectmodelproperty.rst | 2 +- classes/class_gltfphysicsbody.rst | 6 +- classes/class_gltfphysicsshape.rst | 14 +- classes/class_gltfstate.rst | 4 +- classes/class_graphedit.rst | 59 + classes/class_graphnode.rst | 30 + classes/class_image.rst | 48 + classes/class_inputmap.rst | 14 + classes/class_javaclasswrapper.rst | 2 + classes/class_jsonrpc.rst | 12 +- classes/class_label.rst | 35 + classes/class_label3d.rst | 21 +- classes/class_light3d.rst | 2 +- classes/class_lineedit.rst | 10 +- classes/class_linkbutton.rst | 2 +- classes/class_lookatmodifier3d.rst | 2 +- classes/class_material.rst | 2 +- classes/class_menubar.rst | 28 +- classes/class_menubutton.rst | 2 +- classes/class_mesh.rst | 2 +- classes/class_multiplayerapiextension.rst | 5 + classes/class_nativemenu.rst | 2 +- .../class_navigationpathqueryparameters2d.rst | 42 + .../class_navigationpathqueryparameters3d.rst | 42 + classes/class_navigationserver2d.rst | 137 + classes/class_navigationserver3d.rst | 2 + classes/class_node.rst | 295 +- classes/class_node3d.rst | 221 +- classes/class_object.rst | 154 +- .../class_openxranalogthresholdmodifier.rst | 4 +- classes/class_openxrapiextension.rst | 58 +- classes/class_openxrcompositionlayer.rst | 442 +- classes/class_openxrdpadbindingmodifier.rst | 8 +- classes/class_openxrextensionwrapper.rst | 664 +++ .../class_openxrextensionwrapperextension.rst | 577 +-- classes/class_openxrfutureextension.rst | 100 + classes/class_openxrfutureresult.rst | 144 + classes/class_openxrinterface.rst | 206 +- classes/class_optionbutton.rst | 140 +- classes/class_os.rst | 24 +- classes/class_packedbytearray.rst | 84 +- classes/class_packedcolorarray.rst | 18 +- classes/class_packedfloat32array.rst | 20 +- classes/class_packedfloat64array.rst | 20 +- classes/class_packedint32array.rst | 18 +- classes/class_packedint64array.rst | 18 +- classes/class_packedstringarray.rst | 18 +- classes/class_packedvector2array.rst | 20 +- classes/class_packedvector3array.rst | 20 +- classes/class_packedvector4array.rst | 22 +- classes/class_path3d.rst | 39 +- classes/class_performance.rst | 182 +- classes/class_physicsdirectspacestate2d.rst | 6 +- classes/class_physicsdirectspacestate3d.rst | 2 +- classes/class_popup.rst | 32 +- classes/class_popupmenu.rst | 316 +- classes/class_portablecompressedtexture2d.rst | 12 + classes/class_primitivemesh.rst | 2 +- classes/class_projection.rst | 2 +- classes/class_projectsettings.rst | 834 +++- classes/class_rdtextureview.rst | 4 +- classes/class_rdvertexattribute.rst | 4 +- classes/class_refcounted.rst | 2 +- classes/class_renderingdevice.rst | 192 +- classes/class_renderingserver.rst | 80 +- classes/class_resource.rst | 2 +- classes/class_resourceimporterdynamicfont.rst | 14 + classes/class_resourceuid.rst | 14 + classes/class_richtextlabel.rst | 69 +- classes/class_scenestate.rst | 28 + classes/class_scenetree.rst | 53 +- classes/class_scriptlanguage.rst | 12 + classes/class_scrollbar.rst | 12 +- classes/class_signal.rst | 148 +- classes/class_skeleton3d.rst | 32 +- classes/class_skeletonmodifier3d.rst | 34 +- classes/class_springbonesimulator3d.rst | 33 +- classes/class_spritebase3d.rst | 2 +- classes/class_streampeer.rst | 2 +- classes/class_streampeergzip.rst | 4 +- classes/class_string.rst | 139 +- classes/class_stringname.rst | 129 +- classes/class_systemfont.rst | 19 + classes/class_tabbar.rst | 35 +- classes/class_tabcontainer.rst | 14 + classes/class_textedit.rst | 27 + classes/class_textline.rst | 88 +- classes/class_textparagraph.rst | 158 +- classes/class_textserver.rst | 226 +- classes/class_textserverextension.rst | 208 + classes/class_tiledata.rst | 4 +- classes/class_tilemaplayer.rst | 27 +- classes/class_tileset.rst | 16 +- classes/class_tilesetatlassource.rst | 6 +- .../class_tilesetscenescollectionsource.rst | 6 +- classes/class_tree.rst | 46 +- classes/class_treeitem.rst | 480 ++- classes/class_trianglemesh.rst | 107 +- classes/class_tween.rst | 32 +- classes/class_udpserver.rst | 2 +- classes/class_viewport.rst | 98 +- classes/class_visibleonscreennotifier2d.rst | 25 +- classes/class_window.rst | 121 +- classes/class_xrcamera3d.rst | 12 + classes/class_xrcontroller3d.rst | 10 +- classes/class_xrinterface.rst | 8 + classes/class_xrnode3d.rst | 16 +- classes/index.rst | 5 + 157 files changed, 10676 insertions(+), 2867 deletions(-) create mode 100644 classes/class_foldablecontainer.rst create mode 100644 classes/class_foldablegroup.rst create mode 100644 classes/class_openxrextensionwrapper.rst create mode 100644 classes/class_openxrfutureextension.rst create mode 100644 classes/class_openxrfutureresult.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 4f5e6008a53..58abd13be98 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -1089,7 +1089,7 @@ Starting from ``_ready()``, ``bar()`` would print: **Deprecated:** Consider using :ref:`JSON.from_native()` or :ref:`Object.get_property_list()` instead. -Returns the passed ``instance`` converted to a Dictionary. Can be useful for serializing. +Returns the passed ``instance`` converted to a :ref:`Dictionary`. Can be useful for serializing. :: @@ -1128,7 +1128,7 @@ Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value mus - A :ref:`Script` (you can use any class, including inner one). -Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need dynamic type checking. +Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need to check the type dynamically. \ **Examples:**\ diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 97755bbead7..1f780985e43 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3810,7 +3810,7 @@ Hints that a property is an :ref:`Array` with the stored type speci :ref:`PropertyHint` **PROPERTY_HINT_DICTIONARY_TYPE** = ``38`` -Hints that a property is a :ref:`Dictionary` with the stored types specified in the hint string. +Hints that a property is a :ref:`Dictionary` with the stored types specified in the hint string. The hint string contains the key and value types separated by a semicolon (e.g. ``"int;String"``). .. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALE_ID: diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 7b24b3ceda7..eba6558d494 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -44,7 +44,11 @@ Properties +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | keep_title_visible | ``true`` (overrides :ref:`Window`) | +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`ok_button_text` | ``"OK"`` | + | :ref:`bool` | maximize_disabled | ``true`` (overrides :ref:`Window`) | + +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | minimize_disabled | ``true`` (overrides :ref:`Window`) | + +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ok_button_text` | ``""`` | +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | title | ``"Alert!"`` (overrides :ref:`Window`) | +-----------------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------+ @@ -219,14 +223,14 @@ The text displayed by the dialog. .. rst-class:: classref-property -:ref:`String` **ok_button_text** = ``"OK"`` :ref:`🔗` +:ref:`String` **ok_button_text** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ok_button_text**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_ok_button_text**\ (\ ) -The text displayed by the OK button (see :ref:`get_ok_button()`). +The text displayed by the OK button (see :ref:`get_ok_button()`). If empty, a default text will be used. .. rst-class:: classref-section-separator diff --git a/classes/class_animatedsprite2d.rst b/classes/class_animatedsprite2d.rst index 0810c8ffc9d..1cb41428900 100644 --- a/classes/class_animatedsprite2d.rst +++ b/classes/class_animatedsprite2d.rst @@ -413,7 +413,7 @@ This method is a shorthand for :ref:`play()` |void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) :ref:`🔗` -Sets :ref:`frame` the :ref:`frame_progress` to the given values. Unlike setting :ref:`frame`, this method does not reset the :ref:`frame_progress` to ``0.0`` implicitly. +Sets :ref:`frame` and :ref:`frame_progress` to the given values. Unlike setting :ref:`frame`, this method does not reset the :ref:`frame_progress` to ``0.0`` implicitly. \ **Example:** Change the animation while keeping the same :ref:`frame` and :ref:`frame_progress`: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index d42a4c0c37a..3941da0fb68 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -333,7 +333,7 @@ This method is a shorthand for :ref:`play()` |void| **set_frame_and_progress**\ (\ frame\: :ref:`int`, progress\: :ref:`float`\ ) :ref:`🔗` -Sets :ref:`frame` the :ref:`frame_progress` to the given values. Unlike setting :ref:`frame`, this method does not reset the :ref:`frame_progress` to ``0.0`` implicitly. +Sets :ref:`frame` and :ref:`frame_progress` to the given values. Unlike setting :ref:`frame`, this method does not reset the :ref:`frame_progress` to ``0.0`` implicitly. \ **Example:** Change the animation while keeping the same :ref:`frame` and :ref:`frame_progress`: diff --git a/classes/class_animationmixer.rst b/classes/class_animationmixer.rst index 950ce0d9622..cef4a8a038e 100644 --- a/classes/class_animationmixer.rst +++ b/classes/class_animationmixer.rst @@ -732,7 +732,7 @@ By using this in combination with :ref:`get_root_motion_rotation_accumulator()` is ``true``, return the pre-multiplied translation value with the inverted rotation. +If :ref:`root_motion_local` is ``true``, returns the pre-multiplied translation value with the inverted rotation. In this case, the code can be written as follows: diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index bb1c2132337..990c3229078 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -622,7 +622,7 @@ Returns the start time of the section currently being played. :ref:`bool` **has_section**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if an animation is currently playing with section. +Returns ``true`` if an animation is currently playing with a section. .. rst-class:: classref-item-separator @@ -787,7 +787,7 @@ Queues an animation for playback once the current animation and all previously q |void| **reset_section**\ (\ ) :ref:`🔗` -Resets the current section if section is set. +Resets the current section. Does nothing if a section has not been set. .. rst-class:: classref-item-separator diff --git a/classes/class_array.rst b/classes/class_array.rst index 7dccd424380..ddf93157ce5 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -916,7 +916,7 @@ Returns a hashed 32-bit integer value representing the array and its contents. :ref:`int` **insert**\ (\ position\: :ref:`int`, value\: :ref:`Variant`\ ) :ref:`🔗` -Inserts a new element (``value``) at a given index (``position``) in the array. ``position`` should be between ``0`` and the array's :ref:`size()`. +Inserts a new element (``value``) at a given index (``position``) in the array. ``position`` should be between ``0`` and the array's :ref:`size()`. If negative, ``position`` is considered relative to the end of the array. Returns :ref:`@GlobalScope.OK` on success, or one of the other :ref:`Error` constants if this method fails. @@ -1205,7 +1205,7 @@ See also :ref:`map()`, :ref:`filter()`\ ) :ref:`🔗` -Removes the element from the array at the given index (``position``). If the index is out of bounds, this method fails. +Removes the element from the array at the given index (``position``). If the index is out of bounds, this method fails. If the index is negative, ``position`` is considered relative to the end of the array. If you need to return the removed element, use :ref:`pop_at()`. To remove an element by value, use :ref:`erase()` instead. @@ -1225,7 +1225,7 @@ If you need to return the removed element, use :ref:`pop_at()` on success, or one of the other :ref:`Error` constants if this method fails. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_LOCKED` if the array is read-only, :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. \ **Note:** Calling this method once and assigning the new values is faster than calling :ref:`append()` for every new element. diff --git a/classes/class_audioeffectphaser.rst b/classes/class_audioeffectphaser.rst index 015a6faa3e4..6007591ff94 100644 --- a/classes/class_audioeffectphaser.rst +++ b/classes/class_audioeffectphaser.rst @@ -70,7 +70,7 @@ Property Descriptions - |void| **set_depth**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_depth**\ (\ ) -Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. +Determines how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from ``0.1`` to ``4.0``. .. rst-class:: classref-item-separator diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 66cf3ebb20e..8ecb45b842f 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -454,7 +454,11 @@ The maximum number of sounds this node can play at the same time. Playing additi - |void| **set_panning_strength**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_panning_strength**\ (\ ) -Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/3d_panning_strength` with this factor. Higher values will pan audio from left to right more dramatically than lower values. +Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/3d_panning_strength` by this factor. If the product is ``0.0`` then stereo panning is disabled and the volume is the same for all channels. If the product is ``1.0`` then one of the channels will be muted when the sound is located exactly to the left (or right) of the listener. + +Two speaker stereo arrangements implement the `WebAudio standard for StereoPannerNode Panning `__ where the volume is cosine of half the azimuth angle to the ear. + +For other speaker arrangements such as the 5.1 and 7.1 the SPCAP (Speaker-Placement Correction Amplitude) algorithm is implemented. .. rst-class:: classref-item-separator diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 859d9b665f3..ee7ff35e93e 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -2219,7 +2219,7 @@ Texture that specifies how much surface emits light at a given point. - |void| **set_flag**\ (\ flag\: :ref:`Flags`, enable\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| -If ``true``, the object is rendered at the same size regardless of distance. +If ``true``, the object is rendered at the same size regardless of distance. The object's size on screen is the same as if the camera was ``1.0`` units away from the object's origin, regardless of the actual distance from the camera. The :ref:`Camera3D`'s field of view (or :ref:`Camera3D.size` when in orthogonal/frustum mode) still affects the size the object is drawn at. .. rst-class:: classref-item-separator diff --git a/classes/class_boneattachment3d.rst b/classes/class_boneattachment3d.rst index 7e2a1328a7c..3aee9e350bd 100644 --- a/classes/class_boneattachment3d.rst +++ b/classes/class_boneattachment3d.rst @@ -147,7 +147,7 @@ Returns the :ref:`NodePath` to the external :ref:`Skeleton3D` **get_skeleton**\ (\ ) :ref:`🔗` -Get parent or external :ref:`Skeleton3D` node if found. +Returns the parent or external :ref:`Skeleton3D` node if it exists, otherwise returns ``null``. .. rst-class:: classref-item-separator diff --git a/classes/class_button.rst b/classes/class_button.rst index cde7504729d..90a2fe6a959 100644 --- a/classes/class_button.rst +++ b/classes/class_button.rst @@ -82,6 +82,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``128`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`clip_text` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`expand_icon` | ``false`` | @@ -220,6 +222,23 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF`\] **autowrap_trim_flags** = ``128`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +Autowrap space trimming flags. See :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` and :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES` for more info. + +.. rst-class:: classref-item-separator + +---- + .. _class_Button_property_clip_text: .. rst-class:: classref-property diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 8db1e180a8a..0a30348941a 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -77,6 +77,8 @@ Properties +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`limit_bottom` | ``10000000`` | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ + | :ref:`bool` | :ref:`limit_enabled` | ``true`` | + +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`limit_left` | ``-10000000`` | +-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`limit_right` | ``10000000`` | @@ -476,6 +478,23 @@ Bottom scroll limit in pixels. The camera stops moving when reaching this value, ---- +.. _class_Camera2D_property_limit_enabled: + +.. rst-class:: classref-property + +:ref:`bool` **limit_enabled** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_limit_enabled**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_limit_enabled**\ (\ ) + +If ``true``, the limits will be enabled. Disabling this will allow the camera to focus anywhere, when the four ``limit_*`` properties will not work. + +.. rst-class:: classref-item-separator + +---- + .. _class_Camera2D_property_limit_left: .. rst-class:: classref-property diff --git a/classes/class_cameraserver.rst b/classes/class_cameraserver.rst index 334b70064c5..520781bc252 100644 --- a/classes/class_cameraserver.rst +++ b/classes/class_cameraserver.rst @@ -27,6 +27,18 @@ It is notably used to provide AR modules with a video feed from the camera. .. rst-class:: classref-reftable-group +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+-----------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`monitoring_feeds` | ``false`` | + +-------------------------+-----------------------------------------------------------------------+-----------+ + +.. rst-class:: classref-reftable-group + Methods ------- @@ -127,6 +139,30 @@ The CbCr component camera image. .. rst-class:: classref-descriptions-group +Property Descriptions +--------------------- + +.. _class_CameraServer_property_monitoring_feeds: + +.. rst-class:: classref-property + +:ref:`bool` **monitoring_feeds** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_monitoring_feeds**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_monitoring_feeds**\ (\ ) + +If ``true``, the server is actively monitoring available camera feeds. + +This has a performance cost, so only set it to ``true`` when you're actively accessing the camera. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Method Descriptions ------------------- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 68319c65f2d..f65f28b310c 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -241,7 +241,7 @@ Emitted when the **CanvasItem** must redraw, *after* the related :ref:`NOTIFICAT **hidden**\ (\ ) :ref:`🔗` -Emitted when the **CanvasItem** is hidden, i.e. it's no longer visible in the tree (see :ref:`is_visible_in_tree()`). +Emitted when this node becomes hidden, i.e. it's no longer visible in the tree (see :ref:`is_visible_in_tree()`). .. rst-class:: classref-item-separator @@ -267,6 +267,8 @@ Emitted when the **CanvasItem**'s boundaries (position or size) change, or when Emitted when the **CanvasItem**'s visibility changes, either because its own :ref:`visible` property changed or because its visibility in the tree changed (see :ref:`is_visible_in_tree()`). +This signal is emitted *after* the related :ref:`NOTIFICATION_VISIBILITY_CHANGED` notification. + .. rst-class:: classref-section-separator ---- @@ -378,7 +380,7 @@ The **CanvasItem** will inherit the filter from its parent. :ref:`TextureRepeat` **TEXTURE_REPEAT_DISABLED** = ``1`` -Texture will not repeat. +The texture does not repeat. .. _class_CanvasItem_constant_TEXTURE_REPEAT_ENABLED: @@ -386,7 +388,7 @@ Texture will not repeat. :ref:`TextureRepeat` **TEXTURE_REPEAT_ENABLED** = ``2`` -Texture will repeat normally. +The texture repeats when exceeding the texture's size. .. _class_CanvasItem_constant_TEXTURE_REPEAT_MIRROR: @@ -394,7 +396,7 @@ Texture will repeat normally. :ref:`TextureRepeat` **TEXTURE_REPEAT_MIRROR** = ``3`` -Texture will repeat in a 2×2 tiled mode, where elements at even positions are mirrored. +The texture repeats when the exceeding the texture's size in a "2×2 tiled mode". Repeated textures at even positions are mirrored. .. _class_CanvasItem_constant_TEXTURE_REPEAT_MAX: @@ -420,7 +422,7 @@ enum **ClipChildrenMode**: :ref:`🔗` :ref:`ClipChildrenMode` **CLIP_CHILDREN_DISABLED** = ``0`` -Child draws over parent and is not clipped. +Children are drawn over this node and are not clipped. .. _class_CanvasItem_constant_CLIP_CHILDREN_ONLY: @@ -428,7 +430,7 @@ Child draws over parent and is not clipped. :ref:`ClipChildrenMode` **CLIP_CHILDREN_ONLY** = ``1`` -Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn. +This node is used as a mask and is **not** drawn. The mask is based on this node's alpha channel: Opaque pixels are kept, transparent pixels are discarded, and semi-transparent pixels are blended in according to their opacity. Children are clipped to this node's drawn area. .. _class_CanvasItem_constant_CLIP_CHILDREN_AND_DRAW: @@ -436,7 +438,7 @@ Parent is used for the purposes of clipping only. Child is clipped to the parent :ref:`ClipChildrenMode` **CLIP_CHILDREN_AND_DRAW** = ``2`` -Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area. +This node is used as a mask and is also drawn. The mask is based on this node's alpha channel: Opaque pixels are kept, transparent pixels are discarded, and semi-transparent pixels are blended in according to their opacity. Children are clipped to the parent's drawn area. .. _class_CanvasItem_constant_CLIP_CHILDREN_MAX: @@ -461,7 +463,9 @@ Constants **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗` -The **CanvasItem**'s global transform has changed. This notification is only received if enabled by :ref:`set_notify_transform()`. +Notification received when this node's global transform changes, if :ref:`is_transform_notification_enabled()` is ``true``. See also :ref:`set_notify_transform()` and :ref:`get_transform()`. + +\ **Note:** Many canvas items such as :ref:`Camera2D` or :ref:`CollisionObject2D` automatically enable this in order to function correctly. .. _class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED: @@ -469,7 +473,9 @@ The **CanvasItem**'s global transform has changed. This notification is only rec **NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``35`` :ref:`🔗` -The **CanvasItem**'s local transform has changed. This notification is only received if enabled by :ref:`set_notify_local_transform()`. +Notification received when this node's transform changes, if :ref:`is_local_transform_notification_enabled()` is ``true``. This is not received when a parent :ref:`Node2D`'s transform changes. See also :ref:`set_notify_local_transform()`. + +\ **Note:** Many canvas items such as :ref:`Camera2D` or :ref:`CollisionShape2D` automatically enable this in order to function correctly. .. _class_CanvasItem_constant_NOTIFICATION_DRAW: @@ -485,7 +491,9 @@ The **CanvasItem** is requested to draw (see :ref:`_draw()` -The **CanvasItem**'s visibility has changed. +Notification received when this node's visibility changes (see :ref:`visible` and :ref:`is_visible_in_tree()`). + +This notification is received *before* the related :ref:`visibility_changed` signal. .. _class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS: @@ -509,7 +517,7 @@ The **CanvasItem** has exited the canvas. **NOTIFICATION_WORLD_2D_CHANGED** = ``36`` :ref:`🔗` -The **CanvasItem**'s active :ref:`World2D` changed. +Notification received when this **CanvasItem** is registered to a new :ref:`World2D` (see :ref:`get_world_2d()`). .. rst-class:: classref-section-separator @@ -531,9 +539,9 @@ Property Descriptions - |void| **set_clip_children_mode**\ (\ value\: :ref:`ClipChildrenMode`\ ) - :ref:`ClipChildrenMode` **get_clip_children_mode**\ (\ ) -Allows the current node to clip child nodes, essentially acting as a mask. +The mode in which this node clips its children, acting as a mask. -\ **Note:** Clipping nodes cannot be nested or placed within :ref:`CanvasGroup`\ s. If an ancestor of this node clips its children or is a :ref:`CanvasGroup`, then this node's clip mode should be set to :ref:`CLIP_CHILDREN_DISABLED` to avoid unexpected behavior. +\ **Note:** Clipping nodes cannot be nested or placed within a :ref:`CanvasGroup`. If an ancestor of this node clips its children or is a :ref:`CanvasGroup`, then this node's clip mode should be set to :ref:`CLIP_CHILDREN_DISABLED` to avoid unexpected behavior. .. rst-class:: classref-item-separator @@ -603,7 +611,7 @@ The color applied to this **CanvasItem**. This property does affect child **Canv The color applied to this **CanvasItem**. This property does **not** affect child **CanvasItem**\ s, unlike :ref:`modulate` which affects both the node itself and its children. -\ **Note:** Internal children (e.g. sliders in :ref:`ColorPicker` or tab bar in :ref:`TabContainer`) are also not affected by this property (see ``include_internal`` parameter of :ref:`Node.get_child()` and other similar methods). +\ **Note:** Internal children are also not affected by this property (see the ``include_internal`` parameter in :ref:`Node.add_child()`). For built-in nodes this includes sliders in :ref:`ColorPicker`, and the tab bar in :ref:`TabContainer`. .. rst-class:: classref-item-separator @@ -620,7 +628,7 @@ The color applied to this **CanvasItem**. This property does **not** affect chil - |void| **set_draw_behind_parent**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_draw_behind_parent_enabled**\ (\ ) -If ``true``, the object draws behind its parent. +If ``true``, this node draws behind its parent. .. rst-class:: classref-item-separator @@ -637,7 +645,7 @@ If ``true``, the object draws behind its parent. - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter`\ ) - :ref:`TextureFilter` **get_texture_filter**\ (\ ) -The texture filtering mode to use on this **CanvasItem**. +The filtering mode used to render this **CanvasItem**'s texture(s). .. rst-class:: classref-item-separator @@ -654,7 +662,7 @@ The texture filtering mode to use on this **CanvasItem**. - |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat`\ ) - :ref:`TextureRepeat` **get_texture_repeat**\ (\ ) -The texture repeating mode to use on this **CanvasItem**. +The repeating mode used to render this **CanvasItem**'s texture(s). .. rst-class:: classref-item-separator @@ -688,7 +696,7 @@ If ``true``, this **CanvasItem** will *not* inherit its transform from parent ** - |void| **set_use_parent_material**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_use_parent_material**\ (\ ) -If ``true``, the parent **CanvasItem**'s :ref:`material` property is used as this one's material. +If ``true``, the parent **CanvasItem**'s :ref:`material` is used as this node's material. .. rst-class:: classref-item-separator @@ -762,7 +770,9 @@ Nodes sort relative to each other only if they are on the same :ref:`z_index`\ ) - :ref:`bool` **is_z_relative**\ (\ ) -If ``true``, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5. +If ``true``, this node's final Z index is relative to its parent's Z index. + +For example, if :ref:`z_index` is ``2`` and its parent's final Z index is ``3``, then this node's final Z index will be ``5`` (``2 + 3``). .. rst-class:: classref-item-separator @@ -779,9 +789,9 @@ If ``true``, the node's Z index is relative to its parent's Z index. If this nod - |void| **set_z_index**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_z_index**\ (\ ) -Controls the order in which the nodes render. A node with a higher Z index will display in front of others. Must be between :ref:`RenderingServer.CANVAS_ITEM_Z_MIN` and :ref:`RenderingServer.CANVAS_ITEM_Z_MAX` (inclusive). +The order in which this node is drawn. A node with a higher Z index will display in front of others. Must be between :ref:`RenderingServer.CANVAS_ITEM_Z_MIN` and :ref:`RenderingServer.CANVAS_ITEM_Z_MAX` (inclusive). -\ **Note:** Changing the Z index of a :ref:`Control` only affects the drawing order, not the order in which input events are handled. This can be useful to implement certain UI animations, e.g. a menu where hovered items are scaled and should overlap others. +\ **Note:** The Z index does **not** affect the order in which **CanvasItem** nodes are processed or the way input events are handled. This is especially important to keep in mind for :ref:`Control` nodes. .. rst-class:: classref-section-separator @@ -1260,7 +1270,9 @@ Draws a textured rectangle from a texture's region (specified by ``src_rect``) a |void| **force_update_transform**\ (\ ) :ref:`🔗` -Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. +Forces the node's transform to update. Fails if the node is not inside the tree. See also :ref:`get_transform()`. + +\ **Note:** For performance reasons, transform changes are usually accumulated and applied *once* at the end of the frame. The update propagates through **CanvasItem** children, as well. Therefore, use this method only when you need an up-to-date transform (such as during physics operations). .. rst-class:: classref-item-separator @@ -1272,7 +1284,7 @@ Forces the transform to update. Transform changes in physics are not instant for :ref:`RID` **get_canvas**\ (\ ) |const| :ref:`🔗` -Returns the :ref:`RID` of the :ref:`World2D` canvas where this item is in. +Returns the :ref:`RID` of the :ref:`World2D` canvas where this node is registered to, used by the :ref:`RenderingServer`. .. rst-class:: classref-item-separator @@ -1284,7 +1296,7 @@ Returns the :ref:`RID` of the :ref:`World2D` canvas wh :ref:`RID` **get_canvas_item**\ (\ ) |const| :ref:`🔗` -Returns the canvas item RID used by :ref:`RenderingServer` for this item. +Returns the internal canvas item :ref:`RID` used by the :ref:`RenderingServer` for this node. .. rst-class:: classref-item-separator @@ -1308,7 +1320,7 @@ Returns the :ref:`CanvasLayer` that contains this node, or `` :ref:`Transform2D` **get_canvas_transform**\ (\ ) |const| :ref:`🔗` -Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport`\ s coordinate system. +Returns the transform of this node, converted from its registered canvas's coordinate system to its viewport's coordinate system. See also :ref:`Node.get_viewport()`. .. rst-class:: classref-item-separator @@ -1320,7 +1332,7 @@ Returns the transform from the coordinate system of the canvas, this item is in, :ref:`Vector2` **get_global_mouse_position**\ (\ ) |const| :ref:`🔗` -Returns the mouse's position in the :ref:`CanvasLayer` that this **CanvasItem** is in using the coordinate system of the :ref:`CanvasLayer`. +Returns mouse cursor's global position relative to the :ref:`CanvasLayer` that contains this node. \ **Note:** For screen-space coordinates (e.g. when using a non-embedded :ref:`Popup`), you can use :ref:`DisplayServer.mouse_get_position()`. @@ -1396,7 +1408,7 @@ Equals to :ref:`get_global_transform()` **get_transform**\ (\ ) |const| :ref:`🔗` -Returns the transform matrix of this item. +Returns the transform matrix of this **CanvasItem**. .. rst-class:: classref-item-separator @@ -1408,7 +1420,7 @@ Returns the transform matrix of this item. :ref:`Rect2` **get_viewport_rect**\ (\ ) |const| :ref:`🔗` -Returns the viewport's boundaries as a :ref:`Rect2`. +Returns this node's viewport boundaries as a :ref:`Rect2`. See also :ref:`Node.get_viewport()`. .. rst-class:: classref-item-separator @@ -1420,7 +1432,7 @@ Returns the viewport's boundaries as a :ref:`Rect2`. :ref:`Transform2D` **get_viewport_transform**\ (\ ) |const| :ref:`🔗` -Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport`\ s embedders coordinate system. +Returns the transform of this node, converted from its registered canvas's coordinate system to its viewport embedder's coordinate system. See also :ref:`Viewport.get_final_transform()` and :ref:`Node.get_viewport()`. .. rst-class:: classref-item-separator @@ -1432,7 +1444,7 @@ Returns the transform from the coordinate system of the canvas, this item is in, :ref:`bool` **get_visibility_layer_bit**\ (\ layer\: :ref:`int`\ ) |const| :ref:`🔗` -Returns an individual bit on the rendering visibility layer. +Returns ``true`` if the layer at the given index is set in :ref:`visibility_layer`. .. rst-class:: classref-item-separator @@ -1444,7 +1456,9 @@ Returns an individual bit on the rendering visibility layer. :ref:`World2D` **get_world_2d**\ (\ ) |const| :ref:`🔗` -Returns the :ref:`World2D` where this item is in. +Returns the :ref:`World2D` this node is registered to. + +Usually, this is the same as this node's viewport (see :ref:`Node.get_viewport()` and :ref:`Viewport.find_world_2d()`). .. rst-class:: classref-item-separator @@ -1468,7 +1482,7 @@ Hide the **CanvasItem** if it's currently visible. This is equivalent to setting :ref:`bool` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if local transform notifications are communicated to children. +Returns ``true`` if the node receives :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` whenever its local transform changes. This is enabled with :ref:`set_notify_local_transform()`. .. rst-class:: classref-item-separator @@ -1480,7 +1494,7 @@ Returns ``true`` if local transform notifications are communicated to children. :ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if global transform notifications are communicated to children. +Returns ``true`` if the node receives :ref:`NOTIFICATION_TRANSFORM_CHANGED` whenever its global transform changes. This is enabled with :ref:`set_notify_transform()`. .. rst-class:: classref-item-separator @@ -1526,7 +1540,7 @@ For the opposite operation, use :ref:`get_global_transform_with_canvas()` **make_input_local**\ (\ event\: :ref:`InputEvent`\ ) |const| :ref:`🔗` -Transformations issued by ``event``'s inputs are applied in local space instead of global space. +Returns a copy of the given ``event`` with its coordinates converted from global space to this **CanvasItem**'s local space. If not possible, returns the same :ref:`InputEvent` unchanged. .. rst-class:: classref-item-separator @@ -1538,9 +1552,7 @@ Transformations issued by ``event``'s inputs are applied in local space instead |void| **move_to_front**\ (\ ) :ref:`🔗` -Moves this node to display on top of its siblings. - -Internally, the node is moved to the bottom of parent's child list. The method has no effect on nodes without a parent. +Moves this node below its siblings, usually causing the node to draw on top of its siblings. Does nothing if this node does not have a parent. See also :ref:`Node.move_child()`. .. rst-class:: classref-item-separator @@ -1580,7 +1592,9 @@ Set the value of a shader uniform for this instance only (`per-instance uniform |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` when its local transform changes. +If ``true``, the node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` whenever its local transform changes. + +\ **Note:** Many canvas items such as :ref:`Bone2D` or :ref:`CollisionShape2D` automatically enable this in order to function correctly. .. rst-class:: classref-item-separator @@ -1592,7 +1606,9 @@ If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANS |void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` when its global transform changes. +If ``true``, the node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` whenever global transform changes. + +\ **Note:** Many canvas items such as :ref:`Camera2D` or :ref:`Light2D` automatically enable this in order to function correctly. .. rst-class:: classref-item-separator @@ -1616,7 +1632,9 @@ Set/clear individual bits on the rendering visibility layer. This simplifies edi |void| **show**\ (\ ) :ref:`🔗` -Show the **CanvasItem** if it's currently hidden. This is equivalent to setting :ref:`visible` to ``true``. For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. +Show the **CanvasItem** if it's currently hidden. This is equivalent to setting :ref:`visible` to ``true``. + +\ **Note:** For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 5b40f4504a8..00a7ee70d7d 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -27,7 +27,7 @@ Description \ **Note:** Embedded :ref:`Window`\ s are placed on layer ``1024``. :ref:`CanvasItem`\ s on layers ``1025`` and higher appear in front of embedded windows. -\ **Note:** Each **CanvasLayer** is drawn on one specific :ref:`Viewport` and cannot be shared between multiple :ref:`Viewport`\ s, see :ref:`custom_viewport`. When using multiple :ref:`Viewport`\ s, for example in a split-screen game, you need create an individual **CanvasLayer** for each :ref:`Viewport` you want it to be drawn on. +\ **Note:** Each **CanvasLayer** is drawn on one specific :ref:`Viewport` and cannot be shared between multiple :ref:`Viewport`\ s, see :ref:`custom_viewport`. When using multiple :ref:`Viewport`\ s, for example in a split-screen game, you need to create an individual **CanvasLayer** for each :ref:`Viewport` you want it to be drawn on. .. rst-class:: classref-introduction-group diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index f6466d0d729..a2a3119f2cf 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -298,7 +298,7 @@ If ``false``, the body will slide on floor's slopes when :ref:`velocity`\ ) - :ref:`int` **get_max_slides**\ (\ ) -Maximum number of times the body can change direction before it stops when calling :ref:`move_and_slide()`. +Maximum number of times the body can change direction before it stops when calling :ref:`move_and_slide()`. Must be greater than zero. .. rst-class:: classref-item-separator @@ -457,7 +457,7 @@ Current velocity vector in pixels per second, used and modified during calls to - |void| **set_wall_min_slide_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_wall_min_slide_angle**\ (\ ) -Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. This property only affects movement when :ref:`motion_mode` is :ref:`MOTION_MODE_FLOATING`. +Minimum angle (in radians) where the body is allowed to slide when it encounters a wall. The default value equals 15 degrees. This property only affects movement when :ref:`motion_mode` is :ref:`MOTION_MODE_FLOATING`. .. rst-class:: classref-section-separator diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index fe884d888d7..38d91856da0 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -302,7 +302,7 @@ If ``false``, the body will slide on floor's slopes when :ref:`velocity`\ ) - :ref:`int` **get_max_slides**\ (\ ) -Maximum number of times the body can change direction before it stops when calling :ref:`move_and_slide()`. +Maximum number of times the body can change direction before it stops when calling :ref:`move_and_slide()`. Must be greater than zero. .. rst-class:: classref-item-separator @@ -461,7 +461,7 @@ Current velocity vector (typically meters per second), used and modified during - |void| **set_wall_min_slide_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_wall_min_slide_angle**\ (\ ) -Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. When :ref:`motion_mode` is :ref:`MOTION_MODE_GROUNDED`, it only affects movement if :ref:`floor_block_on_wall` is ``true``. +Minimum angle (in radians) where the body is allowed to slide when it encounters a wall. The default value equals 15 degrees. When :ref:`motion_mode` is :ref:`MOTION_MODE_GROUNDED`, it only affects movement if :ref:`floor_block_on_wall` is ``true``. .. rst-class:: classref-section-separator diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 3bae89dfefa..e274cd54c4d 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -47,25 +47,29 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`check_v_offset` | ``0`` | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_checked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_unchecked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled` | | - +-----------------------------------+-------------------------------------------------------------------------------------+-------+ + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`checkbox_checked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`checkbox_unchecked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`check_v_offset` | ``0`` | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_checked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_checked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_unchecked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`radio_unchecked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled` | | + +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -76,6 +80,30 @@ Theme Properties Theme Property Descriptions --------------------------- +.. _class_CheckBox_theme_color_checkbox_checked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **checkbox_checked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +The color of the checked icon when the checkbox is pressed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CheckBox_theme_color_checkbox_unchecked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **checkbox_unchecked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +The color of the unchecked icon when the checkbox is not pressed. + +.. rst-class:: classref-item-separator + +---- + .. _class_CheckBox_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 2da645a505b..2d1de710d0f 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -45,25 +45,29 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`check_v_offset` | ``0`` | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`checked_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ - | :ref:`Texture2D` | :ref:`unchecked_mirrored` | | - +-----------------------------------+----------------------------------------------------------------------------------------------+-------+ + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`button_checked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`button_unchecked_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`check_v_offset` | ``0`` | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_disabled` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`checked_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`Texture2D` | :ref:`unchecked_mirrored` | | + +-----------------------------------+----------------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -74,6 +78,30 @@ Theme Properties Theme Property Descriptions --------------------------- +.. _class_CheckButton_theme_color_button_checked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **button_checked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +The color of the checked icon when the checkbox is pressed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_CheckButton_theme_color_button_unchecked_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **button_unchecked_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +The color of the unchecked icon when the checkbox is not pressed. + +.. rst-class:: classref-item-separator + +---- + .. _class_CheckButton_theme_constant_check_v_offset: .. rst-class:: classref-themeproperty diff --git a/classes/class_codeedit.rst b/classes/class_codeedit.rst index 16206bd74db..a60ff6d88df 100644 --- a/classes/class_codeedit.rst +++ b/classes/class_codeedit.rst @@ -310,7 +310,7 @@ Signals **breakpoint_toggled**\ (\ line\: :ref:`int`\ ) :ref:`🔗` -Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. +Emitted when a breakpoint is added or removed from a line. If the line is removed via backspace, a signal is emitted at the old line. .. rst-class:: classref-item-separator @@ -827,7 +827,7 @@ If ``true``, lines can be folded. Otherwise, line folding methods like :ref:`fol - |void| **set_line_length_guidelines**\ (\ value\: :ref:`Array`\[:ref:`int`\]\ ) - :ref:`Array`\[:ref:`int`\] **get_line_length_guidelines**\ (\ ) -Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently. +Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is drawn more prominently. .. rst-class:: classref-item-separator @@ -861,7 +861,7 @@ Set when a validated word from :ref:`symbol_validate`\ ) - :ref:`bool` **is_symbol_tooltip_on_hover_enabled**\ (\ ) -Set when a word is hovered, the :ref:`symbol_hovered` should be emitted. +If ``true``, the :ref:`symbol_hovered` signal is emitted when hovering over a word. .. rst-class:: classref-section-separator diff --git a/classes/class_color.rst b/classes/class_color.rst index 18deb2abd0f..0e79902e4c2 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -21,6 +21,8 @@ A color represented in RGBA format by a red (:ref:`r`), Colors can be created in various 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. +Color data may be stored in many color spaces and encodings. The :ref:`srgb_to_linear()` and :ref:`linear_to_srgb()` methods can convert between nonlinear sRGB encoding and linear RGB encoding. + \ **Note:** In a boolean context, a Color will evaluate to ``false`` if it is equal to ``Color(0, 0, 0, 1)`` (opaque black). Otherwise, a Color will always evaluate to ``true``. \ `Color constants cheatsheet `__ @@ -1394,6 +1396,8 @@ Property Descriptions The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque. +\ **Note:** The alpha channel is always stored with linear encoding, regardless of the color space of the other color channels. The :ref:`linear_to_srgb()` and :ref:`srgb_to_linear()` methods do not affect the alpha channel. + .. rst-class:: classref-item-separator ---- @@ -2081,6 +2085,8 @@ Returns a new color resulting from making this color lighter by the specified `` Returns the color converted to the `sRGB `__ color space. This method assumes the original color is in the linear color space. 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 color space of the other color channels. + .. rst-class:: classref-item-separator ---- @@ -2093,6 +2099,8 @@ Returns the color converted to the `sRGB `__ Returns the color converted to the linear color space. This method assumes the original color already is in the sRGB color space. 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 color space of the other color channels. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 632d9e11c41..d88db9cb468 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -92,49 +92,57 @@ Theme Properties .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`center_slider_grabbers` | ``1`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`h_width` | ``30`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`label_width` | ``10`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`margin` | ``4`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`sv_height` | ``256`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`int` | :ref:`sv_width` | ``256`` | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`add_preset` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`bar_arrow` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`color_hue` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`expanded_arrow` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`folded_arrow` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`menu_option` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`overbright_indicator` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`picker_cursor` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`picker_cursor_bg` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`sample_bg` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`sample_revert` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`screen_picker` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_circle` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_rect` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ - | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | - +-----------------------------------+----------------------------------------------------------------------------------------+---------+ + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Color` | :ref:`focused_not_editing_cursor_color` | ``Color(1, 1, 1, 0.275)`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`center_slider_grabbers` | ``1`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`h_width` | ``30`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`label_width` | ``10`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`margin` | ``4`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`sv_height` | ``256`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`int` | :ref:`sv_width` | ``256`` | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`add_preset` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`bar_arrow` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`color_hue` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`expanded_arrow` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`folded_arrow` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`menu_option` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`overbright_indicator` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`picker_cursor` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`picker_cursor_bg` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`sample_bg` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`sample_revert` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`screen_picker` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`shape_circle` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`shape_rect` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`Texture2D` | :ref:`shape_rect_wheel` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`StyleBox` | :ref:`picker_focus_circle` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`StyleBox` | :ref:`picker_focus_rectangle` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ + | :ref:`StyleBox` | :ref:`sample_focus` | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------+ .. rst-class:: classref-section-separator @@ -560,6 +568,18 @@ Returns the list of colors in the recent presets of the color picker. Theme Property Descriptions --------------------------- +.. _class_ColorPicker_theme_color_focused_not_editing_cursor_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **focused_not_editing_cursor_color** = ``Color(1, 1, 1, 0.275)`` :ref:`🔗` + +Color of rectangle or circle drawn when a picker shape part is focused but not editable via keyboard or joypad. Displayed *over* the picker shape, so a partially transparent color should be used to ensure the picker shape remains visible. + +.. rst-class:: classref-item-separator + +---- + .. _class_ColorPicker_theme_constant_center_slider_grabbers: .. rst-class:: classref-themeproperty @@ -808,6 +828,42 @@ The icon for rectangular picker shapes. The icon for rectangular wheel picker shapes. +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPicker_theme_style_picker_focus_circle: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **picker_focus_circle** :ref:`🔗` + +The :ref:`StyleBox` used when the circle-shaped part of the picker is focused. Displayed *over* the picker shape, so a partially transparent :ref:`StyleBox` should be used to ensure the picker shape remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPicker_theme_style_picker_focus_rectangle: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **picker_focus_rectangle** :ref:`🔗` + +The :ref:`StyleBox` used when the rectangle-shaped part of the picker is focused. Displayed *over* the picker shape, so a partially transparent :ref:`StyleBox` should be used to ensure the picker shape remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ColorPicker_theme_style_sample_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **sample_focus** :ref:`🔗` + +The :ref:`StyleBox` used for the old color sample part when it is focused. Displayed *over* the sample, so a partially transparent :ref:`StyleBox` should be used to ensure the picker shape remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_container.rst b/classes/class_container.rst index fedccd93698..0453c728297 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -12,7 +12,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AspectRatioContainer`, :ref:`BoxContainer`, :ref:`CenterContainer`, :ref:`EditorProperty`, :ref:`FlowContainer`, :ref:`GraphElement`, :ref:`GridContainer`, :ref:`MarginContainer`, :ref:`PanelContainer`, :ref:`ScrollContainer`, :ref:`SplitContainer`, :ref:`SubViewportContainer`, :ref:`TabContainer` +**Inherited By:** :ref:`AspectRatioContainer`, :ref:`BoxContainer`, :ref:`CenterContainer`, :ref:`EditorProperty`, :ref:`FlowContainer`, :ref:`FoldableContainer`, :ref:`GraphElement`, :ref:`GridContainer`, :ref:`MarginContainer`, :ref:`PanelContainer`, :ref:`ScrollContainer`, :ref:`SplitContainer`, :ref:`SubViewportContainer`, :ref:`TabContainer` Base class for all GUI containers. diff --git a/classes/class_control.rst b/classes/class_control.rst index 8ea934ec26d..eb5d2f25bf0 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -95,6 +95,8 @@ Properties +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`RecursiveBehavior` | :ref:`focus_recursive_behavior` | ``0`` | + +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`global_position` | | +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | @@ -111,6 +113,8 @@ Properties +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`mouse_force_pass_scroll_events` | ``true`` | +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`RecursiveBehavior` | :ref:`mouse_recursive_behavior` | ``0`` | + +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`offset_bottom` | ``0.0`` | +---------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`float` | :ref:`offset_left` | ``0.0`` | @@ -158,6 +162,8 @@ Methods .. table:: :widths: auto + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_accessibility_get_contextual_info`\ (\ ) |virtual| |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_can_drop_data`\ (\ at_position\: :ref:`Vector2`, data\: :ref:`Variant`\ ) |virtual| |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -179,6 +185,10 @@ Methods +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`accept_event`\ (\ ) | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_drag`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_drop`\ (\ ) | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_theme_color_override`\ (\ name\: :ref:`StringName`, color\: :ref:`Color`\ ) | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_theme_constant_override`\ (\ name\: :ref:`StringName`, constant\: :ref:`int`\ ) | @@ -213,12 +223,16 @@ Methods +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_end`\ (\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FocusMode` | :ref:`get_focus_mode_with_recursive`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_focus_neighbor`\ (\ side\: :ref:`Side`\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_global_rect`\ (\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_minimum_size`\ (\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MouseFilter` | :ref:`get_mouse_filter_with_recursive`\ (\ ) |const| | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_offset`\ (\ offset\: :ref:`Side`\ ) |const| | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_parent_area_size`\ (\ ) |const| | @@ -496,6 +510,48 @@ The node can only grab focus on mouse clicks. Use with :ref:`focus_mode`. +.. _class_Control_constant_FOCUS_ACCESSIBILITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`FocusMode` **FOCUS_ACCESSIBILITY** = ``3`` + +The node can grab focus only when screen reader is active. Use with :ref:`focus_mode`. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_Control_RecursiveBehavior: + +.. rst-class:: classref-enumeration + +enum **RecursiveBehavior**: :ref:`🔗` + +.. _class_Control_constant_RECURSIVE_BEHAVIOR_INHERITED: + +.. rst-class:: classref-enumeration-constant + +:ref:`RecursiveBehavior` **RECURSIVE_BEHAVIOR_INHERITED** = ``0`` + +Inherits the associated behavior from the control's parent. This is the default for any newly created control. + +.. _class_Control_constant_RECURSIVE_BEHAVIOR_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`RecursiveBehavior` **RECURSIVE_BEHAVIOR_DISABLED** = ``1`` + +The current control and all its recursive child controls have their associated behavior disabled, regardless of the parent control's configuration. + +.. _class_Control_constant_RECURSIVE_BEHAVIOR_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`RecursiveBehavior` **RECURSIVE_BEHAVIOR_ENABLED** = ``2`` + +The current control and all its recursive child controls have their associated behavior enabled, regardless of the parent control's configuration. + .. rst-class:: classref-item-separator ---- @@ -1480,6 +1536,23 @@ If this property is not set, Godot will select a "best guess" based on surroundi ---- +.. _class_Control_property_focus_recursive_behavior: + +.. rst-class:: classref-property + +:ref:`RecursiveBehavior` **focus_recursive_behavior** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_focus_recursive_behavior**\ (\ value\: :ref:`RecursiveBehavior`\ ) +- :ref:`RecursiveBehavior` **get_focus_recursive_behavior**\ (\ ) + +Controls whether the recursive child nodes should have their :ref:`focus_mode` overridden to :ref:`FOCUS_NONE` when evaluating input. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_property_global_position: .. rst-class:: classref-property @@ -1623,6 +1696,23 @@ You should disable it on the root of your UI if you do not want scroll events to ---- +.. _class_Control_property_mouse_recursive_behavior: + +.. rst-class:: classref-property + +:ref:`RecursiveBehavior` **mouse_recursive_behavior** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mouse_recursive_behavior**\ (\ value\: :ref:`RecursiveBehavior`\ ) +- :ref:`RecursiveBehavior` **get_mouse_recursive_behavior**\ (\ ) + +Controls whether the recursive child nodes should have their :ref:`mouse_filter` overridden to :ref:`MOUSE_FILTER_IGNORE` when evaluating input. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_property_offset_bottom: .. rst-class:: classref-property @@ -1985,6 +2075,18 @@ The tooltip popup will use either a default implementation, or a custom one that Method Descriptions ------------------- +.. _class_Control_private_method__accessibility_get_contextual_info: + +.. rst-class:: classref-method + +:ref:`String` **_accessibility_get_contextual_info**\ (\ ) |virtual| |const| :ref:`🔗` + +Return the description of the keyboard shortcuts and other contextual help for this control. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_private_method__can_drop_data: .. rst-class:: classref-method @@ -1995,6 +2097,8 @@ Godot calls this method to test if ``data`` from a control's :ref:`_get_drag_dat This method should only be used to test the data. Process the data in :ref:`_drop_data()`. +\ **Note:** If drag was initiated by keyboard shortcut or :ref:`accessibility_drag()`, ``at_position`` is set to ``Vector2(INFINITY, INFINITY)`` and the currently selected item/text position should be used as drop position. + .. tabs:: @@ -2028,6 +2132,8 @@ This method should only be used to test the data. Process the data in :ref:`_dro Godot calls this method to pass you the ``data`` from a control's :ref:`_get_drag_data()` result. Godot first calls :ref:`_can_drop_data()` to test if ``data`` is allowed to drop at ``at_position`` where ``at_position`` is local to this control. +\ **Note:** If drag was initiated by keyboard shortcut or :ref:`accessibility_drag()`, ``at_position`` is set to ``Vector2(INFINITY, INFINITY)`` and the currently selected item/text position should be used as drop position. + .. tabs:: @@ -2067,6 +2173,8 @@ Godot calls this method to get data that can be dragged and dropped onto control A preview that will follow the mouse that should represent the data can be set with :ref:`set_drag_preview()`. A good time to set the preview is in this method. +\ **Note:** If drag was initiated by keyboard shortcut or :ref:`accessibility_drag()`, ``at_position`` is set to ``Vector2(INFINITY, INFINITY)`` and the currently selected item/text position should be used as drop position. + .. tabs:: @@ -2287,6 +2395,30 @@ Marks an input event as handled. Once you accept an input event, it stops propag ---- +.. _class_Control_method_accessibility_drag: + +.. rst-class:: classref-method + +|void| **accessibility_drag**\ (\ ) :ref:`🔗` + +Starts drag-and-drop operation without using a mouse. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Control_method_accessibility_drop: + +.. rst-class:: classref-method + +|void| **accessibility_drop**\ (\ ) :ref:`🔗` + +Ends drag-and-drop operation without using a mouse. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_add_theme_color_override: .. rst-class:: classref-method @@ -2563,6 +2695,18 @@ Returns :ref:`offset_right` and :ref:`offse ---- +.. _class_Control_method_get_focus_mode_with_recursive: + +.. rst-class:: classref-method + +:ref:`FocusMode` **get_focus_mode_with_recursive**\ (\ ) |const| :ref:`🔗` + +Similar to the getter of :ref:`focus_mode`, but takes parent's :ref:`focus_recursive_behavior` into account. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_get_focus_neighbor: .. rst-class:: classref-method @@ -2605,6 +2749,18 @@ Returns the minimum size for this control. See :ref:`custom_minimum_size` **get_mouse_filter_with_recursive**\ (\ ) |const| :ref:`🔗` + +Similar to the getter of :ref:`mouse_filter`, but takes parent's :ref:`mouse_recursive_behavior` into account. + +.. rst-class:: classref-item-separator + +---- + .. _class_Control_method_get_offset: .. rst-class:: classref-method @@ -3087,7 +3243,7 @@ Best used with :ref:`Node.NOTIFICATION_DRAG_END` **is_layout_rtl**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if layout is right-to-left. See also :ref:`layout_direction`. +Returns ``true`` if the layout is right-to-left. See also :ref:`layout_direction`. .. rst-class:: classref-item-separator diff --git a/classes/class_csgshape3d.rst b/classes/class_csgshape3d.rst index 399f7bf0016..6f7e11327ed 100644 --- a/classes/class_csgshape3d.rst +++ b/classes/class_csgshape3d.rst @@ -23,15 +23,13 @@ Description This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot. -\ **Performance:** CSG nodes are only intended for prototyping as they have a significant CPU performance cost. - -Consider baking final CSG operation results into static geometry that replaces the CSG nodes. +\ **Performance:** CSG nodes are only intended for prototyping as they have a significant CPU performance cost. Consider baking final CSG operation results into static geometry that replaces the CSG nodes. Individual CSG root node results can be baked to nodes with static resources with the editor menu that appears when a CSG root node is selected. Individual CSG root nodes can also be baked to static resources with scripts by calling :ref:`bake_static_mesh()` for the visual mesh or :ref:`bake_collision_shape()` for the physics collision. -Entire scenes of CSG nodes can be baked to static geometry and exported with the editor gltf scene exporter. +Entire scenes of CSG nodes can be baked to static geometry and exported with the editor glTF scene exporter: **Scene > Export As... > glTF 2.0 Scene...** .. rst-class:: classref-introduction-group @@ -149,7 +147,7 @@ Property Descriptions - |void| **set_calculate_tangents**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_calculating_tangents**\ (\ ) -Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. +Calculate tangents for the CSG shape which allows the use of normal and height maps. This is only applied on the root shape, this setting is ignored on any child. Setting this to ``false`` can speed up shape generation slightly. .. rst-class:: classref-item-separator @@ -278,6 +276,8 @@ Returns a baked physics :ref:`ConcavePolygonShape3D \ **Performance:** If the CSG operation results in a very detailed geometry with many faces physics performance will be very slow. Concave shapes should in general only be used for static level geometry and not with dynamic objects that are moving. +\ **Note:** CSG mesh data updates are deferred, which means they are updated with a delay of one rendered frame. To avoid getting an empty shape or outdated mesh data, make sure to call ``await get_tree().process_frame`` before using :ref:`bake_collision_shape()` in :ref:`Node._ready()` or after changing properties on the **CSGShape3D**. + .. rst-class:: classref-item-separator ---- @@ -290,6 +290,8 @@ Returns a baked physics :ref:`ConcavePolygonShape3D Returns a baked static :ref:`ArrayMesh` of this node's CSG operation result. Materials from involved CSG nodes are added as extra mesh surfaces. Returns an empty mesh if the node is not a CSG root node or has no valid geometry. +\ **Note:** CSG mesh data updates are deferred, which means they are updated with a delay of one rendered frame. To avoid getting an empty mesh or outdated mesh data, make sure to call ``await get_tree().process_frame`` before using :ref:`bake_static_mesh()` in :ref:`Node._ready()` or after changing properties on the **CSGShape3D**. + .. rst-class:: classref-item-separator ---- @@ -326,6 +328,8 @@ Returns whether or not the specified layer of the :ref:`collision_mask` with two elements, the first is the :ref:`Transform3D` of this node and the second is the root :ref:`Mesh` of this node. Only works when this node is the root shape. +\ **Note:** CSG mesh data updates are deferred, which means they are updated with a delay of one rendered frame. To avoid getting an empty shape or outdated mesh data, make sure to call ``await get_tree().process_frame`` before using :ref:`get_meshes()` in :ref:`Node._ready()` or after changing properties on the **CSGShape3D**. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index cb1f17a6bca..4ba41826845 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -859,7 +859,20 @@ Returns the number of entries in the dictionary. Empty dictionaries (``{ }``) al |void| **sort**\ (\ ) :ref:`🔗` -Sorts the dictionary in-place by key. This can be used to ensure dictionaries with the same contents produce equivalent results when getting the :ref:`keys()`, getting the :ref:`values()`, and converting to a string. This is also useful when wanting a JSON representation consistent with what is in memory, and useful for storing on a database that requires dictionaries to be sorted. +Sorts the dictionary in ascending order, by key. The final order is dependent on the "less than" (``<``) comparison between keys. + + +.. tabs:: + + .. code-tab:: gdscript + + var numbers = { "c": 2, "a": 0, "b": 1 } + numbers.sort() + print(numbers) # Prints { "a": 0, "b": 1, "c": 2 } + + + +This method ensures that the dictionary's entries are ordered consistently when :ref:`keys()` or :ref:`values()` are called, or when the dictionary needs to be converted to a string through :ref:`@GlobalScope.str()` or :ref:`JSON.stringify()`. .. rst-class:: classref-item-separator diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index 1a776401554..ae2dcb8ad21 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -165,6 +165,8 @@ Methods +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_case_sensitive`\ (\ path\: :ref:`String`\ ) |const| | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_equivalent`\ (\ path_a\: :ref:`String`, path_b\: :ref:`String`\ ) |const| | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_link`\ (\ path\: :ref:`String`\ ) | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`list_dir_begin`\ (\ ) | @@ -568,6 +570,18 @@ Returns ``true`` if the file system or directory use case sensitive file names. ---- +.. _class_DirAccess_method_is_equivalent: + +.. rst-class:: classref-method + +:ref:`bool` **is_equivalent**\ (\ path_a\: :ref:`String`, path_b\: :ref:`String`\ ) |const| :ref:`🔗` + +Returns ``true`` if paths ``path_a`` and ``path_b`` resolve to the same file system object. Returns ``false`` otherwise, even if the files are bit-for-bit identical (e.g., identical copies of the file that are not symbolic links). + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_is_link: .. rst-class:: classref-method diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 54857261ee4..773426e80b6 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -31,387 +31,543 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`beep`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`clipboard_get`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`clipboard_get_image`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`clipboard_get_primary`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clipboard_has`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`clipboard_has_image`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clipboard_set`\ (\ clipboard\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clipboard_set_primary`\ (\ clipboard_primary\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`CursorShape` | :ref:`cursor_get_shape`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cursor_set_custom_image`\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`cursor_set_shape`\ (\ shape\: :ref:`CursorShape`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`delete_status_indicator`\ (\ id\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dialog_input_text`\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`dialog_show`\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`enable_for_stealing_focus`\ (\ process_id\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`file_dialog_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`file_dialog_with_options_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`force_process_and_drop_events`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_accent_color`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_base_color`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Rect2`\] | :ref:`get_display_cutouts`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`get_display_safe_area`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_keyboard_focus_screen`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_name`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_primary_screen`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_screen_count`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_screen_from_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_swap_cancel_ok`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_window_at_screen_position`\ (\ position\: :ref:`Vector2i`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedInt32Array` | :ref:`get_window_list`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_icon_radio_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_multistate_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_radio_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_separator`\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_add_submenu_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_clear`\ (\ menu_root\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`global_menu_get_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`global_menu_get_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_count`\ (\ menu_root\: :ref:`String`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`global_menu_get_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_index_from_tag`\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_index_from_text`\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`global_menu_get_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`global_menu_get_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`global_menu_get_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`global_menu_get_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`global_menu_get_system_menu_roots`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`global_menu_is_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_remove_item`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_hover_callbacks`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`global_menu_set_popup_callbacks`\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_additional_outputs`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_hardware_keyboard`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`help_set_search_callbacks`\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`ime_get_selection`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`ime_get_text`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dark_mode`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_dark_mode_supported`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_window_transparency_available`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`keyboard_get_label_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`keyboard_get_layout_count`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`keyboard_get_layout_language`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`keyboard_get_layout_name`\ (\ index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`keyboard_set_current_layout`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`mouse_get_button_state`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`MouseMode` | :ref:`mouse_get_mode`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`mouse_get_position`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`mouse_set_mode`\ (\ mouse_mode\: :ref:`MouseMode`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`process_events`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_additional_output`\ (\ object\: :ref:`Object`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`screen_get_dpi`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`screen_get_image`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image` | :ref:`screen_get_image_rect`\ (\ rect\: :ref:`Rect2i`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_max_scale`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`ScreenOrientation` | :ref:`screen_get_orientation`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`screen_get_pixel`\ (\ position\: :ref:`Vector2i`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`screen_get_position`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_refresh_rate`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`screen_get_scale`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`screen_get_size`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`screen_get_usable_rect`\ (\ screen\: :ref:`int` = -1\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`screen_is_kept_on`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`screen_set_keep_on`\ (\ enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`screen_set_orientation`\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon`\ (\ image\: :ref:`Image`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_native_icon`\ (\ filename\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`show_emoji_and_symbol_picker`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`status_indicator_get_rect`\ (\ id\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_menu`\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`status_indicator_set_tooltip`\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tablet_get_current_driver`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`tablet_get_driver_count`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`tablet_get_driver_name`\ (\ idx\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tablet_set_current_driver`\ (\ name\: :ref:`String`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`tts_get_voices`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language`\ (\ language\: :ref:`String`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`tts_is_paused`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`tts_is_speaking`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_pause`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_resume`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_set_utterance_callback`\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_speak`\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tts_stop`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_additional_output`\ (\ object\: :ref:`Object`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`virtual_keyboard_get_height`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`virtual_keyboard_hide`\ (\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`virtual_keyboard_show`\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2i`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_can_draw`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_active_popup`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_attached_instance_id`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_current_screen`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_get_flag`\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_max_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_min_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`WindowMode` | :ref:`window_get_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`window_get_native_handle`\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2i` | :ref:`window_get_popup_safe_rect`\ (\ window\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_position`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_position_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector3i` | :ref:`window_get_safe_title_margins`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_size_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`window_get_title_size`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`VSyncMode` | :ref:`window_get_vsync_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_is_focused`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_is_maximize_allowed`\ (\ window_id\: :ref:`int` = 0\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_maximize_on_title_dbl_click`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`window_minimize_on_title_dbl_click`\ (\ ) |const| | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_move_to_foreground`\ (\ window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_request_attention`\ (\ window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_current_screen`\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_drop_files_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_exclusive`\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_flag`\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_ime_active`\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_ime_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_input_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_input_text_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_max_size`\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_min_size`\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_mode`\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_mouse_passthrough`\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_popup_safe_rect`\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_rect_changed_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_size`\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_title`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_transient`\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_vsync_mode`\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_window_buttons_offset`\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_set_window_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_start_drag`\ (\ window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`window_start_resize`\ (\ edge\: :ref:`WindowResizeEdge`, window_id\: :ref:`int` = 0\ ) | - +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`accessibility_create_element`\ (\ window_id\: :ref:`int`, role\: :ref:`AccessibilityRole`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :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:`Variant` | :ref:`accessibility_element_get_meta`\ (\ id\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_element_set_meta`\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_free_element`\ (\ id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`accessibility_get_window_root`\ (\ window_id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`accessibility_has_element`\ (\ id\: :ref:`RID`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_screen_reader_active`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_set_window_focused`\ (\ window_id\: :ref:`int`, focused\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_set_window_rect`\ (\ window_id\: :ref:`int`, rect_out\: :ref:`Rect2`, rect_in\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_should_increase_contrast`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_should_reduce_animation`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility_should_reduce_transparency`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_action`\ (\ id\: :ref:`RID`, action\: :ref:`AccessibilityAction`, callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_child`\ (\ id\: :ref:`RID`, child_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_custom_action`\ (\ id\: :ref:`RID`, action_id\: :ref:`int`, action_description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_controls`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_described_by`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_details`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_flow_to`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_labeled_by`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_add_related_radio_group`\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_active_descendant`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_background_color`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_bounds`\ (\ id\: :ref:`RID`, p_rect\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_checked`\ (\ id\: :ref:`RID`, checekd\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_classname`\ (\ id\: :ref:`RID`, classname\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_color_value`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_error_message`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_extra_info`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_flag`\ (\ id\: :ref:`RID`, flag\: :ref:`AccessibilityFlags`, value\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_focus`\ (\ id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_foreground_color`\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_in_page_link_target`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_language`\ (\ id\: :ref:`RID`, language\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_count`\ (\ id\: :ref:`RID`, size\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_expanded`\ (\ id\: :ref:`RID`, expanded\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_level`\ (\ id\: :ref:`RID`, level\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_item_selected`\ (\ id\: :ref:`RID`, selected\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_list_orientation`\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_live`\ (\ id\: :ref:`RID`, live\: :ref:`AccessibilityLiveMode`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_member_of`\ (\ id\: :ref:`RID`, group_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_name`\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_next_on_line`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_jump`\ (\ id\: :ref:`RID`, jump\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_step`\ (\ id\: :ref:`RID`, step\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_num_value`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_placeholder`\ (\ id\: :ref:`RID`, placeholder\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_popup_type`\ (\ id\: :ref:`RID`, popup\: :ref:`AccessibilityPopupType`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_previous_on_line`\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_role`\ (\ id\: :ref:`RID`, role\: :ref:`AccessibilityRole`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_role_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_x`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_x_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_y`\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_scroll_y_range`\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_shortcut`\ (\ id\: :ref:`RID`, shortcut\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_state_description`\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_cell_position`\ (\ id\: :ref:`RID`, row_index\: :ref:`int`, column_index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_cell_span`\ (\ id\: :ref:`RID`, row_span\: :ref:`int`, column_span\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_column_count`\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_column_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_row_count`\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_table_row_index`\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_align`\ (\ id\: :ref:`RID`, align\: :ref:`HorizontalAlignment`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_decorations`\ (\ id\: :ref:`RID`, underline\: :ref:`bool`, strikethrough\: :ref:`bool`, overline\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_orientation`\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_text_selection`\ (\ id\: :ref:`RID`, text_start_id\: :ref:`RID`, start_char\: :ref:`int`, text_end_id\: :ref:`RID`, end_char\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_tooltip`\ (\ id\: :ref:`RID`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_transform`\ (\ id\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_url`\ (\ id\: :ref:`RID`, url\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`accessibility_update_set_value`\ (\ id\: :ref:`RID`, value\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`beep`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`clipboard_get`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`clipboard_get_image`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`clipboard_get_primary`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clipboard_has`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`clipboard_has_image`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clipboard_set`\ (\ clipboard\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clipboard_set_primary`\ (\ clipboard_primary\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`color_picker`\ (\ callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_status_indicator`\ (\ icon\: :ref:`Texture2D`, tooltip\: :ref:`String`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`CursorShape` | :ref:`cursor_get_shape`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cursor_set_custom_image`\ (\ cursor\: :ref:`Resource`, shape\: :ref:`CursorShape` = 0, hotspot\: :ref:`Vector2` = Vector2(0, 0)\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cursor_set_shape`\ (\ shape\: :ref:`CursorShape`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`delete_status_indicator`\ (\ id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dialog_input_text`\ (\ title\: :ref:`String`, description\: :ref:`String`, existing_text\: :ref:`String`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`dialog_show`\ (\ title\: :ref:`String`, description\: :ref:`String`, buttons\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`enable_for_stealing_focus`\ (\ process_id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`file_dialog_with_options_show`\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`force_process_and_drop_events`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_accent_color`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_base_color`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Rect2`\] | :ref:`get_display_cutouts`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`get_display_safe_area`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_keyboard_focus_screen`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_name`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_primary_screen`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_screen_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_screen_from_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_swap_cancel_ok`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_window_at_screen_position`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`get_window_list`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_icon_radio_check_item`\ (\ menu_root\: :ref:`String`, icon\: :ref:`Texture2D`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_multistate_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_radio_check_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, callback\: :ref:`Callable` = Callable(), key_callback\: :ref:`Callable` = Callable(), tag\: :ref:`Variant` = null, accelerator\: :ref:`Key` = 0, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_separator`\ (\ menu_root\: :ref:`String`, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_add_submenu_item`\ (\ menu_root\: :ref:`String`, label\: :ref:`String`, submenu\: :ref:`String`, index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_clear`\ (\ menu_root\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`global_menu_get_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`global_menu_get_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_count`\ (\ menu_root\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`global_menu_get_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_index_from_tag`\ (\ menu_root\: :ref:`String`, tag\: :ref:`Variant`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_index_from_text`\ (\ menu_root\: :ref:`String`, text\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`global_menu_get_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`global_menu_get_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`global_menu_get_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`global_menu_get_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`global_menu_get_system_menu_roots`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`global_menu_is_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_remove_item`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_accelerator`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, keycode\: :ref:`Key`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_checked`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_disabled`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_hidden`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, hidden\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_hover_callbacks`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_icon`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_indentation_level`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, level\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_key_callback`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, key_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_max_states`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, max_states\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_radio_checkable`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, checkable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_state`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, state\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_submenu`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, submenu\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_tag`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tag\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_text`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_item_tooltip`\ (\ menu_root\: :ref:`String`, idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`global_menu_set_popup_callbacks`\ (\ menu_root\: :ref:`String`, open_callback\: :ref:`Callable`, close_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_additional_outputs`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Feature`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_hardware_keyboard`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`help_set_search_callbacks`\ (\ search_callback\: :ref:`Callable`, action_callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`ime_get_selection`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`ime_get_text`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dark_mode`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_dark_mode_supported`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_touchscreen_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_window_transparency_available`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`keyboard_get_current_layout`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_keycode_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`keyboard_get_label_from_physical`\ (\ keycode\: :ref:`Key`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`keyboard_get_layout_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keyboard_get_layout_language`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`keyboard_get_layout_name`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`keyboard_set_current_layout`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`MouseButtonMask`\] | :ref:`mouse_get_button_state`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`MouseMode` | :ref:`mouse_get_mode`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`mouse_get_position`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`mouse_set_mode`\ (\ mouse_mode\: :ref:`MouseMode`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`process_events`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_additional_output`\ (\ object\: :ref:`Object`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`screen_get_dpi`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`screen_get_image`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Image` | :ref:`screen_get_image_rect`\ (\ rect\: :ref:`Rect2i`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_max_scale`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`ScreenOrientation` | :ref:`screen_get_orientation`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`screen_get_pixel`\ (\ position\: :ref:`Vector2i`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`screen_get_position`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_refresh_rate`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`screen_get_scale`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`screen_get_size`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`screen_get_usable_rect`\ (\ screen\: :ref:`int` = -1\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`screen_is_kept_on`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_set_keep_on`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`screen_set_orientation`\ (\ orientation\: :ref:`ScreenOrientation`, screen\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_hardware_keyboard_connection_change_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ image\: :ref:`Image`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_native_icon`\ (\ filename\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_system_theme_change_callback`\ (\ callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_emoji_and_symbol_picker`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`status_indicator_get_rect`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_callback`\ (\ id\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_icon`\ (\ id\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_menu`\ (\ id\: :ref:`int`, menu_rid\: :ref:`RID`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`status_indicator_set_tooltip`\ (\ id\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tablet_get_current_driver`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`tablet_get_driver_count`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`tablet_get_driver_name`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tablet_set_current_driver`\ (\ name\: :ref:`String`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`tts_get_voices`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language`\ (\ language\: :ref:`String`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tts_is_paused`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tts_is_speaking`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_pause`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_resume`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_set_utterance_callback`\ (\ event\: :ref:`TTSUtteranceEvent`, callable\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_speak`\ (\ text\: :ref:`String`, voice\: :ref:`String`, volume\: :ref:`int` = 50, pitch\: :ref:`float` = 1.0, rate\: :ref:`float` = 1.0, utterance_id\: :ref:`int` = 0, interrupt\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tts_stop`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_additional_output`\ (\ object\: :ref:`Object`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`virtual_keyboard_get_height`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`virtual_keyboard_hide`\ (\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`virtual_keyboard_show`\ (\ existing_text\: :ref:`String`, position\: :ref:`Rect2` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType` = 0, max_length\: :ref:`int` = -1, cursor_start\: :ref:`int` = -1, cursor_end\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`warp_mouse`\ (\ position\: :ref:`Vector2i`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_can_draw`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_active_popup`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_attached_instance_id`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_current_screen`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_get_flag`\ (\ flag\: :ref:`WindowFlags`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_max_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_min_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`WindowMode` | :ref:`window_get_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`window_get_native_handle`\ (\ handle_type\: :ref:`HandleType`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2i` | :ref:`window_get_popup_safe_rect`\ (\ window\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_position`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_position_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector3i` | :ref:`window_get_safe_title_margins`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_size`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_size_with_decorations`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`window_get_title_size`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`VSyncMode` | :ref:`window_get_vsync_mode`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_is_focused`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_is_maximize_allowed`\ (\ window_id\: :ref:`int` = 0\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_maximize_on_title_dbl_click`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`window_minimize_on_title_dbl_click`\ (\ ) |const| | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_move_to_foreground`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_request_attention`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_current_screen`\ (\ screen\: :ref:`int`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_drop_files_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_exclusive`\ (\ window_id\: :ref:`int`, exclusive\: :ref:`bool`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_flag`\ (\ flag\: :ref:`WindowFlags`, enabled\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_ime_active`\ (\ active\: :ref:`bool`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_ime_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_input_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_input_text_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_max_size`\ (\ max_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_min_size`\ (\ min_size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_mode`\ (\ mode\: :ref:`WindowMode`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_mouse_passthrough`\ (\ region\: :ref:`PackedVector2Array`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_popup_safe_rect`\ (\ window\: :ref:`int`, rect\: :ref:`Rect2i`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_position`\ (\ position\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_rect_changed_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_size`\ (\ size\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_title`\ (\ title\: :ref:`String`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_transient`\ (\ window_id\: :ref:`int`, parent_window_id\: :ref:`int`\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_vsync_mode`\ (\ vsync_mode\: :ref:`VSyncMode`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_window_buttons_offset`\ (\ offset\: :ref:`Vector2i`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_set_window_event_callback`\ (\ callback\: :ref:`Callable`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_start_drag`\ (\ window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`window_start_resize`\ (\ edge\: :ref:`WindowResizeEdge`, window_id\: :ref:`int` = 0\ ) | + +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -532,7 +688,7 @@ Display server supports windows can use per-pixel transparency to make windows b :ref:`Feature` **FEATURE_HIDPI** = ``12`` -Display server supports querying the operating system's display scale factor. This allows for *reliable* automatic hiDPI display detection, as opposed to guessing based on the screen resolution and reported display DPI (which can be unreliable due to broken monitor EDID). **Windows, Linux (Wayland), macOS** +Display server supports querying the operating system's display scale factor. This allows automatically detecting the hiDPI display *reliably*, instead of guessing based on the screen resolution and the display's reported DPI (which might be unreliable due to broken monitor EDID). **Windows, Linux (Wayland), macOS** .. _class_DisplayServer_constant_FEATURE_ICON: @@ -678,1029 +834,2791 @@ Native file selection dialog supports MIME types as filters. Display server supports system emoji and symbol picker. **Windows, macOS** -.. rst-class:: classref-item-separator - ----- +.. _class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER: -.. _enum_DisplayServer_MouseMode: +.. rst-class:: classref-enumeration-constant -.. rst-class:: classref-enumeration +:ref:`Feature` **FEATURE_NATIVE_COLOR_PICKER** = ``32`` -enum **MouseMode**: :ref:`🔗` +Display server supports native color picker. **Linux (X11/Wayland)** -.. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE: +.. _class_DisplayServer_constant_FEATURE_SELF_FITTING_WINDOWS: .. rst-class:: classref-enumeration-constant -:ref:`MouseMode` **MOUSE_MODE_VISIBLE** = ``0`` +:ref:`Feature` **FEATURE_SELF_FITTING_WINDOWS** = ``33`` -Makes the mouse cursor visible if it is hidden. +Display server automatically fits popups according to the screen boundaries. Window nodes should not attempt to do that themselves. -.. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN: +.. _class_DisplayServer_constant_FEATURE_ACCESSIBILITY_SCREEN_READER: .. rst-class:: classref-enumeration-constant -:ref:`MouseMode` **MOUSE_MODE_HIDDEN** = ``1`` +:ref:`Feature` **FEATURE_ACCESSIBILITY_SCREEN_READER** = ``34`` -Makes the mouse cursor hidden if it is visible. +Display server supports interaction with screen reader or Braille display. **Linux (X11/Wayland), macOS, Windows** -.. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration-constant +---- -:ref:`MouseMode` **MOUSE_MODE_CAPTURED** = ``2`` +.. _enum_DisplayServer_AccessibilityRole: -Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window. +.. rst-class:: classref-enumeration -\ **Note:** If you want to process the mouse's movement in this mode, you need to use :ref:`InputEventMouseMotion.relative`. +enum **AccessibilityRole**: :ref:`🔗` -.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED: +.. _class_DisplayServer_constant_ROLE_UNKNOWN: .. rst-class:: classref-enumeration-constant -:ref:`MouseMode` **MOUSE_MODE_CONFINED** = ``3`` +:ref:`AccessibilityRole` **ROLE_UNKNOWN** = ``0`` -Confines the mouse cursor to the game window, and make it visible. +Unknown or custom role. -.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN: +.. _class_DisplayServer_constant_ROLE_DEFAULT_BUTTON: .. rst-class:: classref-enumeration-constant -:ref:`MouseMode` **MOUSE_MODE_CONFINED_HIDDEN** = ``4`` +:ref:`AccessibilityRole` **ROLE_DEFAULT_BUTTON** = ``1`` -Confines the mouse cursor to the game window, and make it hidden. +Default dialog button element. -.. _class_DisplayServer_constant_MOUSE_MODE_MAX: +.. _class_DisplayServer_constant_ROLE_AUDIO: .. rst-class:: classref-enumeration-constant -:ref:`MouseMode` **MOUSE_MODE_MAX** = ``5`` - -Max value of the :ref:`MouseMode`. +:ref:`AccessibilityRole` **ROLE_AUDIO** = ``2`` -.. rst-class:: classref-item-separator +Audio player element. ----- +.. _class_DisplayServer_constant_ROLE_VIDEO: -.. _enum_DisplayServer_ScreenOrientation: +.. rst-class:: classref-enumeration-constant -.. rst-class:: classref-enumeration +:ref:`AccessibilityRole` **ROLE_VIDEO** = ``3`` -enum **ScreenOrientation**: :ref:`🔗` +Video player element. -.. _class_DisplayServer_constant_SCREEN_LANDSCAPE: +.. _class_DisplayServer_constant_ROLE_STATIC_TEXT: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_LANDSCAPE** = ``0`` +:ref:`AccessibilityRole` **ROLE_STATIC_TEXT** = ``4`` -Default landscape orientation. +Non-editable text label. -.. _class_DisplayServer_constant_SCREEN_PORTRAIT: +.. _class_DisplayServer_constant_ROLE_CONTAINER: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_PORTRAIT** = ``1`` +:ref:`AccessibilityRole` **ROLE_CONTAINER** = ``5`` -Default portrait orientation. +Container element. Elements with this role are used for internal structure and ignored by screen readers. -.. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE: +.. _class_DisplayServer_constant_ROLE_PANEL: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_REVERSE_LANDSCAPE** = ``2`` +:ref:`AccessibilityRole` **ROLE_PANEL** = ``6`` -Reverse landscape orientation (upside down). +Panel container element. -.. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT: +.. _class_DisplayServer_constant_ROLE_BUTTON: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_REVERSE_PORTRAIT** = ``3`` +:ref:`AccessibilityRole` **ROLE_BUTTON** = ``7`` -Reverse portrait orientation (upside down). +Button element. -.. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE: +.. _class_DisplayServer_constant_ROLE_LINK: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_SENSOR_LANDSCAPE** = ``4`` +:ref:`AccessibilityRole` **ROLE_LINK** = ``8`` -Automatic landscape orientation (default or reverse depending on sensor). +Link element. -.. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT: +.. _class_DisplayServer_constant_ROLE_CHECK_BOX: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_SENSOR_PORTRAIT** = ``5`` +:ref:`AccessibilityRole` **ROLE_CHECK_BOX** = ``9`` -Automatic portrait orientation (default or reverse depending on sensor). +Check box element. -.. _class_DisplayServer_constant_SCREEN_SENSOR: +.. _class_DisplayServer_constant_ROLE_RADIO_BUTTON: .. rst-class:: classref-enumeration-constant -:ref:`ScreenOrientation` **SCREEN_SENSOR** = ``6`` - -Automatic landscape or portrait orientation (default or reverse depending on sensor). +:ref:`AccessibilityRole` **ROLE_RADIO_BUTTON** = ``10`` -.. rst-class:: classref-item-separator +Radio button element. ----- +.. _class_DisplayServer_constant_ROLE_CHECK_BUTTON: -.. _enum_DisplayServer_VirtualKeyboardType: +.. rst-class:: classref-enumeration-constant -.. rst-class:: classref-enumeration +:ref:`AccessibilityRole` **ROLE_CHECK_BUTTON** = ``11`` -enum **VirtualKeyboardType**: :ref:`🔗` +Check button element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT: +.. _class_DisplayServer_constant_ROLE_SCROLL_BAR: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_DEFAULT** = ``0`` +:ref:`AccessibilityRole` **ROLE_SCROLL_BAR** = ``12`` -Default text virtual keyboard. +Scroll bar element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE: +.. _class_DisplayServer_constant_ROLE_SCROLL_VIEW: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_MULTILINE** = ``1`` +:ref:`AccessibilityRole` **ROLE_SCROLL_VIEW** = ``13`` -Multiline virtual keyboard. +Scroll container element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER: +.. _class_DisplayServer_constant_ROLE_SPLITTER: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_NUMBER** = ``2`` +:ref:`AccessibilityRole` **ROLE_SPLITTER** = ``14`` -Virtual number keypad, useful for PIN entry. +Container splitter handle element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL: +.. _class_DisplayServer_constant_ROLE_SLIDER: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3`` +:ref:`AccessibilityRole` **ROLE_SLIDER** = ``15`` -Virtual number keypad, useful for entering fractional numbers. +Slider element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE: +.. _class_DisplayServer_constant_ROLE_SPIN_BUTTON: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_PHONE** = ``4`` +:ref:`AccessibilityRole` **ROLE_SPIN_BUTTON** = ``16`` -Virtual phone number keypad. +Spin box element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS: +.. _class_DisplayServer_constant_ROLE_PROGRESS_INDICATOR: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5`` +:ref:`AccessibilityRole` **ROLE_PROGRESS_INDICATOR** = ``17`` -Virtual keyboard with additional keys to assist with typing email addresses. +Progress indicator element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD: +.. _class_DisplayServer_constant_ROLE_TEXT_FIELD: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_PASSWORD** = ``6`` - -Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization. +:ref:`AccessibilityRole` **ROLE_TEXT_FIELD** = ``18`` -\ **Note:** This is not supported on Web. Instead, this behaves identically to :ref:`KEYBOARD_TYPE_DEFAULT`. +Editable text field element. -.. _class_DisplayServer_constant_KEYBOARD_TYPE_URL: +.. _class_DisplayServer_constant_ROLE_MULTILINE_TEXT_FIELD: .. rst-class:: classref-enumeration-constant -:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_URL** = ``7`` - -Virtual keyboard with additional keys to assist with typing URLs. +:ref:`AccessibilityRole` **ROLE_MULTILINE_TEXT_FIELD** = ``19`` -.. rst-class:: classref-item-separator +Multiline editable text field element. ----- +.. _class_DisplayServer_constant_ROLE_COLOR_PICKER: -.. _enum_DisplayServer_CursorShape: +.. rst-class:: classref-enumeration-constant -.. rst-class:: classref-enumeration +:ref:`AccessibilityRole` **ROLE_COLOR_PICKER** = ``20`` -enum **CursorShape**: :ref:`🔗` +Color picker element. -.. _class_DisplayServer_constant_CURSOR_ARROW: +.. _class_DisplayServer_constant_ROLE_TABLE: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_ARROW** = ``0`` +:ref:`AccessibilityRole` **ROLE_TABLE** = ``21`` -Arrow cursor shape. This is the default when not pointing anything that overrides the mouse cursor, such as a :ref:`LineEdit` or :ref:`TextEdit`. +Table element. -.. _class_DisplayServer_constant_CURSOR_IBEAM: +.. _class_DisplayServer_constant_ROLE_CELL: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_IBEAM** = ``1`` +:ref:`AccessibilityRole` **ROLE_CELL** = ``22`` -I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as :ref:`LineEdit` or :ref:`TextEdit`. +Table/tree cell element. -.. _class_DisplayServer_constant_CURSOR_POINTING_HAND: +.. _class_DisplayServer_constant_ROLE_ROW: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_POINTING_HAND** = ``2`` +:ref:`AccessibilityRole` **ROLE_ROW** = ``23`` -Pointing hand cursor shape. This is used by default when hovering a :ref:`LinkButton` or a URL tag in a :ref:`RichTextLabel`. +Table/tree row element. -.. _class_DisplayServer_constant_CURSOR_CROSS: +.. _class_DisplayServer_constant_ROLE_ROW_GROUP: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_CROSS** = ``3`` +:ref:`AccessibilityRole` **ROLE_ROW_GROUP** = ``24`` -Crosshair cursor. This is intended to be displayed when the user needs precise aim over an element, such as a rectangle selection tool or a color picker. +Table/tree row group element. -.. _class_DisplayServer_constant_CURSOR_WAIT: +.. _class_DisplayServer_constant_ROLE_ROW_HEADER: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_WAIT** = ``4`` +:ref:`AccessibilityRole` **ROLE_ROW_HEADER** = ``25`` -Wait cursor. On most cursor themes, this displays a spinning icon *besides* the arrow. Intended to be used for non-blocking operations (when the user can do something else at the moment). See also :ref:`CURSOR_BUSY`. +Table/tree row header element. -.. _class_DisplayServer_constant_CURSOR_BUSY: +.. _class_DisplayServer_constant_ROLE_COLUMN_HEADER: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_BUSY** = ``5`` +:ref:`AccessibilityRole` **ROLE_COLUMN_HEADER** = ``26`` -Wait cursor. On most cursor themes, this *replaces* the arrow with a spinning icon. Intended to be used for blocking operations (when the user can't do anything else at the moment). See also :ref:`CURSOR_WAIT`. +Table/tree column header element. -.. _class_DisplayServer_constant_CURSOR_DRAG: +.. _class_DisplayServer_constant_ROLE_TREE: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_DRAG** = ``6`` +:ref:`AccessibilityRole` **ROLE_TREE** = ``27`` -Dragging hand cursor. This is displayed during drag-and-drop operations. See also :ref:`CURSOR_CAN_DROP`. +Tree view element. -.. _class_DisplayServer_constant_CURSOR_CAN_DROP: +.. _class_DisplayServer_constant_ROLE_TREE_ITEM: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_CAN_DROP** = ``7`` +:ref:`AccessibilityRole` **ROLE_TREE_ITEM** = ``28`` -"Can drop" cursor. This is displayed during drag-and-drop operations if hovering over a :ref:`Control` that can accept the drag-and-drop event. On most cursor themes, this displays a dragging hand with an arrow symbol besides it. See also :ref:`CURSOR_DRAG`. +Tree view item element. -.. _class_DisplayServer_constant_CURSOR_FORBIDDEN: +.. _class_DisplayServer_constant_ROLE_LIST: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_FORBIDDEN** = ``8`` +:ref:`AccessibilityRole` **ROLE_LIST** = ``29`` -Forbidden cursor. This is displayed during drag-and-drop operations if the hovered :ref:`Control` can't accept the drag-and-drop event. +List element. -.. _class_DisplayServer_constant_CURSOR_VSIZE: +.. _class_DisplayServer_constant_ROLE_LIST_ITEM: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_VSIZE** = ``9`` +:ref:`AccessibilityRole` **ROLE_LIST_ITEM** = ``30`` -Vertical resize cursor. Intended to be displayed when the hovered :ref:`Control` can be vertically resized using the mouse. See also :ref:`CURSOR_VSPLIT`. +List item element. -.. _class_DisplayServer_constant_CURSOR_HSIZE: +.. _class_DisplayServer_constant_ROLE_LIST_BOX: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_HSIZE** = ``10`` +:ref:`AccessibilityRole` **ROLE_LIST_BOX** = ``31`` -Horizontal resize cursor. Intended to be displayed when the hovered :ref:`Control` can be horizontally resized using the mouse. See also :ref:`CURSOR_HSPLIT`. +List view element. -.. _class_DisplayServer_constant_CURSOR_BDIAGSIZE: +.. _class_DisplayServer_constant_ROLE_LIST_BOX_OPTION: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_BDIAGSIZE** = ``11`` +:ref:`AccessibilityRole` **ROLE_LIST_BOX_OPTION** = ``32`` -Secondary diagonal resize cursor (top-right/bottom-left). Intended to be displayed when the hovered :ref:`Control` can be resized on both axes at once using the mouse. +List view item element. -.. _class_DisplayServer_constant_CURSOR_FDIAGSIZE: +.. _class_DisplayServer_constant_ROLE_TAB_BAR: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_FDIAGSIZE** = ``12`` +:ref:`AccessibilityRole` **ROLE_TAB_BAR** = ``33`` -Main diagonal resize cursor (top-left/bottom-right). Intended to be displayed when the hovered :ref:`Control` can be resized on both axes at once using the mouse. +Tab bar element. -.. _class_DisplayServer_constant_CURSOR_MOVE: +.. _class_DisplayServer_constant_ROLE_TAB: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_MOVE** = ``13`` +:ref:`AccessibilityRole` **ROLE_TAB** = ``34`` -Move cursor. Intended to be displayed when the hovered :ref:`Control` can be moved using the mouse. +Tab bar item element. -.. _class_DisplayServer_constant_CURSOR_VSPLIT: +.. _class_DisplayServer_constant_ROLE_TAB_PANEL: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_VSPLIT** = ``14`` +:ref:`AccessibilityRole` **ROLE_TAB_PANEL** = ``35`` -Vertical split cursor. This is displayed when hovering a :ref:`Control` with splits that can be vertically resized using the mouse, such as :ref:`VSplitContainer`. On some cursor themes, this cursor may have the same appearance as :ref:`CURSOR_VSIZE`. +Tab panel element. -.. _class_DisplayServer_constant_CURSOR_HSPLIT: +.. _class_DisplayServer_constant_ROLE_MENU_BAR: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_HSPLIT** = ``15`` +:ref:`AccessibilityRole` **ROLE_MENU_BAR** = ``36`` -Horizontal split cursor. This is displayed when hovering a :ref:`Control` with splits that can be horizontally resized using the mouse, such as :ref:`HSplitContainer`. On some cursor themes, this cursor may have the same appearance as :ref:`CURSOR_HSIZE`. +Menu bar element. -.. _class_DisplayServer_constant_CURSOR_HELP: +.. _class_DisplayServer_constant_ROLE_MENU: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_HELP** = ``16`` +:ref:`AccessibilityRole` **ROLE_MENU** = ``37`` -Help cursor. On most cursor themes, this displays a question mark icon instead of the mouse cursor. Intended to be used when the user has requested help on the next element that will be clicked. +Popup menu element. -.. _class_DisplayServer_constant_CURSOR_MAX: +.. _class_DisplayServer_constant_ROLE_MENU_ITEM: .. rst-class:: classref-enumeration-constant -:ref:`CursorShape` **CURSOR_MAX** = ``17`` +:ref:`AccessibilityRole` **ROLE_MENU_ITEM** = ``38`` -Represents the size of the :ref:`CursorShape` enum. +Popup menu item element. -.. rst-class:: classref-item-separator +.. _class_DisplayServer_constant_ROLE_MENU_ITEM_CHECK_BOX: ----- +.. rst-class:: classref-enumeration-constant -.. _enum_DisplayServer_FileDialogMode: +:ref:`AccessibilityRole` **ROLE_MENU_ITEM_CHECK_BOX** = ``39`` -.. rst-class:: classref-enumeration +Popup menu check button item element. -enum **FileDialogMode**: :ref:`🔗` +.. _class_DisplayServer_constant_ROLE_MENU_ITEM_RADIO: -.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE: +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityRole` **ROLE_MENU_ITEM_RADIO** = ``40`` + +Popup menu radio button item element. + +.. _class_DisplayServer_constant_ROLE_IMAGE: .. rst-class:: classref-enumeration-constant -:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_FILE** = ``0`` +:ref:`AccessibilityRole` **ROLE_IMAGE** = ``41`` -The native file dialog allows selecting one, and only one file. +Image element. -.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES: +.. _class_DisplayServer_constant_ROLE_WINDOW: .. rst-class:: classref-enumeration-constant -:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_FILES** = ``1`` +:ref:`AccessibilityRole` **ROLE_WINDOW** = ``42`` -The native file dialog allows selecting multiple files. +Window element. -.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR: +.. _class_DisplayServer_constant_ROLE_TITLE_BAR: .. rst-class:: classref-enumeration-constant -:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_DIR** = ``2`` +:ref:`AccessibilityRole` **ROLE_TITLE_BAR** = ``43`` -The native file dialog only allows selecting a directory, disallowing the selection of any file. +Embedded window title bar element. -.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY: +.. _class_DisplayServer_constant_ROLE_DIALOG: .. rst-class:: classref-enumeration-constant -:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_ANY** = ``3`` +:ref:`AccessibilityRole` **ROLE_DIALOG** = ``44`` -The native file dialog allows selecting one file or directory. +Dialog window element. -.. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE: +.. _class_DisplayServer_constant_ROLE_TOOLTIP: .. rst-class:: classref-enumeration-constant -:ref:`FileDialogMode` **FILE_DIALOG_MODE_SAVE_FILE** = ``4`` +:ref:`AccessibilityRole` **ROLE_TOOLTIP** = ``45`` -The native file dialog will warn when a file exists. +Tooltip element. .. rst-class:: classref-item-separator ---- -.. _enum_DisplayServer_WindowMode: +.. _enum_DisplayServer_AccessibilityPopupType: .. rst-class:: classref-enumeration -enum **WindowMode**: :ref:`🔗` +enum **AccessibilityPopupType**: :ref:`🔗` -.. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED: +.. _class_DisplayServer_constant_POPUP_UNKNOWN: .. rst-class:: classref-enumeration-constant -:ref:`WindowMode` **WINDOW_MODE_WINDOWED** = ``0`` +:ref:`AccessibilityPopupType` **POPUP_UNKNOWN** = ``0`` -Windowed mode, i.e. :ref:`Window` doesn't occupy the whole screen (unless set to the size of the screen). +Other/unknown popup type. -.. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED: +.. _class_DisplayServer_constant_POPUP_MENU: .. rst-class:: classref-enumeration-constant -:ref:`WindowMode` **WINDOW_MODE_MINIMIZED** = ``1`` +:ref:`AccessibilityPopupType` **POPUP_MENU** = ``1`` -Minimized window mode, i.e. :ref:`Window` is not visible and available on window manager's window list. Normally happens when the minimize button is pressed. +Popup menu. -.. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED: +.. _class_DisplayServer_constant_POPUP_LIST: .. rst-class:: classref-enumeration-constant -:ref:`WindowMode` **WINDOW_MODE_MAXIMIZED** = ``2`` +:ref:`AccessibilityPopupType` **POPUP_LIST** = ``2`` -Maximized window mode, i.e. :ref:`Window` will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed. +Popup list. -.. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN: +.. _class_DisplayServer_constant_POPUP_TREE: .. rst-class:: classref-enumeration-constant -:ref:`WindowMode` **WINDOW_MODE_FULLSCREEN** = ``3`` - -Full screen mode with full multi-window support. +:ref:`AccessibilityPopupType` **POPUP_TREE** = ``3`` -Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed. +Popup tree view. -\ **On Android:** This enables immersive mode. +.. _class_DisplayServer_constant_POPUP_DIALOG: -\ **On Windows:** Multi-window full-screen mode has a 1px border of the :ref:`ProjectSettings.rendering/environment/defaults/default_clear_color` color. +.. rst-class:: classref-enumeration-constant -\ **On macOS:** A new desktop is used to display the running project. +:ref:`AccessibilityPopupType` **POPUP_DIALOG** = ``4`` -\ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode. +Popup dialog. -.. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration-constant +---- -:ref:`WindowMode` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4`` +.. _enum_DisplayServer_AccessibilityFlags: -A single window full screen mode. This mode has less overhead, but only one window can be open on a given screen at a time (opening a child window or application switching will trigger a full screen transition). +.. rst-class:: classref-enumeration -Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed. +enum **AccessibilityFlags**: :ref:`🔗` -\ **On Android:** This enables immersive mode. +.. _class_DisplayServer_constant_FLAG_HIDDEN: -\ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment. +.. rst-class:: classref-enumeration-constant -\ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen. +:ref:`AccessibilityFlags` **FLAG_HIDDEN** = ``0`` -\ **On Linux (X11):** Exclusive full screen mode bypasses compositor. +Element is hidden for accessibility tools. -\ **On Linux (Wayland):** Equivalent to :ref:`WINDOW_MODE_FULLSCREEN`. +.. _class_DisplayServer_constant_FLAG_LINKED: -\ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode. +.. rst-class:: classref-enumeration-constant -.. rst-class:: classref-item-separator +:ref:`AccessibilityFlags` **FLAG_LINKED** = ``1`` ----- +.. container:: contribute -.. _enum_DisplayServer_WindowFlags: + There is currently no description for this enum. Please help us by :ref:`contributing one `! -.. rst-class:: classref-enumeration -enum **WindowFlags**: :ref:`🔗` -.. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED: +.. _class_DisplayServer_constant_FLAG_MULTISELECTABLE: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_RESIZE_DISABLED** = ``0`` +:ref:`AccessibilityFlags` **FLAG_MULTISELECTABLE** = ``2`` -The window can't be resized by dragging its resize grip. It's still possible to resize the window using :ref:`window_set_size()`. This flag is ignored for full screen windows. +Element is support multiple item selection. -.. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS: +.. _class_DisplayServer_constant_FLAG_REQUIRED: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_BORDERLESS** = ``1`` +:ref:`AccessibilityFlags` **FLAG_REQUIRED** = ``3`` -The window do not have native title bar and other decorations. This flag is ignored for full-screen windows. +Element require user input. -.. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP: +.. _class_DisplayServer_constant_FLAG_VISITED: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2`` +:ref:`AccessibilityFlags` **FLAG_VISITED** = ``4`` -The window is floating on top of all other windows. This flag is ignored for full-screen windows. +Element is a visited link. -.. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT: +.. _class_DisplayServer_constant_FLAG_BUSY: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_TRANSPARENT** = ``3`` - -The window background can be transparent. - -\ **Note:** This flag has no effect if :ref:`is_window_transparency_available()` returns ``false``. +:ref:`AccessibilityFlags` **FLAG_BUSY** = ``5`` -\ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities. +Element content is not ready (e.g. loading). -.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS: +.. _class_DisplayServer_constant_FLAG_MODAL: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_NO_FOCUS** = ``4`` +:ref:`AccessibilityFlags` **FLAG_MODAL** = ``6`` -The window can't be focused. No-focus window will ignore all input, except mouse clicks. +Element is modal window. -.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP: +.. _class_DisplayServer_constant_FLAG_TOUCH_PASSTHROUGH: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_POPUP** = ``5`` +:ref:`AccessibilityFlags` **FLAG_TOUCH_PASSTHROUGH** = ``7`` -Window is part of menu or :ref:`OptionButton` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see :ref:`window_set_transient()`). +Element allows touches to be passed through when a screen reader is in touch exploration mode. -.. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE: +.. _class_DisplayServer_constant_FLAG_READONLY: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6`` +:ref:`AccessibilityFlags` **FLAG_READONLY** = ``8`` -Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons. +Element is text field with selectable but read-only text. -Use :ref:`window_set_window_buttons_offset()` to adjust minimize/maximize/close buttons offset. +.. _class_DisplayServer_constant_FLAG_DISABLED: -Use :ref:`window_get_safe_title_margins()` to determine area under the title bar that is not covered by decorations. +.. rst-class:: classref-enumeration-constant -\ **Note:** This flag is implemented only on macOS. +:ref:`AccessibilityFlags` **FLAG_DISABLED** = ``9`` -.. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH: +Element is disabled. + +.. _class_DisplayServer_constant_FLAG_CLIPS_CHILDREN: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7`` +:ref:`AccessibilityFlags` **FLAG_CLIPS_CHILDREN** = ``10`` -All mouse events are passed to the underlying window of the same application. +Element clips children. -.. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration-constant +---- -:ref:`WindowFlags` **WINDOW_FLAG_SHARP_CORNERS** = ``8`` +.. _enum_DisplayServer_AccessibilityAction: -Window style is overridden, forcing sharp corners. +.. rst-class:: classref-enumeration -\ **Note:** This flag is implemented only on Windows (11). +enum **AccessibilityAction**: :ref:`🔗` -.. _class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE: +.. _class_DisplayServer_constant_ACTION_CLICK: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9`` +:ref:`AccessibilityAction` **ACTION_CLICK** = ``0`` -Windows is excluded from screenshots taken by :ref:`screen_get_image()`, :ref:`screen_get_image_rect()`, and :ref:`screen_get_pixel()`. +Single click action, callback argument is not set. -\ **Note:** This flag is implemented on macOS and Windows. +.. _class_DisplayServer_constant_ACTION_FOCUS: -\ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image, it should not be used as a security measure. +.. rst-class:: classref-enumeration-constant -.. _class_DisplayServer_constant_WINDOW_FLAG_MAX: +:ref:`AccessibilityAction` **ACTION_FOCUS** = ``1`` + +Focus action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_BLUR: .. rst-class:: classref-enumeration-constant -:ref:`WindowFlags` **WINDOW_FLAG_MAX** = ``10`` +:ref:`AccessibilityAction` **ACTION_BLUR** = ``2`` -Max value of the :ref:`WindowFlags`. +Blur action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_COLLAPSE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_COLLAPSE** = ``3`` + +Collapse action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_EXPAND: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_EXPAND** = ``4`` + +Expand action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_DECREMENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_DECREMENT** = ``5`` + +Decrement action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_INCREMENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_INCREMENT** = ``6`` + +Increment action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_HIDE_TOOLTIP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_HIDE_TOOLTIP** = ``7`` + +Hide tooltip action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SHOW_TOOLTIP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SHOW_TOOLTIP** = ``8`` + +Show tooltip action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SET_TEXT_SELECTION: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SET_TEXT_SELECTION** = ``9`` + +Set text selection action, callback argument is set to :ref:`Dictionary` with the following keys: + +- ``"start_element"`` accessibility element of the selection start. + +- ``"start_char"`` character offset relative to the accessibility element of the selection start. + +- ``"end_element"`` accessibility element of the selection end. + +- ``"end_char"`` character offset relative to the accessibility element of the selection end. + +.. _class_DisplayServer_constant_ACTION_REPLACE_SELECTED_TEXT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_REPLACE_SELECTED_TEXT** = ``10`` + +Replace text action, callback argument is set to :ref:`String` with the replacement text. + +.. _class_DisplayServer_constant_ACTION_SCROLL_BACKWARD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_BACKWARD** = ``11`` + +Scroll backward action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_DOWN: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_DOWN** = ``12`` + +Scroll down action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_FORWARD: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_FORWARD** = ``13`` + +Scroll forward action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_LEFT** = ``14`` + +Scroll left action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_RIGHT** = ``15`` + +Scroll right action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_UP: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_UP** = ``16`` + +Scroll up action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_INTO_VIEW: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_INTO_VIEW** = ``17`` + +Scroll into view action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_SCROLL_TO_POINT: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SCROLL_TO_POINT** = ``18`` + +Scroll to point action, callback argument is set to :ref:`Vector2` with the relative point coordinates. + +.. _class_DisplayServer_constant_ACTION_SET_SCROLL_OFFSET: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SET_SCROLL_OFFSET** = ``19`` + +Set scroll offset action, callback argument is set to :ref:`Vector2` with the scroll offset. + +.. _class_DisplayServer_constant_ACTION_SET_VALUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SET_VALUE** = ``20`` + +Set value action action, callback argument is set to :ref:`String` or number with the new value. + +.. _class_DisplayServer_constant_ACTION_SHOW_CONTEXT_MENU: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_SHOW_CONTEXT_MENU** = ``21`` + +Show context menu action, callback argument is not set. + +.. _class_DisplayServer_constant_ACTION_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`AccessibilityAction` **ACTION_CUSTOM** = ``22`` + +Custom action, callback argument is set to the integer action id. .. rst-class:: classref-item-separator ---- -.. _enum_DisplayServer_WindowEvent: +.. _enum_DisplayServer_AccessibilityLiveMode: .. rst-class:: classref-enumeration -enum **WindowEvent**: :ref:`🔗` +enum **AccessibilityLiveMode**: :ref:`🔗` -.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER: +.. _class_DisplayServer_constant_LIVE_OFF: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_MOUSE_ENTER** = ``0`` +:ref:`AccessibilityLiveMode` **LIVE_OFF** = ``0`` -Sent when the mouse pointer enters the window. +Indicates that updates to the live region should not be presented. -.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT: +.. _class_DisplayServer_constant_LIVE_POLITE: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_MOUSE_EXIT** = ``1`` +:ref:`AccessibilityLiveMode` **LIVE_POLITE** = ``1`` -Sent when the mouse pointer exits the window. +Indicates that updates to the live region should be presented at the next opportunity (for example at the end of speaking the current sentence). -.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN: +.. _class_DisplayServer_constant_LIVE_ASSERTIVE: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_FOCUS_IN** = ``2`` +:ref:`AccessibilityLiveMode` **LIVE_ASSERTIVE** = ``2`` -Sent when the window grabs focus. +Indicates that updates to the live region have the highest priority and should be presented immediately. -.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT: +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_MouseMode: + +.. rst-class:: classref-enumeration + +enum **MouseMode**: :ref:`🔗` + +.. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_FOCUS_OUT** = ``3`` +:ref:`MouseMode` **MOUSE_MODE_VISIBLE** = ``0`` -Sent when the window loses focus. +Makes the mouse cursor visible if it is hidden. -.. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST: +.. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_CLOSE_REQUEST** = ``4`` +:ref:`MouseMode` **MOUSE_MODE_HIDDEN** = ``1`` -Sent when the user has attempted to close the window (e.g. close button is pressed). +Makes the mouse cursor hidden if it is visible. -.. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST: +.. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5`` +:ref:`MouseMode` **MOUSE_MODE_CAPTURED** = ``2`` -Sent when the device "Back" button is pressed. +Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window. -\ **Note:** This event is implemented only on Android. +\ **Note:** If you want to process the mouse's movement in this mode, you need to use :ref:`InputEventMouseMotion.relative`. -.. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE: +.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_DPI_CHANGE** = ``6`` - -Sent when the window is moved to the display with different DPI, or display DPI is changed. +:ref:`MouseMode` **MOUSE_MODE_CONFINED** = ``3`` -\ **Note:** This flag is implemented only on macOS. +Confines the mouse cursor to the game window, and make it visible. -.. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE: +.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN: .. rst-class:: classref-enumeration-constant -:ref:`WindowEvent` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7`` +:ref:`MouseMode` **MOUSE_MODE_CONFINED_HIDDEN** = ``4`` -Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` is set or window entered/exited full screen mode). +Confines the mouse cursor to the game window, and make it hidden. -\ **Note:** This flag is implemented only on macOS. +.. _class_DisplayServer_constant_MOUSE_MODE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`MouseMode` **MOUSE_MODE_MAX** = ``5`` + +Max value of the :ref:`MouseMode`. .. rst-class:: classref-item-separator ---- -.. _enum_DisplayServer_WindowResizeEdge: +.. _enum_DisplayServer_ScreenOrientation: .. rst-class:: classref-enumeration -enum **WindowResizeEdge**: :ref:`🔗` +enum **ScreenOrientation**: :ref:`🔗` -.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_LEFT: +.. _class_DisplayServer_constant_SCREEN_LANDSCAPE: .. rst-class:: classref-enumeration-constant -:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP_LEFT** = ``0`` +:ref:`ScreenOrientation` **SCREEN_LANDSCAPE** = ``0`` -Top-left edge of a window. +Default landscape orientation. -.. _class_DisplayServer_constant_WINDOW_EDGE_TOP: +.. _class_DisplayServer_constant_SCREEN_PORTRAIT: .. rst-class:: classref-enumeration-constant -:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP** = ``1`` +:ref:`ScreenOrientation` **SCREEN_PORTRAIT** = ``1`` -Top edge of a window. +Default portrait orientation. -.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT: +.. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE: .. rst-class:: classref-enumeration-constant -:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP_RIGHT** = ``2`` +:ref:`ScreenOrientation` **SCREEN_REVERSE_LANDSCAPE** = ``2`` -Top-right edge of a window. +Reverse landscape orientation (upside down). -.. _class_DisplayServer_constant_WINDOW_EDGE_LEFT: +.. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT: .. rst-class:: classref-enumeration-constant -:ref:`WindowResizeEdge` **WINDOW_EDGE_LEFT** = ``3`` +:ref:`ScreenOrientation` **SCREEN_REVERSE_PORTRAIT** = ``3`` -Left edge of a window. +Reverse portrait orientation (upside down). -.. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT: +.. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE: .. rst-class:: classref-enumeration-constant -:ref:`WindowResizeEdge` **WINDOW_EDGE_RIGHT** = ``4`` +:ref:`ScreenOrientation` **SCREEN_SENSOR_LANDSCAPE** = ``4`` + +Automatic landscape orientation (default or reverse depending on sensor). + +.. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScreenOrientation` **SCREEN_SENSOR_PORTRAIT** = ``5`` + +Automatic portrait orientation (default or reverse depending on sensor). + +.. _class_DisplayServer_constant_SCREEN_SENSOR: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScreenOrientation` **SCREEN_SENSOR** = ``6`` + +Automatic landscape or portrait orientation (default or reverse depending on sensor). + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_VirtualKeyboardType: + +.. rst-class:: classref-enumeration + +enum **VirtualKeyboardType**: :ref:`🔗` + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_DEFAULT** = ``0`` + +Default text virtual keyboard. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_MULTILINE** = ``1`` + +Multiline virtual keyboard. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_NUMBER** = ``2`` + +Virtual number keypad, useful for PIN entry. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3`` + +Virtual number keypad, useful for entering fractional numbers. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_PHONE** = ``4`` + +Virtual phone number keypad. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5`` + +Virtual keyboard with additional keys to assist with typing email addresses. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_PASSWORD** = ``6`` + +Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization. + +\ **Note:** This is not supported on Web. Instead, this behaves identically to :ref:`KEYBOARD_TYPE_DEFAULT`. + +.. _class_DisplayServer_constant_KEYBOARD_TYPE_URL: + +.. rst-class:: classref-enumeration-constant + +:ref:`VirtualKeyboardType` **KEYBOARD_TYPE_URL** = ``7`` + +Virtual keyboard with additional keys to assist with typing URLs. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_CursorShape: + +.. rst-class:: classref-enumeration + +enum **CursorShape**: :ref:`🔗` + +.. _class_DisplayServer_constant_CURSOR_ARROW: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_ARROW** = ``0`` + +Arrow cursor shape. This is the default when not pointing anything that overrides the mouse cursor, such as a :ref:`LineEdit` or :ref:`TextEdit`. + +.. _class_DisplayServer_constant_CURSOR_IBEAM: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_IBEAM** = ``1`` + +I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as :ref:`LineEdit` or :ref:`TextEdit`. + +.. _class_DisplayServer_constant_CURSOR_POINTING_HAND: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_POINTING_HAND** = ``2`` + +Pointing hand cursor shape. This is used by default when hovering a :ref:`LinkButton` or a URL tag in a :ref:`RichTextLabel`. + +.. _class_DisplayServer_constant_CURSOR_CROSS: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_CROSS** = ``3`` + +Crosshair cursor. This is intended to be displayed when the user needs precise aim over an element, such as a rectangle selection tool or a color picker. + +.. _class_DisplayServer_constant_CURSOR_WAIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_WAIT** = ``4`` + +Wait cursor. On most cursor themes, this displays a spinning icon *besides* the arrow. Intended to be used for non-blocking operations (when the user can do something else at the moment). See also :ref:`CURSOR_BUSY`. + +.. _class_DisplayServer_constant_CURSOR_BUSY: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_BUSY** = ``5`` + +Wait cursor. On most cursor themes, this *replaces* the arrow with a spinning icon. Intended to be used for blocking operations (when the user can't do anything else at the moment). See also :ref:`CURSOR_WAIT`. + +.. _class_DisplayServer_constant_CURSOR_DRAG: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_DRAG** = ``6`` + +Dragging hand cursor. This is displayed during drag-and-drop operations. See also :ref:`CURSOR_CAN_DROP`. + +.. _class_DisplayServer_constant_CURSOR_CAN_DROP: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_CAN_DROP** = ``7`` + +"Can drop" cursor. This is displayed during drag-and-drop operations if hovering over a :ref:`Control` that can accept the drag-and-drop event. On most cursor themes, this displays a dragging hand with an arrow symbol besides it. See also :ref:`CURSOR_DRAG`. + +.. _class_DisplayServer_constant_CURSOR_FORBIDDEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_FORBIDDEN** = ``8`` + +Forbidden cursor. This is displayed during drag-and-drop operations if the hovered :ref:`Control` can't accept the drag-and-drop event. + +.. _class_DisplayServer_constant_CURSOR_VSIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_VSIZE** = ``9`` + +Vertical resize cursor. Intended to be displayed when the hovered :ref:`Control` can be vertically resized using the mouse. See also :ref:`CURSOR_VSPLIT`. + +.. _class_DisplayServer_constant_CURSOR_HSIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_HSIZE** = ``10`` + +Horizontal resize cursor. Intended to be displayed when the hovered :ref:`Control` can be horizontally resized using the mouse. See also :ref:`CURSOR_HSPLIT`. + +.. _class_DisplayServer_constant_CURSOR_BDIAGSIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_BDIAGSIZE** = ``11`` + +Secondary diagonal resize cursor (top-right/bottom-left). Intended to be displayed when the hovered :ref:`Control` can be resized on both axes at once using the mouse. + +.. _class_DisplayServer_constant_CURSOR_FDIAGSIZE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_FDIAGSIZE** = ``12`` + +Main diagonal resize cursor (top-left/bottom-right). Intended to be displayed when the hovered :ref:`Control` can be resized on both axes at once using the mouse. + +.. _class_DisplayServer_constant_CURSOR_MOVE: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_MOVE** = ``13`` + +Move cursor. Intended to be displayed when the hovered :ref:`Control` can be moved using the mouse. + +.. _class_DisplayServer_constant_CURSOR_VSPLIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_VSPLIT** = ``14`` + +Vertical split cursor. This is displayed when hovering a :ref:`Control` with splits that can be vertically resized using the mouse, such as :ref:`VSplitContainer`. On some cursor themes, this cursor may have the same appearance as :ref:`CURSOR_VSIZE`. + +.. _class_DisplayServer_constant_CURSOR_HSPLIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_HSPLIT** = ``15`` + +Horizontal split cursor. This is displayed when hovering a :ref:`Control` with splits that can be horizontally resized using the mouse, such as :ref:`HSplitContainer`. On some cursor themes, this cursor may have the same appearance as :ref:`CURSOR_HSIZE`. + +.. _class_DisplayServer_constant_CURSOR_HELP: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_HELP** = ``16`` + +Help cursor. On most cursor themes, this displays a question mark icon instead of the mouse cursor. Intended to be used when the user has requested help on the next element that will be clicked. + +.. _class_DisplayServer_constant_CURSOR_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`CursorShape` **CURSOR_MAX** = ``17`` + +Represents the size of the :ref:`CursorShape` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_FileDialogMode: + +.. rst-class:: classref-enumeration + +enum **FileDialogMode**: :ref:`🔗` + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_FILE** = ``0`` + +The native file dialog allows selecting one, and only one file. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_FILES** = ``1`` + +The native file dialog allows selecting multiple files. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_DIR** = ``2`` + +The native file dialog only allows selecting a directory, disallowing the selection of any file. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_OPEN_ANY** = ``3`` + +The native file dialog allows selecting one file or directory. + +.. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE: + +.. rst-class:: classref-enumeration-constant + +:ref:`FileDialogMode` **FILE_DIALOG_MODE_SAVE_FILE** = ``4`` + +The native file dialog will warn when a file exists. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_WindowMode: + +.. rst-class:: classref-enumeration + +enum **WindowMode**: :ref:`🔗` + +.. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowMode` **WINDOW_MODE_WINDOWED** = ``0`` + +Windowed mode, i.e. :ref:`Window` doesn't occupy the whole screen (unless set to the size of the screen). + +.. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowMode` **WINDOW_MODE_MINIMIZED** = ``1`` + +Minimized window mode, i.e. :ref:`Window` is not visible and available on window manager's window list. Normally happens when the minimize button is pressed. + +.. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowMode` **WINDOW_MODE_MAXIMIZED** = ``2`` + +Maximized window mode, i.e. :ref:`Window` will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed. + +.. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowMode` **WINDOW_MODE_FULLSCREEN** = ``3`` + +Full screen mode with full multi-window support. + +Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed. + +\ **On Android:** This enables immersive mode. + +\ **On macOS:** A new desktop is used to display the running project. + +\ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode. + +.. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowMode` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4`` + +A single window full screen mode. This mode has less overhead, but only one window can be open on a given screen at a time (opening a child window or application switching will trigger a full screen transition). + +Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed. + +\ **On Android:** This enables immersive mode. + +\ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment. + +\ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen. + +\ **On Linux (X11):** Exclusive full screen mode bypasses compositor. + +\ **On Linux (Wayland):** Equivalent to :ref:`WINDOW_MODE_FULLSCREEN`. + +\ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_WindowFlags: + +.. rst-class:: classref-enumeration + +enum **WindowFlags**: :ref:`🔗` + +.. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_RESIZE_DISABLED** = ``0`` + +The window can't be resized by dragging its resize grip. It's still possible to resize the window using :ref:`window_set_size()`. This flag is ignored for full screen windows. + +.. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_BORDERLESS** = ``1`` + +The window do not have native title bar and other decorations. This flag is ignored for full-screen windows. + +.. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2`` + +The window is floating on top of all other windows. This flag is ignored for full-screen windows. + +.. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_TRANSPARENT** = ``3`` + +The window background can be transparent. + +\ **Note:** This flag has no effect if :ref:`is_window_transparency_available()` returns ``false``. + +\ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities. + +.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_NO_FOCUS** = ``4`` + +The window can't be focused. No-focus window will ignore all input, except mouse clicks. + +.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_POPUP** = ``5`` + +Window is part of menu or :ref:`OptionButton` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see :ref:`window_set_transient()`). + +.. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6`` + +Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons. + +Use :ref:`window_set_window_buttons_offset()` to adjust minimize/maximize/close buttons offset. + +Use :ref:`window_get_safe_title_margins()` to determine area under the title bar that is not covered by decorations. + +\ **Note:** This flag is implemented only on macOS. + +.. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7`` + +All mouse events are passed to the underlying window of the same application. + +.. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_SHARP_CORNERS** = ``8`` + +Window style is overridden, forcing sharp corners. + +\ **Note:** This flag is implemented only on Windows (11). + +.. _class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9`` + +Window is excluded from screenshots taken by :ref:`screen_get_image()`, :ref:`screen_get_image_rect()`, and :ref:`screen_get_pixel()`. + +\ **Note:** This flag is implemented on macOS and Windows. + +\ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image. It should not be used as a security measure. + +.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP_WM_HINT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_POPUP_WM_HINT** = ``10`` + +Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window). + +.. _class_DisplayServer_constant_WINDOW_FLAG_MINIMIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_MINIMIZE_DISABLED** = ``11`` + +Window minimize button is disabled. + +\ **Note:** This flag is implemented on macOS and Windows. + +.. _class_DisplayServer_constant_WINDOW_FLAG_MAXIMIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_MAXIMIZE_DISABLED** = ``12`` + +Window maximize button is disabled. + +\ **Note:** This flag is implemented on macOS and Windows. + +.. _class_DisplayServer_constant_WINDOW_FLAG_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowFlags` **WINDOW_FLAG_MAX** = ``13`` + +Max value of the :ref:`WindowFlags`. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_WindowEvent: + +.. rst-class:: classref-enumeration + +enum **WindowEvent**: :ref:`🔗` + +.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_MOUSE_ENTER** = ``0`` + +Sent when the mouse pointer enters the window. + +.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_MOUSE_EXIT** = ``1`` + +Sent when the mouse pointer exits the window. + +.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_FOCUS_IN** = ``2`` + +Sent when the window grabs focus. + +.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_FOCUS_OUT** = ``3`` + +Sent when the window loses focus. + +.. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_CLOSE_REQUEST** = ``4`` + +Sent when the user has attempted to close the window (e.g. close button is pressed). + +.. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5`` + +Sent when the device "Back" button is pressed. + +\ **Note:** This event is implemented only on Android. + +.. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_DPI_CHANGE** = ``6`` + +Sent when the window is moved to the display with different DPI, or display DPI is changed. + +\ **Note:** This flag is implemented only on macOS and Linux (Wayland). + +.. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowEvent` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7`` + +Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXTEND_TO_TITLE` is set or window entered/exited full screen mode). + +\ **Note:** This flag is implemented only on macOS. + +.. _class_DisplayServer_constant_WINDOW_EVENT_FORCE_CLOSE: + +.. rst-class:: classref-enumeration-constant + +: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. + +\ **Note:** This flag is implemented only on Linux (Wayland). + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_WindowResizeEdge: + +.. rst-class:: classref-enumeration + +enum **WindowResizeEdge**: :ref:`🔗` + +.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP_LEFT** = ``0`` + +Top-left edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP** = ``1`` + +Top edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_TOP_RIGHT** = ``2`` + +Top-right edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_LEFT** = ``3`` + +Left edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_RIGHT** = ``4`` + +Right edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM_LEFT** = ``5`` + +Bottom-left edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM** = ``6`` + +Bottom edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7`` + +Bottom-right edge of a window. + +.. _class_DisplayServer_constant_WINDOW_EDGE_MAX: + +.. rst-class:: classref-enumeration-constant + +:ref:`WindowResizeEdge` **WINDOW_EDGE_MAX** = ``8`` + +Represents the size of the :ref:`WindowResizeEdge` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_VSyncMode: + +.. rst-class:: classref-enumeration + +enum **VSyncMode**: :ref:`🔗` + +.. _class_DisplayServer_constant_VSYNC_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`VSyncMode` **VSYNC_DISABLED** = ``0`` + +No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps`). + +.. _class_DisplayServer_constant_VSYNC_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`VSyncMode` **VSYNC_ENABLED** = ``1`` + +Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps`). + +.. _class_DisplayServer_constant_VSYNC_ADAPTIVE: + +.. rst-class:: classref-enumeration-constant + +:ref:`VSyncMode` **VSYNC_ADAPTIVE** = ``2`` + +Behaves like :ref:`VSYNC_DISABLED` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps`). Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. + +.. _class_DisplayServer_constant_VSYNC_MAILBOX: + +.. rst-class:: classref-enumeration-constant + +:ref:`VSyncMode` **VSYNC_MAILBOX** = ``3`` + +Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps`). + +Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX` works best when at least twice as many frames as the display refresh rate are rendered. Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_HandleType: + +.. rst-class:: classref-enumeration + +enum **HandleType**: :ref:`🔗` + +.. _class_DisplayServer_constant_DISPLAY_HANDLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`HandleType` **DISPLAY_HANDLE** = ``0`` + +Display handle: + +- Linux (X11): ``X11::Display*`` for the display. + +- Linux (Wayland): ``wl_display`` for the display. + +- Android: ``EGLDisplay`` for the display. + +.. _class_DisplayServer_constant_WINDOW_HANDLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`HandleType` **WINDOW_HANDLE** = ``1`` + +Window handle: + +- Windows: ``HWND`` for the window. + +- Linux (X11): ``X11::Window*`` for the window. + +- Linux (Wayland): ``wl_surface`` for the window. + +- macOS: ``NSWindow*`` for the window. + +- iOS: ``UIViewController*`` for the view controller. + +- Android: ``jObject`` for the activity. + +.. _class_DisplayServer_constant_WINDOW_VIEW: + +.. rst-class:: classref-enumeration-constant + +:ref:`HandleType` **WINDOW_VIEW** = ``2`` + +Window view: + +- Windows: ``HDC`` for the window (only with the Compatibility renderer). + +- macOS: ``NSView*`` for the window main view. + +- iOS: ``UIView*`` for the window main view. + +.. _class_DisplayServer_constant_OPENGL_CONTEXT: + +.. rst-class:: classref-enumeration-constant + +:ref:`HandleType` **OPENGL_CONTEXT** = ``3`` + +OpenGL context (only with the Compatibility renderer): + +- Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE). + +- Linux (X11): ``GLXContext*`` for the window. + +- Linux (Wayland): ``EGLContext`` for the window. + +- macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE). + +- Android: ``EGLContext`` for the window. + +.. _class_DisplayServer_constant_EGL_DISPLAY: + +.. rst-class:: classref-enumeration-constant + +:ref:`HandleType` **EGL_DISPLAY** = ``4`` + +- Windows: ``EGLDisplay`` for the window (ANGLE). + +- macOS: ``EGLDisplay`` for the window (ANGLE). + +- Linux (Wayland): ``EGLDisplay`` for the window. + +.. _class_DisplayServer_constant_EGL_CONFIG: + +.. rst-class:: classref-enumeration-constant + +:ref:`HandleType` **EGL_CONFIG** = ``5`` + +- Windows: ``EGLConfig`` for the window (ANGLE). + +- macOS: ``EGLConfig`` for the window (ANGLE). + +- Linux (Wayland): ``EGLConfig`` for the window. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_DisplayServer_TTSUtteranceEvent: + +.. rst-class:: classref-enumeration + +enum **TTSUtteranceEvent**: :ref:`🔗` + +.. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED: + +.. rst-class:: classref-enumeration-constant + +:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_STARTED** = ``0`` + +Utterance has begun to be spoken. + +.. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED: + +.. rst-class:: classref-enumeration-constant + +:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_ENDED** = ``1`` + +Utterance was successfully finished. + +.. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED: + +.. rst-class:: classref-enumeration-constant + +:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_CANCELED** = ``2`` + +Utterance was canceled, or TTS service was unable to process it. + +.. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY: + +.. rst-class:: classref-enumeration-constant + +:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_BOUNDARY** = ``3`` + +Utterance reached a word or sentence boundary. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Constants +--------- + +.. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS: + +.. rst-class:: classref-constant + +**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`🔗` + +Represents the screen containing the mouse pointer. + +\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. + +.. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS: + +.. rst-class:: classref-constant + +**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`🔗` + +Represents the screen containing the window with the keyboard focus. + +\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. + +.. _class_DisplayServer_constant_SCREEN_PRIMARY: + +.. rst-class:: classref-constant + +**SCREEN_PRIMARY** = ``-2`` :ref:`🔗` + +Represents the primary screen. + +\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. + +.. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW: + +.. rst-class:: classref-constant + +**SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`🔗` + +Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens. + +\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. + +.. _class_DisplayServer_constant_MAIN_WINDOW_ID: + +.. rst-class:: classref-constant + +**MAIN_WINDOW_ID** = ``0`` :ref:`🔗` + +The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``. + +.. _class_DisplayServer_constant_INVALID_WINDOW_ID: + +.. rst-class:: classref-constant + +**INVALID_WINDOW_ID** = ``-1`` :ref:`🔗` + +The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result. + +.. _class_DisplayServer_constant_INVALID_INDICATOR_ID: + +.. rst-class:: classref-constant + +**INVALID_INDICATOR_ID** = ``-1`` :ref:`🔗` + +The ID that refers to a nonexistent application status indicator. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_DisplayServer_method_accessibility_create_element: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_create_element**\ (\ window_id\: :ref:`int`, role\: :ref:`AccessibilityRole`\ ) :ref:`🔗` + +Creates a new, empty accessibility element resource. + +\ **Note:** An accessibility element is created and freed automatically for each :ref:`Node`. In general, this function should not be called manually. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_create_sub_element: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_create_sub_element**\ (\ parent_rid\: :ref:`RID`, role\: :ref:`AccessibilityRole`, insert_pos\: :ref:`int` = -1\ ) :ref:`🔗` + +Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not :ref:`Node`\ s, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the :ref:`accessibility_free_element()` method. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_create_sub_text_edit_elements: + +.. 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:`🔗` + +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. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_element_get_meta: + +.. rst-class:: classref-method + +:ref:`Variant` **accessibility_element_get_meta**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns the metadata of the accessibility element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_element_set_meta: + +.. rst-class:: classref-method + +|void| **accessibility_element_set_meta**\ (\ id\: :ref:`RID`, meta\: :ref:`Variant`\ ) :ref:`🔗` + +Sets the metadata of the accessibility element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_free_element: + +.. rst-class:: classref-method + +|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()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_get_window_root: + +.. rst-class:: classref-method + +:ref:`RID` **accessibility_get_window_root**\ (\ window_id\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the main accessibility element of the OS native window. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_has_element: + +.. rst-class:: classref-method + +:ref:`bool` **accessibility_has_element**\ (\ id\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns ``true`` if ``id`` is a valid accessibility element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_screen_reader_active: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_screen_reader_active**\ (\ ) |const| :ref:`🔗` + +Returns ``1`` if a screen reader, Braille display or other assistive app is active, ``0`` otherwise. Returns ``-1`` if status is unknown. + +\ **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``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_set_window_focused: + +.. rst-class:: classref-method + +|void| **accessibility_set_window_focused**\ (\ window_id\: :ref:`int`, focused\: :ref:`bool`\ ) :ref:`🔗` + +Sets the window focused state for assistive apps. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Advanced users only! :ref:`Window` objects call this method automatically. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_set_window_rect: + +.. rst-class:: classref-method + +|void| **accessibility_set_window_rect**\ (\ window_id\: :ref:`int`, rect_out\: :ref:`Rect2`, rect_in\: :ref:`Rect2`\ ) :ref:`🔗` + +Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** Advanced users only! :ref:`Window` objects call this method automatically. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_should_increase_contrast: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_should_increase_contrast**\ (\ ) |const| :ref:`🔗` + +Returns ``1`` if a high-contrast user interface theme should be used, ``0`` otherwise. Returns ``-1`` if status is unknown. + +\ **Note:** This method is implemented on Linux (X11/Wayland, GNOME), macOS, and Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_should_reduce_animation: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_should_reduce_animation**\ (\ ) |const| :ref:`🔗` + +Returns ``1`` if flashing, blinking, and other moving content that can cause seizures in users with photosensitive epilepsy should be disabled, ``0`` otherwise. Returns ``-1`` if status is unknown. + +\ **Note:** This method is implemented on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_should_reduce_transparency: + +.. rst-class:: classref-method + +:ref:`int` **accessibility_should_reduce_transparency**\ (\ ) |const| :ref:`🔗` + +Returns ``1`` if background images, transparency, and other features that can reduce the contrast between the foreground and background should be disabled, ``0`` otherwise. Returns ``-1`` if status is unknown. + +\ **Note:** This method is implemented on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_action: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_action**\ (\ id\: :ref:`RID`, action\: :ref:`AccessibilityAction`, callable\: :ref:`Callable`\ ) :ref:`🔗` + +Adds a callback for the accessibility action (action which can be performed by using a special screen reader command or buttons on the Braille display), and marks this action as supported. The action callback receives one :ref:`Variant` argument, which value depends on action type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_child: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_child**\ (\ id\: :ref:`RID`, child_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds a child accessibility element. + +\ **Note:** :ref:`Node` children and sub-elements are added to the child list automatically. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_custom_action: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_custom_action**\ (\ id\: :ref:`RID`, action_id\: :ref:`int`, action_description\: :ref:`String`\ ) :ref:`🔗` + +Adds support for a custom accessibility action. ``action_id`` is passed as an argument to the callback of :ref:`ACTION_CUSTOM` action. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_controls: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_controls**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that is controlled by this element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_described_by: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_described_by**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that describes this element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_details: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_details**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that details this element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_flow_to: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_flow_to**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that this element flow into. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_labeled_by: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_labeled_by**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that labels this element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_add_related_radio_group: + +.. rst-class:: classref-method + +|void| **accessibility_update_add_related_radio_group**\ (\ id\: :ref:`RID`, related_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that is part of the same radio group. + +\ **Note:** This method should be called on each element of the group, using all other elements as ``related_id``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_active_descendant: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_active_descendant**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +Adds an element that is an active descendant of this element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_background_color: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_background_color**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` + +Sets element background color. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_bounds: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_bounds**\ (\ id\: :ref:`RID`, p_rect\: :ref:`Rect2`\ ) :ref:`🔗` + +Sets element bounding box, relative to the node position. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_checked: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_checked**\ (\ id\: :ref:`RID`, checekd\: :ref:`bool`\ ) :ref:`🔗` + +Sets element checked state. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_classname: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_classname**\ (\ id\: :ref:`RID`, classname\: :ref:`String`\ ) :ref:`🔗` + +Sets element class name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_color_value: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_color_value**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` + +Sets element color value. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_description: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` + +Sets element accessibility description. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_error_message: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_error_message**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +Sets an element which contains an error message for this element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_extra_info: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_extra_info**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` + +Sets element accessibility extra information added to the element name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_flag: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_flag**\ (\ id\: :ref:`RID`, flag\: :ref:`AccessibilityFlags`, value\: :ref:`bool`\ ) :ref:`🔗` + +Sets element flag, see :ref:`AccessibilityFlags`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_focus: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_focus**\ (\ id\: :ref:`RID`\ ) :ref:`🔗` + +Sets currently focused element. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_foreground_color: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_foreground_color**\ (\ id\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` + +Sets element foreground color. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_in_page_link_target: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_in_page_link_target**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +Sets target element for the link. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_language: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_language**\ (\ id\: :ref:`RID`, language\: :ref:`String`\ ) :ref:`🔗` + +Sets element text language. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_count: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_count**\ (\ id\: :ref:`RID`, size\: :ref:`int`\ ) :ref:`🔗` + +Sets number of items in the list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_expanded: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_expanded**\ (\ id\: :ref:`RID`, expanded\: :ref:`bool`\ ) :ref:`🔗` + +Sets list/tree item expanded status. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_index: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` + +Sets the position of the element in the list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_level: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_level**\ (\ id\: :ref:`RID`, level\: :ref:`int`\ ) :ref:`🔗` + +Sets the hierarchical level of the element in the list. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_item_selected: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_item_selected**\ (\ id\: :ref:`RID`, selected\: :ref:`bool`\ ) :ref:`🔗` + +Sets list/tree item selected status. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_list_orientation: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_list_orientation**\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) :ref:`🔗` + +Sets the orientation of the list elements. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_live: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_live**\ (\ id\: :ref:`RID`, live\: :ref:`AccessibilityLiveMode`\ ) :ref:`🔗` + +Sets the priority of the live region updates. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_member_of: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_member_of**\ (\ id\: :ref:`RID`, group_id\: :ref:`RID`\ ) :ref:`🔗` + +Sets the element to be a member of the group. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_name: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_name**\ (\ id\: :ref:`RID`, name\: :ref:`String`\ ) :ref:`🔗` + +Sets element accessibility name. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_next_on_line: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_next_on_line**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` + +Sets next element on the line. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_jump: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_jump**\ (\ id\: :ref:`RID`, jump\: :ref:`float`\ ) :ref:`🔗` + +Sets numeric value jump. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_range: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` + +Sets numeric value range. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_step: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_step**\ (\ id\: :ref:`RID`, step\: :ref:`float`\ ) :ref:`🔗` + +Sets numeric value step. + +.. rst-class:: classref-item-separator + +---- + +.. _class_DisplayServer_method_accessibility_update_set_num_value: + +.. rst-class:: classref-method + +|void| **accessibility_update_set_num_value**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` + +Sets numeric value. + +.. rst-class:: classref-item-separator -Right edge of a window. +---- -.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT: +.. _class_DisplayServer_method_accessibility_update_set_placeholder: -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-method -:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM_LEFT** = ``5`` +|void| **accessibility_update_set_placeholder**\ (\ id\: :ref:`RID`, placeholder\: :ref:`String`\ ) :ref:`🔗` -Bottom-left edge of a window. +Sets placeholder text. -.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration-constant +---- -:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM** = ``6`` +.. _class_DisplayServer_method_accessibility_update_set_popup_type: -Bottom edge of a window. +.. rst-class:: classref-method -.. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT: +|void| **accessibility_update_set_popup_type**\ (\ id\: :ref:`RID`, popup\: :ref:`AccessibilityPopupType`\ ) :ref:`🔗` -.. rst-class:: classref-enumeration-constant +Sets popup type for popup buttons. -:ref:`WindowResizeEdge` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7`` +.. rst-class:: classref-item-separator -Bottom-right edge of a window. +---- -.. _class_DisplayServer_constant_WINDOW_EDGE_MAX: +.. _class_DisplayServer_method_accessibility_update_set_previous_on_line: -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-method -:ref:`WindowResizeEdge` **WINDOW_EDGE_MAX** = ``8`` +|void| **accessibility_update_set_previous_on_line**\ (\ id\: :ref:`RID`, other_id\: :ref:`RID`\ ) :ref:`🔗` -Represents the size of the :ref:`WindowResizeEdge` enum. +Sets previous element on the line. .. rst-class:: classref-item-separator ---- -.. _enum_DisplayServer_VSyncMode: +.. _class_DisplayServer_method_accessibility_update_set_role: -.. rst-class:: classref-enumeration +.. rst-class:: classref-method -enum **VSyncMode**: :ref:`🔗` +|void| **accessibility_update_set_role**\ (\ id\: :ref:`RID`, role\: :ref:`AccessibilityRole`\ ) :ref:`🔗` -.. _class_DisplayServer_constant_VSYNC_DISABLED: +Sets element accessibility role. -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-item-separator -:ref:`VSyncMode` **VSYNC_DISABLED** = ``0`` +---- -No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps`). +.. _class_DisplayServer_method_accessibility_update_set_role_description: -.. _class_DisplayServer_constant_VSYNC_ENABLED: +.. rst-class:: classref-method -.. rst-class:: classref-enumeration-constant +|void| **accessibility_update_set_role_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` -:ref:`VSyncMode` **VSYNC_ENABLED** = ``1`` +Sets element accessibility role description text. -Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps`). +.. rst-class:: classref-item-separator -.. _class_DisplayServer_constant_VSYNC_ADAPTIVE: +---- -.. rst-class:: classref-enumeration-constant +.. _class_DisplayServer_method_accessibility_update_set_scroll_x: -:ref:`VSyncMode` **VSYNC_ADAPTIVE** = ``2`` +.. rst-class:: classref-method -Behaves like :ref:`VSYNC_DISABLED` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps`). Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. +|void| **accessibility_update_set_scroll_x**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` -.. _class_DisplayServer_constant_VSYNC_MAILBOX: +Sets scroll bar x position. -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-item-separator -:ref:`VSyncMode` **VSYNC_MAILBOX** = ``3`` +---- -Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps`). +.. _class_DisplayServer_method_accessibility_update_set_scroll_x_range: -Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX` works best when at least twice as many frames as the display refresh rate are rendered. Behaves like :ref:`VSYNC_ENABLED` when using the Compatibility rendering method. +.. rst-class:: classref-method -.. rst-class:: classref-item-separator +|void| **accessibility_update_set_scroll_x_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` ----- +Sets scroll bar x range. -.. _enum_DisplayServer_HandleType: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration +---- -enum **HandleType**: :ref:`🔗` +.. _class_DisplayServer_method_accessibility_update_set_scroll_y: -.. _class_DisplayServer_constant_DISPLAY_HANDLE: +.. rst-class:: classref-method -.. rst-class:: classref-enumeration-constant +|void| **accessibility_update_set_scroll_y**\ (\ id\: :ref:`RID`, position\: :ref:`float`\ ) :ref:`🔗` -:ref:`HandleType` **DISPLAY_HANDLE** = ``0`` +Sets scroll bar y position. -Display handle: +.. rst-class:: classref-item-separator -- Linux (X11): ``X11::Display*`` for the display. +---- -- Linux (Wayland): ``wl_display`` for the display. +.. _class_DisplayServer_method_accessibility_update_set_scroll_y_range: -- Android: ``EGLDisplay`` for the display. +.. rst-class:: classref-method -.. _class_DisplayServer_constant_WINDOW_HANDLE: +|void| **accessibility_update_set_scroll_y_range**\ (\ id\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`\ ) :ref:`🔗` -.. rst-class:: classref-enumeration-constant +Sets scroll bar y range. -:ref:`HandleType` **WINDOW_HANDLE** = ``1`` +.. rst-class:: classref-item-separator -Window handle: +---- -- Windows: ``HWND`` for the window. +.. _class_DisplayServer_method_accessibility_update_set_shortcut: -- Linux (X11): ``X11::Window*`` for the window. +.. rst-class:: classref-method -- Linux (Wayland): ``wl_surface`` for the window. +|void| **accessibility_update_set_shortcut**\ (\ id\: :ref:`RID`, shortcut\: :ref:`String`\ ) :ref:`🔗` -- macOS: ``NSWindow*`` for the window. +Sets the list of keyboard shortcuts used by element. -- iOS: ``UIViewController*`` for the view controller. +.. rst-class:: classref-item-separator -- Android: ``jObject`` for the activity. +---- -.. _class_DisplayServer_constant_WINDOW_VIEW: +.. _class_DisplayServer_method_accessibility_update_set_state_description: -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-method -:ref:`HandleType` **WINDOW_VIEW** = ``2`` +|void| **accessibility_update_set_state_description**\ (\ id\: :ref:`RID`, description\: :ref:`String`\ ) :ref:`🔗` -Window view: +Sets human-readable description of the current checked state. -- Windows: ``HDC`` for the window (only with the Compatibility renderer). +.. rst-class:: classref-item-separator -- macOS: ``NSView*`` for the window main view. +---- -- iOS: ``UIView*`` for the window main view. +.. _class_DisplayServer_method_accessibility_update_set_table_cell_position: -.. _class_DisplayServer_constant_OPENGL_CONTEXT: +.. rst-class:: classref-method -.. rst-class:: classref-enumeration-constant +|void| **accessibility_update_set_table_cell_position**\ (\ id\: :ref:`RID`, row_index\: :ref:`int`, column_index\: :ref:`int`\ ) :ref:`🔗` -:ref:`HandleType` **OPENGL_CONTEXT** = ``3`` +Sets cell position in the table. -OpenGL context (only with the Compatibility renderer): +.. rst-class:: classref-item-separator -- Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE). +---- -- Linux (X11): ``GLXContext*`` for the window. +.. _class_DisplayServer_method_accessibility_update_set_table_cell_span: -- Linux (Wayland): ``EGLContext`` for the window. +.. rst-class:: classref-method -- macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE). +|void| **accessibility_update_set_table_cell_span**\ (\ id\: :ref:`RID`, row_span\: :ref:`int`, column_span\: :ref:`int`\ ) :ref:`🔗` -- Android: ``EGLContext`` for the window. +Sets cell row/column span. -.. _class_DisplayServer_constant_EGL_DISPLAY: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration-constant +---- -:ref:`HandleType` **EGL_DISPLAY** = ``4`` +.. _class_DisplayServer_method_accessibility_update_set_table_column_count: -- Windows: ``EGLDisplay`` for the window (ANGLE). +.. rst-class:: classref-method -- macOS: ``EGLDisplay`` for the window (ANGLE). +|void| **accessibility_update_set_table_column_count**\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` -- Linux (Wayland): ``EGLDisplay`` for the window. +Sets number of columns in the table. -.. _class_DisplayServer_constant_EGL_CONFIG: +.. rst-class:: classref-item-separator -.. rst-class:: classref-enumeration-constant +---- -:ref:`HandleType` **EGL_CONFIG** = ``5`` +.. _class_DisplayServer_method_accessibility_update_set_table_column_index: -- Windows: ``EGLConfig`` for the window (ANGLE). +.. rst-class:: classref-method -- macOS: ``EGLConfig`` for the window (ANGLE). +|void| **accessibility_update_set_table_column_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` -- Linux (Wayland): ``EGLConfig`` for the window. +Sets position of the column. .. rst-class:: classref-item-separator ---- -.. _enum_DisplayServer_TTSUtteranceEvent: +.. _class_DisplayServer_method_accessibility_update_set_table_row_count: -.. rst-class:: classref-enumeration +.. rst-class:: classref-method -enum **TTSUtteranceEvent**: :ref:`🔗` +|void| **accessibility_update_set_table_row_count**\ (\ id\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` -.. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED: +Sets number of rows in the table. -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-item-separator -:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_STARTED** = ``0`` +---- -Utterance has begun to be spoken. +.. _class_DisplayServer_method_accessibility_update_set_table_row_index: -.. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED: +.. rst-class:: classref-method -.. rst-class:: classref-enumeration-constant +|void| **accessibility_update_set_table_row_index**\ (\ id\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` -:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_ENDED** = ``1`` +Sets position of the row in the table. -Utterance was successfully finished. +.. rst-class:: classref-item-separator -.. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED: +---- -.. rst-class:: classref-enumeration-constant +.. _class_DisplayServer_method_accessibility_update_set_text_align: -:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_CANCELED** = ``2`` +.. rst-class:: classref-method -Utterance was canceled, or TTS service was unable to process it. +|void| **accessibility_update_set_text_align**\ (\ id\: :ref:`RID`, align\: :ref:`HorizontalAlignment`\ ) :ref:`🔗` -.. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY: +Sets element text alignment. -.. rst-class:: classref-enumeration-constant +.. rst-class:: classref-item-separator -:ref:`TTSUtteranceEvent` **TTS_UTTERANCE_BOUNDARY** = ``3`` +---- -Utterance reached a word or sentence boundary. +.. _class_DisplayServer_method_accessibility_update_set_text_decorations: -.. rst-class:: classref-section-separator +.. rst-class:: classref-method ----- +|void| **accessibility_update_set_text_decorations**\ (\ id\: :ref:`RID`, underline\: :ref:`bool`, strikethrough\: :ref:`bool`, overline\: :ref:`bool`\ ) :ref:`🔗` -.. rst-class:: classref-descriptions-group +Sets text underline/overline/strikethrough. -Constants ---------- +.. rst-class:: classref-item-separator -.. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS: +---- -.. rst-class:: classref-constant +.. _class_DisplayServer_method_accessibility_update_set_text_orientation: -**SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`🔗` +.. rst-class:: classref-method -Represents the screen containing the mouse pointer. +|void| **accessibility_update_set_text_orientation**\ (\ id\: :ref:`RID`, vertical\: :ref:`bool`\ ) :ref:`🔗` -\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. +Sets text orientation. -.. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS: +.. rst-class:: classref-item-separator -.. rst-class:: classref-constant +---- -**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`🔗` +.. _class_DisplayServer_method_accessibility_update_set_text_selection: -Represents the screen containing the window with the keyboard focus. +.. rst-class:: classref-method -\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. +|void| **accessibility_update_set_text_selection**\ (\ id\: :ref:`RID`, text_start_id\: :ref:`RID`, start_char\: :ref:`int`, text_end_id\: :ref:`RID`, end_char\: :ref:`int`\ ) :ref:`🔗` -.. _class_DisplayServer_constant_SCREEN_PRIMARY: +Sets text selection to the text field. ``text_start_id`` and ``text_end_id`` should be elements created by :ref:`accessibility_create_sub_text_edit_elements()`. Character offsets are relative to the corresponding element. -.. rst-class:: classref-constant +.. rst-class:: classref-item-separator -**SCREEN_PRIMARY** = ``-2`` :ref:`🔗` +---- -Represents the primary screen. +.. _class_DisplayServer_method_accessibility_update_set_tooltip: -\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. +.. rst-class:: classref-method -.. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW: +|void| **accessibility_update_set_tooltip**\ (\ id\: :ref:`RID`, tooltip\: :ref:`String`\ ) :ref:`🔗` -.. rst-class:: classref-constant +Sets tooltip text. -**SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`🔗` +.. rst-class:: classref-item-separator -Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens. +---- -\ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``. +.. _class_DisplayServer_method_accessibility_update_set_transform: -.. _class_DisplayServer_constant_MAIN_WINDOW_ID: +.. rst-class:: classref-method -.. rst-class:: classref-constant +|void| **accessibility_update_set_transform**\ (\ id\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` -**MAIN_WINDOW_ID** = ``0`` :ref:`🔗` +Sets element 2D transform. -The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``. +.. rst-class:: classref-item-separator -.. _class_DisplayServer_constant_INVALID_WINDOW_ID: +---- -.. rst-class:: classref-constant +.. _class_DisplayServer_method_accessibility_update_set_url: -**INVALID_WINDOW_ID** = ``-1`` :ref:`🔗` +.. rst-class:: classref-method -The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result. +|void| **accessibility_update_set_url**\ (\ id\: :ref:`RID`, url\: :ref:`String`\ ) :ref:`🔗` -.. _class_DisplayServer_constant_INVALID_INDICATOR_ID: +Sets link URL. -.. rst-class:: classref-constant +.. rst-class:: classref-item-separator -**INVALID_INDICATOR_ID** = ``-1`` :ref:`🔗` +---- -The ID that refers to a nonexistent application status indicator. +.. _class_DisplayServer_method_accessibility_update_set_value: -.. rst-class:: classref-section-separator +.. rst-class:: classref-method ----- +|void| **accessibility_update_set_value**\ (\ id\: :ref:`RID`, value\: :ref:`String`\ ) :ref:`🔗` -.. rst-class:: classref-descriptions-group +Sets element text value. -Method Descriptions -------------------- +.. rst-class:: classref-item-separator + +---- .. _class_DisplayServer_method_beep: @@ -1806,6 +3724,24 @@ Sets the user's `primary ` **color_picker**\ (\ callback\: :ref:`Callable`\ ) :ref:`🔗` + +Displays OS native color picker. + +Callbacks have the following arguments: ``status: bool, color: Color``. + +\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_COLOR_PICKER` feature. + +\ **Note:** This method is only implemented on Linux (X11/Wayland). + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_create_status_indicator: .. rst-class:: classref-method @@ -1916,13 +3852,13 @@ Allows the ``process_id`` PID to steal focus from this window. In other words, t .. rst-class:: classref-method -:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`\ ) :ref:`🔗` +:ref:`Error` **file_dialog_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) :ref:`🔗` Displays OS native dialog for selecting files or directories in the file system. Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters`. -Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** callback argument ``selected_filter_index`` is always zero. +Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** the third callback argument (``selected_filter_index``) is always ``0``. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE` feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android. @@ -1944,7 +3880,7 @@ Callbacks have the following arguments: ``status: bool, selected_paths: PackedSt .. rst-class:: classref-method -:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`\ ) :ref:`🔗` +:ref:`Error` **file_dialog_with_options_show**\ (\ title\: :ref:`String`, current_directory\: :ref:`String`, root\: :ref:`String`, filename\: :ref:`String`, show_hidden\: :ref:`bool`, mode\: :ref:`FileDialogMode`, filters\: :ref:`PackedStringArray`, options\: :ref:`Array`\[:ref:`Dictionary`\], callback\: :ref:`Callable`, parent_window_id\: :ref:`int` = 0\ ) :ref:`🔗` Displays OS native dialog for selecting files or directories in the file system with additional user selectable options. @@ -1998,7 +3934,7 @@ Forces window manager processing while ignoring all :ref:`InputEvent` **has_hardware_keyboard**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if hardware keyboard is connected. +Returns ``true`` if a hardware keyboard is connected. -\ **Note:** This method is implemented on Android and iOS, on other platforms this method always returns ``true``. +\ **Note:** This method is implemented on Android and iOS. On other platforms, this method always returns ``true``. .. rst-class:: classref-item-separator @@ -3452,11 +5388,11 @@ Returns the dots per inch density of the specified screen. If ``screen`` is :ref :ref:`Image` **screen_get_image**\ (\ screen\: :ref:`int` = -1\ ) |const| :ref:`🔗` -Returns screenshot of the ``screen``. +Returns a screenshot of the ``screen``. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows. -\ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color. +\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application. .. rst-class:: classref-item-separator @@ -3468,11 +5404,11 @@ Returns screenshot of the ``screen``. :ref:`Image` **screen_get_image_rect**\ (\ rect\: :ref:`Rect2i`\ ) |const| :ref:`🔗` -Returns screenshot of the screen ``rect``. +Returns a screenshot of the screen region defined by ``rect``. \ **Note:** This method is implemented on macOS and Windows. -\ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color. +\ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application. .. rst-class:: classref-item-separator @@ -3651,6 +5587,20 @@ 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). + +\ **Note:** This method is only implemented on Android. + +.. rst-class:: classref-item-separator + +---- + .. _class_DisplayServer_method_set_icon: .. rst-class:: classref-method @@ -3865,8 +5815,6 @@ Note that Godot depends on system libraries for text-to-speech functionality. Th \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3881,8 +5829,6 @@ Returns an :ref:`PackedStringArray` of voice identifier \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3897,8 +5843,6 @@ Returns ``true`` if the synthesizer is in a paused state. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3913,8 +5857,6 @@ Returns ``true`` if the synthesizer is generating speech, or have utterance wait \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3929,8 +5871,6 @@ Puts the synthesizer into a paused state. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3945,8 +5885,6 @@ Resumes the synthesizer if it was paused. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3967,8 +5905,6 @@ Adds a callback, which is called when the utterance has started, finished, cance \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -3997,8 +5933,6 @@ Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is clear \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- @@ -4013,8 +5947,6 @@ Stops synthesis in progress and removes all utterances from the queue. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows. -\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech` should be ``true`` to use text-to-speech. - .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 6d3cce9ab59..d9571392c28 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -65,7 +65,7 @@ Methods +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_current_presets`\ (\ ) |const| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_forced_export_files`\ (\ ) |static| | + | :ref:`PackedStringArray` | :ref:`get_forced_export_files`\ (\ preset\: :ref:`EditorExportPreset`\ ) |static| | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_internal_export_files`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) | +-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -159,7 +159,7 @@ flags **DebugFlags**: :ref:`🔗` :ref:`DebugFlags` **DEBUG_FLAG_DUMB_CLIENT** = ``1`` -Flag is set if remotely debugged project is expected to use remote file system. If set, :ref:`gen_export_flags()` will add ``--remove-fs`` and ``--remote-fs-password`` (if password is set in the editor settings) command line arguments to the list. +Flag is set if remotely debugged project is expected to use remote file system. If set, :ref:`gen_export_flags()` will add ``--remote-fs`` and ``--remote-fs-password`` (if password is set in the editor settings) command line arguments to the list. .. _class_EditorExportPlatform_constant_DEBUG_FLAG_REMOTE_DEBUG: @@ -288,7 +288,7 @@ Exports project files for the specified preset. This method can be used to imple \ ``shared_cb`` is called for exported native shared/static libraries and have the following arguments: ``file_path: String``, ``tags: PackedStringArray``, ``target_folder: String``. -\ **Note:** ``file_index`` and ``file_count`` are intended for progress tracking only and aren't necesserely unique and precise. +\ **Note:** ``file_index`` and ``file_count`` are intended for progress tracking only and aren't necessarily unique and precise. .. rst-class:: classref-item-separator @@ -360,7 +360,7 @@ Returns array of :ref:`EditorExportPreset`\ s for this .. rst-class:: classref-method -:ref:`PackedStringArray` **get_forced_export_files**\ (\ ) |static| :ref:`🔗` +:ref:`PackedStringArray` **get_forced_export_files**\ (\ preset\: :ref:`EditorExportPreset`\ ) |static| :ref:`🔗` Returns array of core file names that always should be exported regardless of preset config. diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 02993a6258a..d9e204dae5b 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -2788,7 +2788,7 @@ Allows an application to write to the user dictionary. :ref:`bool` **screen/immersive_mode** :ref:`🔗` -If ``true``, hides navigation and status bar. See :ref:`DisplayServer.window_set_mode()` to toggle it at runtime. +If ``true``, hides the navigation and status bar. Set :ref:`DisplayServer.window_set_mode()` to change this at runtime. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index fdca9c04508..03e75841379 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -878,7 +878,7 @@ Additional data added to the root ```` section of the `.entitlements ` **entitlements/game_center** :ref:`🔗` -Enable to allow access to Game Center features. `com.apple.developer.game-center `__. +If ``true``, allows access to Game Center features. See `com.apple.developer.game-center `__. .. rst-class:: classref-item-separator @@ -890,7 +890,7 @@ Enable to allow access to Game Center features. `com.apple.developer.game-center :ref:`bool` **entitlements/increased_memory_limit** :ref:`🔗` -Enable if app may perform better with a higher memory limit. `com.apple.developer.kernel.increased-memory-limit `__. +If ``true``, hints that the app might perform better with a higher memory limit. See `com.apple.developer.kernel.increased-memory-limit `__. .. rst-class:: classref-item-separator diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index e4804ea0427..826c8a1f3d9 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -87,6 +87,8 @@ Methods +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_supports_platform`\ (\ platform\: :ref:`EditorExportPlatform`\ ) |virtual| |const| | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`_update_android_prebuilt_manifest`\ (\ platform\: :ref:`EditorExportPlatform`, manifest_data\: :ref:`PackedByteArray`\ ) |virtual| |const| | + +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_file`\ (\ path\: :ref:`String`, file\: :ref:`PackedByteArray`, remap\: :ref:`bool`\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_ios_bundle_file`\ (\ path\: :ref:`String`\ ) | @@ -495,6 +497,22 @@ Return ``true`` if the plugin supports the given ``platform``. ---- +.. _class_EditorExportPlugin_private_method__update_android_prebuilt_manifest: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **_update_android_prebuilt_manifest**\ (\ platform\: :ref:`EditorExportPlatform`, manifest_data\: :ref:`PackedByteArray`\ ) |virtual| |const| :ref:`🔗` + +Provide access to the Android prebuilt manifest and allows the plugin to modify it if needed. + +Implementers of this virtual method should take the binary manifest data from ``manifest_data``, copy it, modify it, and then return it with the modifications. + +If no modifications are needed, then an empty :ref:`PackedByteArray` should be returned. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_method_add_file: .. rst-class:: classref-method diff --git a/classes/class_editorexportpreset.rst b/classes/class_editorexportpreset.rst index 548d74389f8..eb14fe87848 100644 --- a/classes/class_editorexportpreset.rst +++ b/classes/class_editorexportpreset.rst @@ -66,6 +66,8 @@ Methods +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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| | @@ -273,7 +275,7 @@ Method Descriptions :ref:`bool` **are_advanced_options_enabled**\ (\ ) |const| :ref:`🔗` -Returns ``true``, is "Advanced" toggle is enabled in the export dialog. +Returns ``true`` if "Advanced" toggle is enabled in the export dialog. .. rst-class:: classref-item-separator @@ -297,7 +299,7 @@ Returns string with a comma separated list of custom features. :ref:`Dictionary` **get_customized_files**\ (\ ) |const| :ref:`🔗` -Returns :ref:`Dictionary` of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - ``"strip``, ``"keep"``, or ``"remove"``. See also :ref:`get_file_export_mode()`. +Returns :ref:`Dictionary` of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - ``"strip"``, ``"keep"``, or ``"remove"``. See also :ref:`get_file_export_mode()`. .. rst-class:: classref-item-separator @@ -321,7 +323,7 @@ Returns number of files selected in the "Resources" tab of the export dialog. :ref:`bool` **get_encrypt_directory**\ (\ ) |const| :ref:`🔗` -Returns ``true``, PCK directory encryption is enabled in the export dialog. +Returns ``true`` if PCK directory encryption is enabled in the export dialog. .. rst-class:: classref-item-separator @@ -333,7 +335,7 @@ Returns ``true``, PCK directory encryption is enabled in the export dialog. :ref:`bool` **get_encrypt_pck**\ (\ ) |const| :ref:`🔗` -Returns ``true``, PCK encryption is enabled in the export dialog. +Returns ``true`` if PCK encryption is enabled in the export dialog. .. rst-class:: classref-item-separator @@ -483,6 +485,18 @@ Returns export preset name. ---- +.. _class_EditorExportPreset_method_get_project_setting: + +.. rst-class:: classref-method + +:ref:`Variant` **get_project_setting**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` + +Returns the value of the setting identified by ``name`` using export preset feature tag overrides instead of current OS features. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPreset_method_get_script_export_mode: .. rst-class:: classref-method @@ -515,7 +529,7 @@ If ``windows_version`` is ``true``, formats the returned version number to be co :ref:`bool` **has**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` -Returns ``true`` if preset has specified property. +Returns ``true`` if the preset has the property named ``property``. .. rst-class:: classref-item-separator diff --git a/classes/class_editorinspector.rst b/classes/class_editorinspector.rst index 1f58b3d3605..c5c24ab46f6 100644 --- a/classes/class_editorinspector.rst +++ b/classes/class_editorinspector.rst @@ -44,6 +44,8 @@ Properties +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ + | :ref:`bool` | follow_focus | ``true`` (overrides :ref:`ScrollContainer`) | + +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`ScrollMode` | horizontal_scroll_mode | ``0`` (overrides :ref:`ScrollContainer`) | +----------------------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+ diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 1d1ecf41b74..ef4a9c0821f 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -100,6 +100,8 @@ Methods +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorInspector` | :ref:`get_inspector`\ (\ ) |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_open_scene_roots`\ (\ ) |const| | + +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_open_scenes`\ (\ ) |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_playing_scene`\ (\ ) |const| | @@ -373,7 +375,7 @@ Returns the :ref:`EditorPaths` singleton. Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins. -\ **Note:** This value is set via the ``interface/editor/display_scale`` and ``interface/editor/custom_display_scale`` editor settings. Editor must be restarted for changes to be properly applied. +\ **Note:** This value is set via the :ref:`EditorSettings.interface/editor/display_scale` and :ref:`EditorSettings.interface/editor/custom_display_scale` settings. The editor must be restarted for changes to be properly applied. .. rst-class:: classref-item-separator @@ -481,13 +483,25 @@ Returns the editor's :ref:`EditorInspector` instance. ---- +.. _class_EditorInterface_method_get_open_scene_roots: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Node`\] **get_open_scene_roots**\ (\ ) |const| :ref:`🔗` + +Returns an array with references to the root nodes of the currently opened scenes. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorInterface_method_get_open_scenes: .. rst-class:: classref-method :ref:`PackedStringArray` **get_open_scenes**\ (\ ) |const| :ref:`🔗` -Returns an :ref:`Array` with the file paths of the currently opened scenes. +Returns an array with the file paths of the currently opened scenes. .. rst-class:: classref-item-separator @@ -943,7 +957,7 @@ A feature profile can be created programmatically using the :ref:`EditorFeatureP |void| **set_main_screen_editor**\ (\ name\: :ref:`String`\ ) :ref:`🔗` -Sets the editor's current main screen to the one specified in ``name``. ``name`` must match the title of the tab in question exactly (e.g. ``2D``, ``3D``, ``Script``, or ``AssetLib`` for default tabs). +Sets the editor's current main screen to the one specified in ``name``. ``name`` must match the title of the tab in question exactly (e.g. ``2D``, ``3D``, ``Script``, ``Game``, or ``AssetLib`` for default tabs). .. rst-class:: classref-item-separator diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index a8b84f37978..9f90a83a8c4 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -203,7 +203,7 @@ Signals **main_screen_changed**\ (\ screen_name\: :ref:`String`\ ) :ref:`🔗` -Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib**). Also works with custom screens defined by plugins. +Emitted when user changes the workspace (**2D**, **3D**, **Script**, **Game**, **AssetLib**). Also works with custom screens defined by plugins. .. rst-class:: classref-item-separator @@ -587,7 +587,7 @@ Called by the engine when the user enables the **EditorPlugin** in the Plugin ta |void| **_forward_3d_draw_over_viewport**\ (\ viewport_control\: :ref:`Control`\ ) |virtual| :ref:`🔗` -Called by the engine when the 3D editor's viewport is updated. Use the ``overlay`` :ref:`Control` for drawing. You can update the viewport manually by calling :ref:`update_overlays()`. +Called by the engine when the 3D editor's viewport is updated. ``viewport_control`` is an overlay on top of the viewport and it can be used for drawing. You can update the viewport manually by calling :ref:`update_overlays()`. .. tabs:: @@ -595,12 +595,12 @@ Called by the engine when the 3D editor's viewport is updated. Use the ``overlay .. code-tab:: gdscript func _forward_3d_draw_over_viewport(overlay): - # Draw a circle at cursor position. + # Draw a circle at the cursor's position. overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.WHITE) func _forward_3d_gui_input(camera, event): if event is InputEventMouseMotion: - # Redraw viewport when cursor is moved. + # Redraw the viewport when the cursor is moved. update_overlays() return EditorPlugin.AFTER_GUI_INPUT_STOP return EditorPlugin.AFTER_GUI_INPUT_PASS @@ -609,7 +609,7 @@ Called by the engine when the 3D editor's viewport is updated. Use the ``overlay public override void _Forward3DDrawOverViewport(Control viewportControl) { - // Draw a circle at cursor position. + // Draw a circle at the cursor's position. viewportControl.DrawCircle(viewportControl.GetLocalMousePosition(), 64, Colors.White); } @@ -617,7 +617,7 @@ Called by the engine when the 3D editor's viewport is updated. Use the ``overlay { if (@event is InputEventMouseMotion) { - // Redraw viewport when cursor is moved. + // Redraw the viewport when the cursor is moved. UpdateOverlays(); return EditorPlugin.AfterGuiInput.Stop; } @@ -702,7 +702,7 @@ This method must return :ref:`AFTER_GUI_INPUT_PASS`\ ) |virtual| :ref:`🔗` -Called by the engine when the 2D editor's viewport is updated. Use the ``overlay`` :ref:`Control` for drawing. You can update the viewport manually by calling :ref:`update_overlays()`. +Called by the engine when the 2D editor's viewport is updated. ``viewport_control`` is an overlay on top of the viewport and it can be used for drawing. You can update the viewport manually by calling :ref:`update_overlays()`. .. tabs:: @@ -710,12 +710,12 @@ Called by the engine when the 2D editor's viewport is updated. Use the ``overlay .. code-tab:: gdscript func _forward_canvas_draw_over_viewport(overlay): - # Draw a circle at cursor position. + # Draw a circle at the cursor's position. overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.WHITE) func _forward_canvas_gui_input(event): if event is InputEventMouseMotion: - # Redraw viewport when cursor is moved. + # Redraw the viewport when the cursor is moved. update_overlays() return true return false @@ -724,7 +724,7 @@ Called by the engine when the 2D editor's viewport is updated. Use the ``overlay public override void _ForwardCanvasDrawOverViewport(Control viewportControl) { - // Draw a circle at cursor position. + // Draw a circle at the cursor's position. viewportControl.DrawCircle(viewportControl.GetLocalMousePosition(), 64, Colors.White); } @@ -732,7 +732,7 @@ Called by the engine when the 2D editor's viewport is updated. Use the ``overlay { if (@event is InputEventMouseMotion) { - // Redraw viewport when cursor is moved. + // Redraw the viewport when the cursor is moved. UpdateOverlays(); return true; } @@ -837,7 +837,7 @@ This is for editors that edit script-based objects. You can return a list of bre Override this method in your plugin to return a :ref:`Texture2D` in order to give it an icon. -For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. +For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", "Game", and "AssetLib" buttons. Ideally, the plugin icon should be white with a transparent background and 16×16 pixels in size. @@ -876,7 +876,7 @@ Ideally, the plugin icon should be white with a transparent background and 16×1 Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. -For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. +For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", "Game", and "AssetLib" buttons. .. rst-class:: classref-item-separator @@ -984,7 +984,7 @@ Implement this function if your plugin edits a specific type of object (Resource :ref:`bool` **_has_main_screen**\ (\ ) |virtual| |const| :ref:`🔗` -Returns ``true`` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script** and **AssetLib**). +Returns ``true`` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script**, **Game**, and **AssetLib**). When the plugin's workspace is selected, other main screen plugins will be hidden, but your plugin will not appear automatically. It needs to be added as a child of :ref:`EditorInterface.get_editor_main_screen()` and made visible inside :ref:`_make_visible()`. @@ -1147,7 +1147,7 @@ If the dock is repositioned and as long as the plugin is active, the editor will When your plugin is deactivated, make sure to remove your custom control with :ref:`remove_control_from_docks()` and free it with :ref:`Node.queue_free()`. -Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the dock's visibility once it's moved to the bottom panel (this shortcut does not affect the dock otherwise). See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use :kbd:`Alt` modifier. +Optionally, you can specify a shortcut parameter. When pressed, this shortcut will open and focus the dock. .. rst-class:: classref-item-separator diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 6b2d7f1a046..fccb6deb640 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -29,31 +29,33 @@ Properties .. table:: :widths: auto - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`checkable` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`checked` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`deletable` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_background` | ``true`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_label` | ``true`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`draw_warning` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`keying` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`label` | ``""`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`float` | :ref:`name_split_ratio` | ``0.5`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`read_only` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`selectable` | ``true`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`use_folding` | ``false`` | - +-----------------------------+-------------------------------------------------------------------------+-----------+ + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`checkable` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`checked` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`deletable` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_background` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_label` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`draw_warning` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`keying` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`String` | :ref:`label` | ``""`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | :ref:`name_split_ratio` | ``0.5`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`read_only` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`selectable` | ``true`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`use_folding` | ``false`` | + +------------------------------------------+-------------------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_editorsceneformatimporterblend.rst b/classes/class_editorsceneformatimporterblend.rst index 8ca766ca3a8..12fe9ed53d4 100644 --- a/classes/class_editorsceneformatimporterblend.rst +++ b/classes/class_editorsceneformatimporterblend.rst @@ -21,7 +21,7 @@ Description Imports Blender scenes in the ``.blend`` file format through the glTF 2.0 3D import pipeline. This importer requires Blender to be installed by the user, so that it can be used to export the scene as glTF 2.0. -The location of the Blender binary is set via the ``filesystem/import/blender/blender_path`` editor setting. +The location of the Blender binary is set via the :ref:`EditorSettings.filesystem/import/blender/blender_path` setting. This importer is only used if :ref:`ProjectSettings.filesystem/import/blender/enabled` is enabled, otherwise ``.blend`` files present in the project folder are not imported. diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index c4d9581ea9b..fe15b9cae6b 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -38,6 +38,8 @@ Methods +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Node`\] | :ref:`get_selected_nodes`\ (\ ) | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Node`\] | :ref:`get_top_selected_nodes`\ (\ ) | + +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Node`\] | :ref:`get_transformable_selected_nodes`\ (\ ) | +------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_node`\ (\ node\: :ref:`Node`\ ) | @@ -107,13 +109,29 @@ Returns the list of selected nodes. ---- +.. _class_EditorSelection_method_get_top_selected_nodes: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Node`\] **get_top_selected_nodes**\ (\ ) :ref:`🔗` + +Returns the list of top selected nodes only, excluding any children. This is useful for performing transform operations (moving them, rotating, etc.). + +For example, if there is a node A with a child B and a sibling C, then selecting all three will cause this method to return only A and C. Changing the global transform of A will affect the global transform of B, so there is no need to change B separately. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSelection_method_get_transformable_selected_nodes: .. rst-class:: classref-method :ref:`Array`\[:ref:`Node`\] **get_transformable_selected_nodes**\ (\ ) :ref:`🔗` -Returns the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc.). This list can be used to avoid situations where a node is selected and is also a child/grandchild. +**Deprecated:** Use :ref:`get_top_selected_nodes()` instead. + +Returns the list of top selected nodes only, excluding any children. This is useful for performing transform operations (moving them, rotating, etc.). See :ref:`get_top_selected_nodes()`. .. rst-class:: classref-item-separator diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index ff320979d4f..fa0a2e82d74 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -65,6 +65,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debugger/auto_switch_to_stack_trace` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`debugger/max_node_selection` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debugger/profile_native_calls` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`debugger/profiler_frame_history_size` | @@ -89,6 +91,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`docks/property_editor/subresource_hue_tint` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`docks/scene_tree/accessibility_warnings` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/ask_before_deleting_related_animation_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`docks/scene_tree/ask_before_revoking_unique_name` | @@ -127,6 +131,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/2d/zoom_speed_factor` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`editors/3d/active_selection_box_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/3d/default_fov` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`editors/3d/default_z_far` | @@ -267,10 +273,16 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/confirm_insert_track` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`editors/animation/default_animation_step` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/default_create_bezier_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`editors/animation/default_create_reset_tracks` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`editors/animation/default_fps_compatibility` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`editors/animation/default_fps_mode` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/animation/onion_layers_future_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`editors/animation/onion_layers_past_color` | @@ -487,6 +499,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/single_window_mode` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`interface/editor/tablet_driver` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/ui_layout_direction` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/unfocused_low_processor_mode_sleep_usec` | @@ -585,6 +599,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/touchscreen/enable_pan_and_scale_gestures` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`interface/touchscreen/enable_touch_actions_panel` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/touchscreen/increase_scrollbar_touch_area` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`interface/touchscreen/scale_gizmo_handles` | @@ -685,6 +701,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/convert_indent_on_save` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`text_editor/behavior/files/drop_preload_resources_as_uid` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/open_dominant_script_on_scene_change` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/behavior/files/restore_scripts_on_load` | @@ -857,6 +875,8 @@ Properties +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/user_type_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/warning_color` | + +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/word_highlighted_color` | +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`text_editor/theme/line_spacing` | @@ -991,6 +1011,20 @@ If ``true``, automatically switches to the **Stack Trace** panel when the debugg ---- +.. _class_EditorSettings_property_debugger/max_node_selection: + +.. rst-class:: classref-property + +:ref:`int` **debugger/max_node_selection** :ref:`🔗` + +The limit of how many remote nodes can be selected at once. + +\ **Warning:** Increasing this value is not recommended, as selecting too many can make the editing and inspection of remote properties unreliable. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_debugger/profile_native_calls: .. rst-class:: classref-property @@ -1139,6 +1173,18 @@ The tint intensity to use for the subresources background in the Inspector dock. ---- +.. _class_EditorSettings_property_docks/scene_tree/accessibility_warnings: + +.. rst-class:: classref-property + +:ref:`bool` **docks/scene_tree/accessibility_warnings** :ref:`🔗` + +If ``true``, accessibility related warnings are displayed alongside other configuration warnings. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_docks/scene_tree/ask_before_deleting_related_animation_tracks: .. rst-class:: classref-property @@ -1371,6 +1417,20 @@ The factor to use when zooming in or out in the 2D editor. For example, ``1.1`` ---- +.. _class_EditorSettings_property_editors/3d/active_selection_box_color: + +.. rst-class:: classref-property + +:ref:`Color` **editors/3d/active_selection_box_color** :ref:`🔗` + +The color to use for the active selection box that surrounds selected nodes in the 3D editor viewport. The color's alpha channel influences the selection box's opacity. + +\ **Note:** The term "active" indicates that this object is the primary selection used as the basis for certain operations. This is the last selected :ref:`Node3D`, which can be reordered with :kbd:`Shift + Left mouse button`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/3d/default_fov: .. rst-class:: classref-property @@ -2243,6 +2303,20 @@ If ``false``, the behavior is reversed, i.e. the dialog only appears when Shift ---- +.. _class_EditorSettings_property_editors/animation/default_animation_step: + +.. rst-class:: classref-property + +:ref:`float` **editors/animation/default_animation_step** :ref:`🔗` + +Default step used when creating a new :ref:`Animation` in the Animation bottom panel. Only affects the first animation created in the :ref:`AnimationPlayer`. By default, other newly created animations will use the step from the previous ones. + +This value is always expressed in seconds. If you want e.g. ``10`` FPS to be the default, you need to set the default step to ``0.1``. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/animation/default_create_bezier_tracks: .. rst-class:: classref-property @@ -2267,6 +2341,30 @@ If ``true``, create a ``RESET`` track when creating a new animation track. This ---- +.. _class_EditorSettings_property_editors/animation/default_fps_compatibility: + +.. rst-class:: classref-property + +:ref:`bool` **editors/animation/default_fps_compatibility** :ref:`🔗` + +Controls whether :ref:`AnimationPlayer` will apply snapping to nearest integer FPS when snapping is in Seconds mode. The option is remembered locally for a scene and this option only determines the default value when scene doesn't have local state yet. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_editors/animation/default_fps_mode: + +.. rst-class:: classref-property + +:ref:`int` **editors/animation/default_fps_mode** :ref:`🔗` + +Default step mode for :ref:`AnimationPlayer` (seconds or FPS). The option is remembered locally for a scene and this option only determines the default value when scene doesn't have local state yet. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_editors/animation/onion_layers_future_color: .. rst-class:: classref-property @@ -3258,7 +3356,7 @@ Input accumulation can be disabled to get slightly more precise/reactive input a 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. -- **Auto** follows the platform convention: Cancel first on macOS and Linux, OK first on Windows. +- **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. @@ -3408,7 +3506,7 @@ Translations are provided by the community. If you spot a mistake, :doc:`contrib :ref:`int` **interface/editor/editor_screen** :ref:`🔗` -The preferred monitor to display the editor. If **Auto**, the editor will remember the last screen it was displayed on across restarts. +The preferred monitor to display the editor. If **Auto**, the editor will remember the last screen it was displayed on across multiple sessions. .. rst-class:: classref-item-separator @@ -3638,7 +3736,7 @@ If ``true``, scenes and scripts are saved when the editor loses focus. Depending :ref:`bool` **interface/editor/separate_distraction_mode** :ref:`🔗` -If ``true``, the editor's Script tab will have a separate distraction mode setting from the 2D/3D/AssetLib tabs. If ``false``, the distraction-free mode toggle is shared between all tabs. +If ``true``, the editor's Script tab will have a separate distraction mode setting from the 2D/3D/Game/AssetLib tabs. If ``false``, the distraction-free mode toggle is shared between all tabs. .. rst-class:: classref-item-separator @@ -3696,6 +3794,18 @@ This is equivalent to :ref:`ProjectSettings.display/window/subwindows/embed_subw ---- +.. _class_EditorSettings_property_interface/editor/tablet_driver: + +.. rst-class:: classref-property + +:ref:`int` **interface/editor/tablet_driver** :ref:`🔗` + +Overrides the tablet driver used by the editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/ui_layout_direction: .. rst-class:: classref-property @@ -4336,6 +4446,20 @@ If ``true``, enable two finger pan and scale gestures on touchscreen devices. ---- +.. _class_EditorSettings_property_interface/touchscreen/enable_touch_actions_panel: + +.. rst-class:: classref-property + +:ref:`bool` **interface/touchscreen/enable_touch_actions_panel** :ref:`🔗` + +If ``true``, enables the TouchActionsPanel to provide easy access to keyboard shortcuts on touchscreen devices. + +\ **Note:** Only available in the Android editor. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/touchscreen/increase_scrollbar_touch_area: .. rst-class:: classref-property @@ -4640,7 +4764,7 @@ Overrides game embedding setting for all newly opened projects. If enabled, game The window mode to use to display the project when starting the project from the editor. -\ **Note:** Game embedding is not available for "Force Maximized" or "Force Fullscreen." +\ **Note:** Game embedding is not available for **"Force Maximized"** or **"Force Fullscreen"**. .. rst-class:: classref-item-separator @@ -4970,6 +5094,20 @@ If ``true``, converts indentation to match the script editor's indentation setti ---- +.. _class_EditorSettings_property_text_editor/behavior/files/drop_preload_resources_as_uid: + +.. rst-class:: classref-property + +:ref:`bool` **text_editor/behavior/files/drop_preload_resources_as_uid** :ref:`🔗` + +If ``true``, when dropping a :ref:`Resource` file to script editor while :kbd:`Ctrl` is held, the resource will be preloaded with a UID. If ``false``, the resource will be preloaded with a path. + +When you hold :kbd:`Ctrl+Shift`, the behavior is reversed. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/behavior/files/open_dominant_script_on_scene_change: .. rst-class:: classref-property @@ -6024,6 +6162,18 @@ The script editor's color for user-defined types (using ``class_name``). ---- +.. _class_EditorSettings_property_text_editor/theme/highlighting/warning_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/warning_color** :ref:`🔗` + +The script editor's background color for lines with warnings. This should be set to a translucent color so that it can display on top of other line color modifiers such as :ref:`text_editor/theme/highlighting/current_line_color`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/theme/highlighting/word_highlighted_color: .. rst-class:: classref-property diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index b5e79a152d8..5de46f172de 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -21,7 +21,7 @@ Description This class can be used to permanently store data in the user device's file system and to read from it. This is useful for storing game save data or player configuration files. -Here's a sample on how to write and read from a file: +\ **Example:** How to write and read from a file. The file named ``"save_game.dat"`` will be stored in the user data folder, as specified in the :doc:`Data paths <../tutorials/io/data_paths>` documentation: .. tabs:: @@ -54,13 +54,11 @@ Here's a sample on how to write and read from a file: -In the example above, the file will be saved in the user data folder as specified in the :doc:`Data paths <../tutorials/io/data_paths>` documentation. - -\ **FileAccess** will close when it's freed, which happens when it goes out of scope or when it gets assigned with ``null``. :ref:`close()` can be used to close it before then explicitly. In C# the reference must be disposed manually, which can be done with the ``using`` statement or by calling the ``Dispose`` method directly. +A **FileAccess** instance will close its file when the instance is freed. Since it inherits :ref:`RefCounted`, this happens automatically when it is no longer in use. :ref:`close()` can be called to close it earlier. In C#, the reference must be disposed manually, which can be done with the ``using`` statement or by calling the ``Dispose`` method directly. \ **Note:** To access project resources once exported, it is recommended to use :ref:`ResourceLoader` instead of **FileAccess**, as some files are converted to engine-specific formats and their original source files might not be present in the exported PCK package. If using **FileAccess**, make sure the file is included in the export by changing its import mode to **Keep File (exported as is)** in the Import dock, or, for files where this option is not available, change the non-resource export filter in the Export dialog to include the file's extension (e.g. ``*.txt``). -\ **Note:** Files are automatically closed only if the process exits "normally" (such as by clicking the window manager's close button or pressing **Alt + F4**). If you stop the project execution by pressing **F8** while the project is running, the file won't be closed as the game process will be killed. You can work around this by calling :ref:`flush()` at regular intervals. +\ **Note:** Files are automatically closed only if the process exits "normally" (such as by clicking the window manager's close button or pressing :kbd:`Alt + F4`). If you stop the project execution by pressing :kbd:`F8` while the project is running, the file won't be closed as the game process will be killed. You can work around this by calling :ref:`flush()` at regular intervals. .. rst-class:: classref-introduction-group @@ -112,6 +110,8 @@ Methods +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_64`\ (\ ) |const| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_access_time`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_as_text`\ (\ skip_cr\: :ref:`bool` = false\ ) |const| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`get_buffer`\ (\ length\: :ref:`int`\ ) |const| | @@ -156,6 +156,8 @@ Methods +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_sha256`\ (\ path\: :ref:`String`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_size`\ (\ file\: :ref:`String`\ ) |static| | + +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |bitfield|\[:ref:`UnixPermissionFlags`\] | :ref:`get_unix_permissions`\ (\ file\: :ref:`String`\ ) |static| | +-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_var`\ (\ allow_objects\: :ref:`bool` = false\ ) |const| | @@ -440,9 +442,7 @@ Property Descriptions If ``true``, the file is read with big-endian `endianness `__. If ``false``, the file is read with little-endian endianness. If in doubt, leave this to ``false`` as most files are written with little-endian endianness. -\ **Note:** :ref:`big_endian` is only about the file format, not the CPU type. The CPU endianness doesn't affect the default endianness for files written. - -\ **Note:** This is always reset to ``false`` whenever you open the file. Therefore, you must set :ref:`big_endian` *after* opening the file, not before. +\ **Note:** This is always reset to system endianness, which is little-endian on all supported platforms, whenever you open the file. Therefore, you must set :ref:`big_endian` *after* opening the file, not before. .. rst-class:: classref-section-separator @@ -596,6 +596,18 @@ Returns the next 64 bits from the file as an integer. See :ref:`store_64()` **get_access_time**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` + +Returns the last time the ``file`` was accessed in Unix timestamp format, or ``0`` on error. This Unix timestamp can be converted to another format using the :ref:`Time` singleton. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileAccess_method_get_as_text: .. rst-class:: classref-method @@ -886,6 +898,18 @@ Returns an SHA-256 :ref:`String` representing the file at the give ---- +.. _class_FileAccess_method_get_size: + +.. rst-class:: classref-method + +:ref:`int` **get_size**\ (\ file\: :ref:`String`\ ) |static| :ref:`🔗` + +Returns file size in bytes, or ``-1`` on error. + +.. rst-class:: classref-item-separator + +---- + .. _class_FileAccess_method_get_unix_permissions: .. rst-class:: classref-method diff --git a/classes/class_foldablecontainer.rst b/classes/class_foldablecontainer.rst new file mode 100644 index 00000000000..ad89a3e7780 --- /dev/null +++ b/classes/class_foldablecontainer.rst @@ -0,0 +1,601 @@ +:github_url: hide + +.. meta:: + :keywords: expandable, collapsible, collapse + +.. 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/FoldableContainer.xml. + +.. _class_FoldableContainer: + +FoldableContainer +================= + +**Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +A container that can be expanded/collapsed. + +.. rst-class:: classref-introduction-group + +Description +----------- + +A container that can be expanded/collapsed, with a title that can be filled with controls, such as buttons. + +The title can be positioned at the top or bottom of the container. + +The container can be expanded or collapsed by clicking the title or by pressing ``ui_accept`` when focused. + +Child control nodes are hidden when the container is collapsed. Ignores non-control children. + +Can allow grouping with other FoldableContainers, check :ref:`foldable_group` and :ref:`FoldableGroup`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FoldableGroup` | :ref:`foldable_group` | | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`bool` | :ref:`folded` | ``false`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`MouseFilter` | mouse_filter | ``0`` (overrides :ref:`Control`) | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`String` | :ref:`text` | ``""`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`OverrunBehavior` | :ref:`text_overrun_behavior` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`title_alignment` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`TitlePosition` | :ref:`title_position` | ``0`` | + +-------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_title_bar_control`\ (\ control\: :ref:`Control`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`expand`\ (\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`fold`\ (\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_title_bar_control`\ (\ control\: :ref:`Control`\ ) | + +--------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Theme Properties +---------------- + +.. table:: + :widths: auto + + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`collapsed_font_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Color` | :ref:`hover_font_color` | ``Color(0.95, 0.95, 0.95, 1)`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`h_separation` | ``2`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`outline_size` | ``0`` | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Font` | :ref:`font` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`font_size` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`expanded_arrow` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`expanded_arrow_mirrored` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded_arrow` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`Texture2D` | :ref:`folded_arrow_mirrored` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_collapsed_hover_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_collapsed_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_hover_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`title_panel` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Signals +------- + +.. _class_FoldableContainer_signal_folding_changed: + +.. rst-class:: classref-signal + +**folding_changed**\ (\ is_folded\: :ref:`bool`\ ) :ref:`🔗` + +Emitted when the container is folded/expanded. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_FoldableContainer_TitlePosition: + +.. rst-class:: classref-enumeration + +enum **TitlePosition**: :ref:`🔗` + +.. _class_FoldableContainer_constant_POSITION_TOP: + +.. rst-class:: classref-enumeration-constant + +:ref:`TitlePosition` **POSITION_TOP** = ``0`` + +Makes the title appear at the top of the container. + +.. _class_FoldableContainer_constant_POSITION_BOTTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`TitlePosition` **POSITION_BOTTOM** = ``1`` + +Makes the title appear at the bottom of the container. Also makes all StyleBoxes flipped vertically. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_FoldableContainer_property_foldable_group: + +.. rst-class:: classref-property + +:ref:`FoldableGroup` **foldable_group** :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_foldable_group**\ (\ value\: :ref:`FoldableGroup`\ ) +- :ref:`FoldableGroup` **get_foldable_group**\ (\ ) + +The :ref:`FoldableGroup` associated with the container. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_folded: + +.. rst-class:: classref-property + +:ref:`bool` **folded** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_folded**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_folded**\ (\ ) + +If ``true``, the container will becomes folded and will hide all its children. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_language: + +.. rst-class:: classref-property + +:ref:`String` **language** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |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. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_text: + +.. rst-class:: classref-property + +:ref:`String` **text** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_text**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_text**\ (\ ) + +The Container's title text. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_text_direction: + +.. rst-class:: classref-property + +:ref:`TextDirection` **text_direction** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_text_direction**\ (\ value\: :ref:`TextDirection`\ ) +- :ref:`TextDirection` **get_text_direction**\ (\ ) + +Base text writing direction. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_text_overrun_behavior: + +.. rst-class:: classref-property + +:ref:`OverrunBehavior` **text_overrun_behavior** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_text_overrun_behavior**\ (\ value\: :ref:`OverrunBehavior`\ ) +- :ref:`OverrunBehavior` **get_text_overrun_behavior**\ (\ ) + +Defines the behavior of the **FoldableContainer** when the text is longer than the available space. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_alignment: + +.. rst-class:: classref-property + +:ref:`HorizontalAlignment` **title_alignment** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_alignment**\ (\ value\: :ref:`HorizontalAlignment`\ ) +- :ref:`HorizontalAlignment` **get_title_alignment**\ (\ ) + +Title's horizontal text alignment as defined in the :ref:`HorizontalAlignment` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_property_title_position: + +.. rst-class:: classref-property + +:ref:`TitlePosition` **title_position** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_title_position**\ (\ value\: :ref:`TitlePosition`\ ) +- :ref:`TitlePosition` **get_title_position**\ (\ ) + +Title's position as defined in the :ref:`TitlePosition` enum. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_FoldableContainer_method_add_title_bar_control: + +.. rst-class:: classref-method + +|void| **add_title_bar_control**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` + +Adds a :ref:`Control` that will be placed next to the container's title, obscuring the clickable area. Prime usage is adding :ref:`Button` nodes, but it can be any :ref:`Control`. + +The control will be added as a child of this container and removed from previous parent if necessary. The controls will be placed aligned to the right, with the first added control being the leftmost one. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_method_expand: + +.. rst-class:: classref-method + +|void| **expand**\ (\ ) :ref:`🔗` + +Expands the container and emits :ref:`folding_changed`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_method_fold: + +.. rst-class:: classref-method + +|void| **fold**\ (\ ) :ref:`🔗` + +Folds the container and emits :ref:`folding_changed`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_method_remove_title_bar_control: + +.. rst-class:: classref-method + +|void| **remove_title_bar_control**\ (\ control\: :ref:`Control`\ ) :ref:`🔗` + +Removes a :ref:`Control` added with :ref:`add_title_bar_control()`. The node is not freed automatically, you need to use :ref:`Node.queue_free()`. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Theme Property Descriptions +--------------------------- + +.. _class_FoldableContainer_theme_color_collapsed_font_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **collapsed_font_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +The title's font color when collapsed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_color_font_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_color** = ``Color(0.875, 0.875, 0.875, 1)`` :ref:`🔗` + +The title's font color when expanded. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_color_font_outline_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_outline_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +The title's font outline color. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_color_hover_font_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **hover_font_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` + +The title's font hover color. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_constant_h_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **h_separation** = ``2`` :ref:`🔗` + +The horizontal separation between the title's icon and text, and between title bar controls. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_constant_outline_size: + +.. rst-class:: classref-themeproperty + +:ref:`int` **outline_size** = ``0`` :ref:`🔗` + +The title's font outline size. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_font_font: + +.. rst-class:: classref-themeproperty + +:ref:`Font` **font** :ref:`🔗` + +The title's font. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_font_size_font_size: + +.. rst-class:: classref-themeproperty + +:ref:`int` **font_size** :ref:`🔗` + +The title's font size. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_expanded_arrow: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **expanded_arrow** :ref:`🔗` + +The title's icon used when expanded. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_expanded_arrow_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **expanded_arrow_mirrored** :ref:`🔗` + +The title's icon used when expanded (for bottom title). + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_folded_arrow: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **folded_arrow** :ref:`🔗` + +The title's icon used when folded (for left-to-right layouts). + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_icon_folded_arrow_mirrored: + +.. rst-class:: classref-themeproperty + +:ref:`Texture2D` **folded_arrow_mirrored** :ref:`🔗` + +The title's icon used when collapsed (for right-to-left layouts). + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **focus** :ref:`🔗` + +Background used when **FoldableContainer** has GUI focus. The :ref:`focus` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel** :ref:`🔗` + +Default background for the **FoldableContainer**. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_collapsed_hover_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_collapsed_hover_panel** :ref:`🔗` + +Background used when the mouse cursor enters the title's area when collapsed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_collapsed_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_collapsed_panel** :ref:`🔗` + +Default background for the **FoldableContainer**'s title when collapsed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_hover_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_hover_panel** :ref:`🔗` + +Background used when the mouse cursor enters the title's area when expanded. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableContainer_theme_style_title_panel: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **title_panel** :ref:`🔗` + +Default background for the **FoldableContainer**'s title when expanded. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_foldablegroup.rst b/classes/class_foldablegroup.rst new file mode 100644 index 00000000000..e840ff8e704 --- /dev/null +++ b/classes/class_foldablegroup.rst @@ -0,0 +1,130 @@ +:github_url: hide + +.. meta:: + :keywords: expandable, collapsible, collapse + +.. 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/FoldableGroup.xml. + +.. _class_FoldableGroup: + +FoldableGroup +============= + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +A group of foldable containers that doesn't allow more than one container to be expanded at a time. + +.. rst-class:: classref-introduction-group + +Description +----------- + +A group of :ref:`FoldableContainer`-derived nodes. Only one container can be expanded at a time. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-------------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`allow_folding_all` | ``false`` | + +-------------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + | :ref:`bool` | resource_local_to_scene | ``true`` (overrides :ref:`Resource`) | + +-------------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`FoldableContainer`\] | :ref:`get_containers`\ (\ ) |const| | + +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | :ref:`FoldableContainer` | :ref:`get_expanded_container`\ (\ ) |const| | + +--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Signals +------- + +.. _class_FoldableGroup_signal_expanded: + +.. rst-class:: classref-signal + +**expanded**\ (\ container\: :ref:`FoldableContainer`\ ) :ref:`🔗` + +Emitted when one of the containers of the group is expanded. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_FoldableGroup_property_allow_folding_all: + +.. rst-class:: classref-property + +:ref:`bool` **allow_folding_all** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_allow_folding_all**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_allow_folding_all**\ (\ ) + +If ``true``, it is possible to fold all containers in this FoldableGroup. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_FoldableGroup_method_get_containers: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`FoldableContainer`\] **get_containers**\ (\ ) |const| :ref:`🔗` + +Returns an :ref:`Array` of :ref:`FoldableContainer`\ s that have this as their FoldableGroup (see :ref:`FoldableContainer.foldable_group`). This is equivalent to :ref:`ButtonGroup` but for FoldableContainers. + +.. rst-class:: classref-item-separator + +---- + +.. _class_FoldableGroup_method_get_expanded_container: + +.. rst-class:: classref-method + +:ref:`FoldableContainer` **get_expanded_container**\ (\ ) |const| :ref:`🔗` + +Returns the current expanded container. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index e6e0082cb10..556c65be613 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -100,6 +100,8 @@ Properties +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`keep_rounding_remainders` | ``true`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`bool` | :ref:`modulate_color_glyphs` | ``false`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`msdf_pixel_range` | ``16`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`msdf_size` | ``48`` | @@ -508,6 +510,23 @@ If set to ``true``, when aligning glyphs to the pixel boundaries rounding remain ---- +.. _class_FontFile_property_modulate_color_glyphs: + +.. rst-class:: classref-property + +:ref:`bool` **modulate_color_glyphs** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_modulate_color_glyphs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_modulate_color_glyphs**\ (\ ) + +If set to ``true``, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only. + +.. rst-class:: classref-item-separator + +---- + .. _class_FontFile_property_msdf_pixel_range: .. rst-class:: classref-property diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index 6b55c66e72e..bec735790c0 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -269,7 +269,7 @@ Property Descriptions - |void| **set_accessor_type**\ (\ value\: :ref:`GLTFAccessorType`\ ) - :ref:`GLTFAccessorType` **get_accessor_type**\ (\ ) -The glTF accessor type as an enum. Possible values are 0 for "SCALAR", 1 for "VEC2", 2 for "VEC3", 3 for "VEC4", 4 for "MAT2", 5 for "MAT3", and 6 for "MAT4". +The glTF accessor type, as an enum. .. rst-class:: classref-item-separator @@ -513,7 +513,7 @@ The offset relative to the start of the bufferView in bytes. **Deprecated:** Use :ref:`accessor_type` instead. -The glTF accessor type as an enum. Use :ref:`accessor_type` instead. +The glTF accessor type, as an :ref:`int`. Possible values are ``0`` for "SCALAR", ``1`` for "VEC2", ``2`` for "VEC3", ``3`` for "VEC4", ``4`` for "MAT2", ``5`` for "MAT3", and ``6`` for "MAT4". .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index f9c74903bc1..8c057092554 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -94,7 +94,9 @@ Property Descriptions - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) -The :ref:`Color` of the light. Defaults to white. A black color causes the light to have no effect. +The :ref:`Color` of the light in linear space. Defaults to white. A black color causes the light to have no effect. + +This value is linear to match glTF, but will be converted to nonlinear sRGB when creating a Godot :ref:`Light3D` node upon import, or converted to linear when exporting a Godot :ref:`Light3D` to glTF. .. rst-class:: classref-item-separator @@ -183,7 +185,7 @@ At this angle, the light drops off to zero brightness. Between the inner and out - |void| **set_range**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_range**\ (\ ) -The range of the light, beyond which the light has no effect. glTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to 4096. +The range of the light, beyond which the light has no effect. glTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to ``4096.0``. .. rst-class:: classref-section-separator diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index 6cf3687bb82..e9701d1078e 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -106,7 +106,7 @@ Property Descriptions - |void| **set_camera**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_camera**\ (\ ) -If this glTF node is a camera, the index of the :ref:`GLTFCamera` in the :ref:`GLTFState` that describes the camera's properties. If -1, this node is not a camera. +If this glTF node is a camera, the index of the :ref:`GLTFCamera` in the :ref:`GLTFState` that describes the camera's properties. If ``-1``, this node is not a camera. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfobjectmodelproperty.rst b/classes/class_gltfobjectmodelproperty.rst index df372ec3176..47f1d589938 100644 --- a/classes/class_gltfobjectmodelproperty.rst +++ b/classes/class_gltfobjectmodelproperty.rst @@ -235,7 +235,7 @@ If set, this :ref:`Expression` will be used to convert the pro - |void| **set_json_pointers**\ (\ value\: :ref:`Array`\[:ref:`PackedStringArray`\]\ ) - :ref:`Array`\[:ref:`PackedStringArray`\] **get_json_pointers**\ (\ ) -The glTF object model JSON pointers used to identify the property in the glTF object model. In most cases, there will be only one item in this array, but niche cases may require multiple pointers. The items are themselves arrays which represent the JSON pointer split into its components. +The glTF object model JSON pointers used to identify the property in the glTF object model. In most cases, there will be only one item in this array, but specific cases may require multiple pointers. The items are themselves arrays which represent the JSON pointer split into its components. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst index e2879a47810..28950ef618c 100644 --- a/classes/class_gltfphysicsbody.rst +++ b/classes/class_gltfphysicsbody.rst @@ -111,7 +111,11 @@ The angular velocity of the physics body, in radians per second. This is only us - |void| **set_body_type**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_body_type**\ (\ ) -The type of the body. When importing, this controls what type of :ref:`CollisionObject3D` node Godot should generate. Valid values are "static", "animatable", "character", "rigid", "vehicle", and "trigger". When exporting, this will be squashed down to one of "static", "kinematic", or "dynamic" motion types, or the "trigger" property. +The type of the body. + +When importing, this controls what type of :ref:`CollisionObject3D` node Godot should generate. Valid values are ``"static"``, ``"animatable"``, ``"character"``, ``"rigid"``, ``"vehicle"``, and ``"trigger"``. + +When exporting, this will be squashed down to one of ``"static"``, ``"kinematic"``, or ``"dynamic"`` motion types, or the ``"trigger"`` property. .. rst-class:: classref-item-separator diff --git a/classes/class_gltfphysicsshape.rst b/classes/class_gltfphysicsshape.rst index 1556aa4f545..f758bab624d 100644 --- a/classes/class_gltfphysicsshape.rst +++ b/classes/class_gltfphysicsshape.rst @@ -98,7 +98,7 @@ Property Descriptions - |void| **set_height**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_height**\ (\ ) -The height of the shape, in meters. This is only used when the shape type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius. +The height of the shape, in meters. This is only used when the shape type is ``"capsule"`` or ``"cylinder"``. This value should not be negative, and for ``"capsule"`` it should be at least twice the radius. .. rst-class:: classref-item-separator @@ -115,7 +115,7 @@ The height of the shape, in meters. This is only used when the shape type is "ca - |void| **set_importer_mesh**\ (\ value\: :ref:`ImporterMesh`\ ) - :ref:`ImporterMesh` **get_importer_mesh**\ (\ ) -The :ref:`ImporterMesh` resource of the shape. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh). +The :ref:`ImporterMesh` resource of the shape. This is only used when the shape type is ``"hull"`` (convex hull) or ``"trimesh"`` (concave trimesh). .. rst-class:: classref-item-separator @@ -132,7 +132,7 @@ The :ref:`ImporterMesh` resource of the shape. This is only - |void| **set_is_trigger**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_trigger**\ (\ ) -If ``true``, indicates that this shape is a trigger. For Godot, this means that the shape should be a child of an Area3D node. +If ``true``, indicates that this shape is a trigger. For Godot, this means that the shape should be a child of an :ref:`Area3D` node. This is the only variable not used in the :ref:`to_node()` method, it's intended to be used alongside when deciding where to add the generated node as a child. @@ -151,7 +151,7 @@ This is the only variable not used in the :ref:`to_node()`\ ) - :ref:`int` **get_mesh_index**\ (\ ) -The index of the shape's mesh in the glTF file. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh). +The index of the shape's mesh in the glTF file. This is only used when the shape type is ``"hull"`` (convex hull) or ``"trimesh"`` (concave trimesh). .. rst-class:: classref-item-separator @@ -168,7 +168,7 @@ The index of the shape's mesh in the glTF file. This is only used when the shape - |void| **set_radius**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_radius**\ (\ ) -The radius of the shape, in meters. This is only used when the shape type is "capsule", "cylinder", or "sphere". This value should not be negative. +The radius of the shape, in meters. This is only used when the shape type is ``"capsule"``, ``"cylinder"``, or ``"sphere"``. This value should not be negative. .. rst-class:: classref-item-separator @@ -185,7 +185,7 @@ The radius of the shape, in meters. This is only used when the shape type is "ca - |void| **set_shape_type**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_shape_type**\ (\ ) -The type of shape this shape represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh". +The type of shape this shape represents. Valid values are ``"box"``, ``"capsule"``, ``"cylinder"``, ``"sphere"``, ``"hull"``, and ``"trimesh"``. .. rst-class:: classref-item-separator @@ -202,7 +202,7 @@ The type of shape this shape represents. Valid values are "box", "capsule", "cyl - |void| **set_size**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_size**\ (\ ) -The size of the shape, in meters. This is only used when the shape type is "box", and it represents the "diameter" of the box. This value should not be negative. +The size of the shape, in meters. This is only used when the shape type is ``"box"``, and it represents the ``"diameter"`` of the box. This value should not be negative. .. rst-class:: classref-section-separator diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index b88dba95d4a..04a3ee34cba 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -489,7 +489,7 @@ Appends an extension to the list of extensions used by this glTF file during ser :ref:`int` **append_data_to_buffers**\ (\ data\: :ref:`PackedByteArray`, deduplication\: :ref:`bool`\ ) :ref:`🔗` -Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferView` for it. The index of the destination :ref:`GLTFBufferView` is returned. If ``deduplication`` is ``true``, the buffers will first be searched for duplicate data, otherwise new bytes will always be appended. +Appends the given byte array ``data`` to the buffers and creates a :ref:`GLTFBufferView` for it. The index of the destination :ref:`GLTFBufferView` is returned. If ``deduplication`` is ``true``, the buffers are first searched for duplicate data, otherwise new bytes are always appended. .. rst-class:: classref-item-separator @@ -501,7 +501,7 @@ Appends the given byte array data to the buffers and creates a :ref:`GLTFBufferV :ref:`int` **append_gltf_node**\ (\ gltf_node\: :ref:`GLTFNode`, godot_scene_node\: :ref:`Node`, parent_node_index\: :ref:`int`\ ) :ref:`🔗` -Append the given :ref:`GLTFNode` to the state, and return its new index. This can be used to export one Godot node as multiple glTF nodes, or inject new glTF nodes at import time. On import, this must be called before :ref:`GLTFDocumentExtension._generate_scene_node()` finishes for the parent node. On export, this must be called before :ref:`GLTFDocumentExtension._export_node()` runs for the parent node. +Appends the given :ref:`GLTFNode` to the state, and returns its new index. This can be used to export one Godot node as multiple glTF nodes, or inject new glTF nodes at import time. On import, this must be called before :ref:`GLTFDocumentExtension._generate_scene_node()` finishes for the parent node. On export, this must be called before :ref:`GLTFDocumentExtension._export_node()` runs for the parent node. The ``godot_scene_node`` parameter is the Godot scene node that corresponds to this glTF node. This is highly recommended to be set to a valid node, but may be ``null`` if there is no corresponding Godot scene node. One Godot scene node may be used for multiple glTF nodes, so if exporting multiple glTF nodes for one Godot scene node, use the same Godot scene node for each. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 47c30812942..d9f4e4dc63c 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -82,6 +82,8 @@ Properties +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`snapping_enabled` | ``true`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`type_names` | ``{}`` | + +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`float` | :ref:`zoom` | ``1.0`` | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`float` | :ref:`zoom_max` | ``2.0736`` | @@ -136,6 +138,8 @@ Methods +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_connection_line`\ (\ from_node\: :ref:`Vector2`, to_node\: :ref:`Vector2`\ ) |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connection_list_from_node`\ (\ node\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_connections_intersecting_with_rect`\ (\ rect\: :ref:`Rect2`\ ) |const| | +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GraphFrame` | :ref:`get_element_frame`\ (\ element\: :ref:`StringName`\ ) | @@ -206,6 +210,8 @@ Theme Properties +-----------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------------------+ + | :ref:`StyleBox` | :ref:`panel_focus` | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------+-------------------------------+ .. rst-class:: classref-section-separator @@ -864,6 +870,23 @@ If ``true``, enables snapping. ---- +.. _class_GraphEdit_property_type_names: + +.. rst-class:: classref-property + +:ref:`Dictionary` **type_names** = ``{}`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_type_names**\ (\ value\: :ref:`Dictionary`\ ) +- :ref:`Dictionary` **get_type_names**\ (\ ) + +:ref:`Dictionary` of human readable port type names. + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_property_zoom: .. rst-class:: classref-property @@ -1229,6 +1252,30 @@ Returns the points which would make up a connection between ``from_node`` and `` ---- +.. _class_GraphEdit_method_get_connection_list_from_node: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Dictionary`\] **get_connection_list_from_node**\ (\ node\: :ref:`StringName`\ ) |const| :ref:`🔗` + +Returns an :ref:`Array` containing a list of all connections for ``node``. + +A connection is represented as a :ref:`Dictionary` in the form of: + +:: + + { + from_node: StringName, + from_port: int, + to_node: StringName, + to_port: int, + keep_alive: bool + } + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphEdit_method_get_connections_intersecting_with_rect: .. rst-class:: classref-method @@ -1610,6 +1657,18 @@ The icon for the zoom reset button. The background drawn under the grid. +.. rst-class:: classref-item-separator + +---- + +.. _class_GraphEdit_theme_style_panel_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel_focus** :ref:`🔗` + +:ref:`StyleBox` used when the **GraphEdit** is focused (when used with assistive apps). + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 1aaae7773ae..429a43463c5 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -37,6 +37,8 @@ Properties .. table:: :widths: auto + +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :ref:`bool` | :ref:`ignore_invalid_connection_type` | ``false`` | +----------------------------------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ @@ -140,10 +142,14 @@ Theme Properties +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`panel_focus` | | + +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`panel_selected` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`slot` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ + | :ref:`StyleBox` | :ref:`slot_selected` | | + +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`titlebar` | | +-----------------------------------+-------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`titlebar_selected` | | @@ -689,6 +695,18 @@ The default background for the slot area of the **GraphNode**. ---- +.. _class_GraphNode_theme_style_panel_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **panel_focus** :ref:`🔗` + +:ref:`StyleBox` used when the **GraphNode** is focused (when used with assistive apps). + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphNode_theme_style_panel_selected: .. rst-class:: classref-themeproperty @@ -713,6 +731,18 @@ The :ref:`StyleBox` used for each slot of the **GraphNode**. ---- +.. _class_GraphNode_theme_style_slot_selected: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **slot_selected** :ref:`🔗` + +:ref:`StyleBox` used when the slot is focused (when used with assistive apps). + +.. rst-class:: classref-item-separator + +---- + .. _class_GraphNode_theme_style_titlebar: .. rst-class:: classref-themeproperty diff --git a/classes/class_image.rst b/classes/class_image.rst index 6f449887f36..0ab518ae0c2 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -143,6 +143,8 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_bmp_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`load_dds_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`load_from_file`\ (\ path\: :ref:`String`\ ) |static| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`load_jpg_from_buffer`\ (\ buffer\: :ref:`PackedByteArray`\ ) | @@ -173,6 +175,10 @@ Methods +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`rotate_180`\ (\ ) | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_dds`\ (\ path\: :ref:`String`\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`save_dds_to_buffer`\ (\ ) |const| | + +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save_exr`\ (\ path\: :ref:`String`, grayscale\: :ref:`bool` = false\ ) |const| | +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`save_exr_to_buffer`\ (\ grayscale\: :ref:`bool` = false\ ) |const| | @@ -1430,6 +1436,20 @@ Loads an image from the binary contents of a BMP file. ---- +.. _class_Image_method_load_dds_from_buffer: + +.. rst-class:: classref-method + +:ref:`Error` **load_dds_from_buffer**\ (\ buffer\: :ref:`PackedByteArray`\ ) :ref:`🔗` + +Loads an image from the binary contents of a DDS file. + +\ **Note:** This method is only available in engine builds with the DDS module enabled. By default, the DDS module is enabled, but it can be disabled at build-time using the ``module_dds_enabled=no`` SCons option. + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_load_from_file: .. rst-class:: classref-method @@ -1622,6 +1642,34 @@ Rotates the image by ``180`` degrees. The width and height of the image must be ---- +.. _class_Image_method_save_dds: + +.. rst-class:: classref-method + +:ref:`Error` **save_dds**\ (\ path\: :ref:`String`\ ) |const| :ref:`🔗` + +Saves the image as a DDS (DirectDraw Surface) file to ``path``. DDS is a container format that can store textures in various compression formats, such as DXT1, DXT5, or BC7. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE` if Godot was compiled without the DDS module. + +\ **Note:** The DDS module may be disabled in certain builds, which means :ref:`save_dds()` will return :ref:`@GlobalScope.ERR_UNAVAILABLE` when it is called from an exported project. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Image_method_save_dds_to_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **save_dds_to_buffer**\ (\ ) |const| :ref:`🔗` + +Saves the image as a DDS (DirectDraw Surface) file to a byte array. DDS is a container format that can store textures in various compression formats, such as DXT1, DXT5, or BC7. This function will return an empty byte array if Godot was compiled without the DDS module. + +\ **Note:** The DDS module may be disabled in certain builds, which means :ref:`save_dds_to_buffer()` will return an empty byte array when it is called from an exported project. + +.. rst-class:: classref-item-separator + +---- + .. _class_Image_method_save_exr: .. rst-class:: classref-method diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index 88b1b7e2775..bb1a623cdc4 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -57,6 +57,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`event_is_action`\ (\ event\: :ref:`InputEvent`, action\: :ref:`StringName`, exact_match\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_action_description`\ (\ action\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_actions`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_action`\ (\ action\: :ref:`StringName`\ ) |const| | @@ -199,6 +201,18 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: ---- +.. _class_InputMap_method_get_action_description: + +.. rst-class:: classref-method + +:ref:`String` **get_action_description**\ (\ action\: :ref:`StringName`\ ) |const| :ref:`🔗` + +Returns the human-readable description of the given action. + +.. rst-class:: classref-item-separator + +---- + .. _class_InputMap_method_get_actions: .. rst-class:: classref-method diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index edca66d1639..d3fb9a0f6be 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -80,6 +80,8 @@ Returns the Java exception from the last call into a Java class. If there was no Wraps a class defined in Java, and returns it as a :ref:`JavaClass` :ref:`Object` type that Godot can interact with. +When wrapping inner (nested) classes, use ``$`` instead of ``.`` to separate them. For example, ``JavaClassWrapper.wrap("android.view.WindowManager$LayoutParams")`` wraps the **WindowManager.LayoutParams** class. + \ **Note:** This method only works on Android. On every other platform, this method does nothing and returns an empty :ref:`JavaClass`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index 15dabe11567..02df24ac582 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -42,7 +42,7 @@ Methods +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`process_string`\ (\ action\: :ref:`String`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_scope`\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) | + | |void| | :ref:`set_method`\ (\ name\: :ref:`String`, callback\: :ref:`Callable`\ ) | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -207,15 +207,17 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act ---- -.. _class_JSONRPC_method_set_scope: +.. _class_JSONRPC_method_set_method: .. rst-class:: classref-method -|void| **set_scope**\ (\ scope\: :ref:`String`, target\: :ref:`Object`\ ) :ref:`🔗` +|void| **set_method**\ (\ name\: :ref:`String`, callback\: :ref:`Callable`\ ) :ref:`🔗` -.. container:: contribute +Registers a callback for the given method name. - There is currently no description for this method. Please help us by :ref:`contributing one `! +- ``name`` The name that clients can use to access the callback. + +- ``callback`` The callback which will handle the specific method. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_label.rst b/classes/class_label.rst index 400efb55076..935a921f40b 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -42,10 +42,14 @@ Properties +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``192`` | + +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`clip_text` | ``false`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`String` | :ref:`ellipsis_char` | ``"…"`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``0`` | +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | |bitfield|\[:ref:`JustificationFlag`\] | :ref:`justification_flags` | ``163`` | @@ -138,6 +142,8 @@ Theme Properties +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ + | :ref:`StyleBox` | :ref:`focus` | | + +---------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`StyleBox` | :ref:`normal` | | +---------------------------------+----------------------------------------------------------------------------+-----------------------+ @@ -167,6 +173,23 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF`\] **autowrap_trim_flags** = ``192`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +Autowrap space trimming flags. See :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` and :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES` for more info. + +.. rst-class:: classref-item-separator + +---- + .. _class_Label_property_clip_text: .. rst-class:: classref-property @@ -723,6 +746,18 @@ Font size of the **Label**'s text. ---- +.. _class_Label_theme_style_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **focus** :ref:`🔗` + +:ref:`StyleBox` used when the **Label** is focused (when used with assistive apps). + +.. rst-class:: classref-item-separator + +---- + .. _class_Label_theme_style_normal: .. rst-class:: classref-themeproperty diff --git a/classes/class_label3d.rst b/classes/class_label3d.rst index f9b208fbefa..e65432b0032 100644 --- a/classes/class_label3d.rst +++ b/classes/class_label3d.rst @@ -52,6 +52,8 @@ Properties +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``0`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``192`` | + +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+ | :ref:`ShadowCastingSetting` | cast_shadow | ``0`` (overrides :ref:`GeometryInstance3D`) | @@ -339,6 +341,23 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF`\] **autowrap_trim_flags** = ``192`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +Autowrap space trimming flags. See :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` and :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES` for more info. + +.. rst-class:: classref-item-separator + +---- + .. _class_Label3D_property_billboard: .. rst-class:: classref-property @@ -384,7 +403,7 @@ If ``true``, text can be seen from the back as well, if ``false``, it is invisib - |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| -If ``true``, the label is rendered at the same size regardless of distance. +If ``true``, the label is rendered at the same size regardless of distance. The label's size on screen is the same as if the camera was ``1.0`` units away from the label's origin, regardless of the actual distance from the camera. The :ref:`Camera3D`'s field of view (or :ref:`Camera3D.size` when in orthogonal/frustum mode) still affects the size the label is drawn at. .. rst-class:: classref-item-separator diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index 9158f2097a8..b29e8c697b5 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -496,7 +496,7 @@ The light's bake mode. This will affect the global illumination techniques that - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) -The light's color. An *overbright* color can be used to achieve a result equivalent to increasing the light's :ref:`light_energy`. +The light's color in the nonlinear sRGB color space. An *overbright* color can be used to achieve a result equivalent to increasing the light's :ref:`light_energy`. .. rst-class:: classref-item-separator diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index e6f33e8aa51..1e07dddac64 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -32,6 +32,14 @@ Description - Check :ref:`edit()`, :ref:`unedit()`, :ref:`is_editing()`, and :ref:`editing_toggled` for more information. +While entering text, it is possible to insert special characters using Unicode, OEM or Windows alt codes: + +- To enter Unicode codepoints, hold :kbd:`Alt` and type the codepoint on the numpad. For example, to enter the character ``á`` (U+00E1), hold :kbd:`Alt` and type :kbd:`+E1` on the numpad (the leading zeroes can be omitted). + +- To enter OEM codepoints, hold :kbd:`Alt` and type the code on the numpad. For example, to enter the character ``á`` (OEM 160), hold :kbd:`Alt` and type ``160`` on the numpad. + +- To enter Windows codepoints, hold :kbd:`Alt` and type the code on the numpad. For example, to enter the character ``á`` (Windows 0225), hold :kbd:`Alt` and type :kbd:`0`, :kbd:`2`, :kbd:`2`, :kbd:`5` on the numpad. The leading zero here must **not** be omitted, as this is how Windows codepoints are distinguished from OEM codepoints. + \ **Important:**\ - Focusing the **LineEdit** with ``ui_focus_next`` (by default :kbd:`Tab`) or ``ui_focus_prev`` (by default :kbd:`Shift + Tab`) or :ref:`Control.grab_focus()` still enters edit mode (for compatibility). @@ -752,7 +760,7 @@ The caret's column position inside the **LineEdit**. When set, the text may scro - |void| **set_caret_force_displayed**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_caret_force_displayed**\ (\ ) -If ``true``, the **LineEdit** will always show the caret, even if focus is lost. +If ``true``, the **LineEdit** will always show the caret, even if not editing or focus is lost. .. rst-class:: classref-item-separator diff --git a/classes/class_linkbutton.rst b/classes/class_linkbutton.rst index 59dfb1e399c..b3e2e1d83fa 100644 --- a/classes/class_linkbutton.rst +++ b/classes/class_linkbutton.rst @@ -32,7 +32,7 @@ Properties :widths: auto +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``0`` (overrides :ref:`Control`) | + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`language` | ``""`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ diff --git a/classes/class_lookatmodifier3d.rst b/classes/class_lookatmodifier3d.rst index a810d677ee5..bae3f5ac419 100644 --- a/classes/class_lookatmodifier3d.rst +++ b/classes/class_lookatmodifier3d.rst @@ -691,7 +691,7 @@ Returns the remaining seconds of the time-based interpolation. :ref:`bool` **is_interpolating**\ (\ ) |const| :ref:`🔗` -Returns whether the time-based interpolation is running or not. If ``true``, it is equivalent to :ref:`get_interpolation_remaining()` being ``0``. +Returns ``true`` if time-based interpolation is running. If ``true``, it is equivalent to :ref:`get_interpolation_remaining()` returning ``0.0``. This is useful to determine whether a **LookAtModifier3D** can be removed safely. diff --git a/classes/class_material.rst b/classes/class_material.rst index ce05d1ad9a3..742f9a45974 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -136,7 +136,7 @@ Sets the **Material** to be used for the next pass. This renders the object agai - |void| **set_render_priority**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_render_priority**\ (\ ) -Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with :ref:`render_priority` ``1`` will render before all objects with :ref:`render_priority` ``0``. +Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with :ref:`render_priority` ``1`` will render on top of all objects with :ref:`render_priority` ``0``. \ **Note:** This only applies to :ref:`StandardMaterial3D`\ s and :ref:`ShaderMaterial`\ s with type "Spatial". diff --git a/classes/class_menubar.rst b/classes/class_menubar.rst index 3d8a70850b9..a05ecf7c76c 100644 --- a/classes/class_menubar.rst +++ b/classes/class_menubar.rst @@ -29,19 +29,21 @@ Properties .. table:: :widths: auto - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`flat` | ``false`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`language` | ``""`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`prefer_global_menu` | ``true`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`start_index` | ``-1`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`switch_on_hover` | ``true`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ - | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | - +--------------------------------------------------+----------------------------------------------------------------------+-----------+ + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`flat` | ``false`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`String` | :ref:`language` | ``""`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`prefer_global_menu` | ``true`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`int` | :ref:`start_index` | ``-1`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`switch_on_hover` | ``true`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | + +--------------------------------------------------+----------------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index c46ad6361d4..47456e1b06a 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -36,7 +36,7 @@ Properties +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`bool` | flat | ``true`` (overrides :ref:`Button`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ - | :ref:`FocusMode` | focus_mode | ``0`` (overrides :ref:`Control`) | + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`item_count` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index bfe43ae2ae7..8c8618981e0 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -573,7 +573,7 @@ Flag used to mark that the array contains 2D vertices. :ref:`ArrayFormat` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864`` -Flag indices that the mesh data will use ``GL_DYNAMIC_DRAW`` on GLES. Unused on Vulkan. +Flag used to mark that the mesh data will use ``GL_DYNAMIC_DRAW`` on GLES. Unused on Vulkan. .. _class_Mesh_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS: diff --git a/classes/class_multiplayerapiextension.rst b/classes/class_multiplayerapiextension.rst index 77258ffc622..2e57b1e2cfc 100644 --- a/classes/class_multiplayerapiextension.rst +++ b/classes/class_multiplayerapiextension.rst @@ -41,10 +41,12 @@ The following example extend the default implementation (:ref:`SceneMultiplayer< # Just passthrough base signals (copied to var to avoid cyclic reference) var cts = connected_to_server var cf = connection_failed + var sd = server_disconnected var pc = peer_connected var pd = peer_disconnected base_multiplayer.connected_to_server.connect(func(): cts.emit()) base_multiplayer.connection_failed.connect(func(): cf.emit()) + base_multiplayer.server_disconnected.connect(func(): sd.emit()) base_multiplayer.peer_connected.connect(func(id): pc.emit(id)) base_multiplayer.peer_disconnected.connect(func(id): pd.emit(id)) @@ -82,6 +84,9 @@ The following example extend the default implementation (:ref:`SceneMultiplayer< func _get_unique_id() -> int: return base_multiplayer.get_unique_id() + func _get_remote_sender_id() -> int: + return base_multiplayer.get_remote_sender_id() + func _get_peer_ids() -> PackedInt32Array: return base_multiplayer.get_peers() diff --git a/classes/class_nativemenu.rst b/classes/class_nativemenu.rst index cbb4153b586..f4c52b0053c 100644 --- a/classes/class_nativemenu.rst +++ b/classes/class_nativemenu.rst @@ -799,7 +799,7 @@ Returns global menu close callback. Returns global menu open callback. -b]Note:** This method is implemented only on macOS. +\ **Note:** This method is implemented only on macOS. .. rst-class:: classref-item-separator diff --git a/classes/class_navigationpathqueryparameters2d.rst b/classes/class_navigationpathqueryparameters2d.rst index 6369932879e..da074387ece 100644 --- a/classes/class_navigationpathqueryparameters2d.rst +++ b/classes/class_navigationpathqueryparameters2d.rst @@ -38,6 +38,10 @@ Properties .. table:: :widths: auto + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`excluded_regions` | ``[]`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`included_regions` | ``[]`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ | :ref:`RID` | :ref:`map` | ``RID()`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+-------------------+ @@ -174,6 +178,44 @@ Include all available metadata about the returned path. Property Descriptions --------------------- +.. _class_NavigationPathQueryParameters2D_property_excluded_regions: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`RID`\] **excluded_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_excluded_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_excluded_regions**\ (\ ) + +The list of region :ref:`RID`\ s that will be excluded from the path query. Use :ref:`NavigationRegion2D.get_rid()` to get the :ref:`RID` associated with a :ref:`NavigationRegion2D` node. + +\ **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters2D_property_included_regions: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`RID`\] **included_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_included_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_included_regions**\ (\ ) + +The list of region :ref:`RID`\ s that will be included by the path query. Use :ref:`NavigationRegion2D.get_rid()` to get the :ref:`RID` associated with a :ref:`NavigationRegion2D` node. If left empty all regions are included. If a region ends up being both included and excluded at the same time it will be excluded. + +\ **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryParameters2D_property_map: .. rst-class:: classref-property diff --git a/classes/class_navigationpathqueryparameters3d.rst b/classes/class_navigationpathqueryparameters3d.rst index 9849c14aa5f..e9d391e1ddf 100644 --- a/classes/class_navigationpathqueryparameters3d.rst +++ b/classes/class_navigationpathqueryparameters3d.rst @@ -38,6 +38,10 @@ Properties .. table:: :widths: auto + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`excluded_regions` | ``[]`` | + +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ + | :ref:`Array`\[:ref:`RID`\] | :ref:`included_regions` | ``[]`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`RID` | :ref:`map` | ``RID()`` | +------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ @@ -174,6 +178,44 @@ Include all available metadata about the returned path. Property Descriptions --------------------- +.. _class_NavigationPathQueryParameters3D_property_excluded_regions: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`RID`\] **excluded_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_excluded_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_excluded_regions**\ (\ ) + +The list of region :ref:`RID`\ s that will be excluded from the path query. Use :ref:`NavigationRegion3D.get_rid()` to get the :ref:`RID` associated with a :ref:`NavigationRegion3D` node. + +\ **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again. + +.. rst-class:: classref-item-separator + +---- + +.. _class_NavigationPathQueryParameters3D_property_included_regions: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`RID`\] **included_regions** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_included_regions**\ (\ value\: :ref:`Array`\[:ref:`RID`\]\ ) +- :ref:`Array`\[:ref:`RID`\] **get_included_regions**\ (\ ) + +The list of region :ref:`RID`\ s that will be included by the path query. Use :ref:`NavigationRegion3D.get_rid()` to get the :ref:`RID` associated with a :ref:`NavigationRegion3D` node. If left empty all regions are included. If a region ends up being both included and excluded at the same time it will be excluded. + +\ **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationPathQueryParameters3D_property_map: .. rst-class:: classref-property diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index ce8ce19f630..f69f24a5f4d 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -131,6 +131,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`get_maps`\ (\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_process_info`\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_baking_navigation_polygon`\ (\ navigation_polygon\: :ref:`NavigationPolygon`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`link_create`\ (\ ) | @@ -305,6 +307,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`region_set_use_edge_connections`\ (\ region\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_active`\ (\ active\: :ref:`bool`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_debug_enabled`\ (\ enabled\: :ref:`bool`\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`simplify_path`\ (\ path\: :ref:`PackedVector2Array`, epsilon\: :ref:`float`\ ) | @@ -323,6 +327,18 @@ Methods Signals ------- +.. _class_NavigationServer2D_signal_avoidance_debug_changed: + +.. rst-class:: classref-signal + +**avoidance_debug_changed**\ (\ ) :ref:`🔗` + +Emitted when avoidance debug settings are changed. Only available in debug builds. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_signal_map_changed: .. rst-class:: classref-signal @@ -349,6 +365,101 @@ Emitted when navigation debug settings are changed. Only available in debug buil .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_NavigationServer2D_ProcessInfo: + +.. rst-class:: classref-enumeration + +enum **ProcessInfo**: :ref:`🔗` + +.. _class_NavigationServer2D_constant_INFO_ACTIVE_MAPS: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_ACTIVE_MAPS** = ``0`` + +Constant to get the number of active navigation maps. + +.. _class_NavigationServer2D_constant_INFO_REGION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_REGION_COUNT** = ``1`` + +Constant to get the number of active navigation regions. + +.. _class_NavigationServer2D_constant_INFO_AGENT_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_AGENT_COUNT** = ``2`` + +Constant to get the number of active navigation agents processing avoidance. + +.. _class_NavigationServer2D_constant_INFO_LINK_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_LINK_COUNT** = ``3`` + +Constant to get the number of active navigation links. + +.. _class_NavigationServer2D_constant_INFO_POLYGON_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_POLYGON_COUNT** = ``4`` + +Constant to get the number of navigation mesh polygons. + +.. _class_NavigationServer2D_constant_INFO_EDGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_COUNT** = ``5`` + +Constant to get the number of navigation mesh polygon edges. + +.. _class_NavigationServer2D_constant_INFO_EDGE_MERGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_MERGE_COUNT** = ``6`` + +Constant to get the number of navigation mesh polygon edges that were merged due to edge key overlap. + +.. _class_NavigationServer2D_constant_INFO_EDGE_CONNECTION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_CONNECTION_COUNT** = ``7`` + +Constant to get the number of navigation mesh polygon edges that are considered connected by edge proximity. + +.. _class_NavigationServer2D_constant_INFO_EDGE_FREE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_EDGE_FREE_COUNT** = ``8`` + +Constant to get the number of navigation mesh polygon edges that could not be merged but may be still connected by edge proximity or with links. + +.. _class_NavigationServer2D_constant_INFO_OBSTACLE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`ProcessInfo` **INFO_OBSTACLE_COUNT** = ``9`` + +Constant to get the number of active navigation obstacles. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Method Descriptions ------------------- @@ -812,6 +923,18 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer ---- +.. _class_NavigationServer2D_method_get_process_info: + +.. rst-class:: classref-method + +:ref:`int` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo`\ ) |const| :ref:`🔗` + +Returns information about the current state of the NavigationServer. See :ref:`ProcessInfo` for a list of available states. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_is_baking_navigation_polygon: .. rst-class:: classref-method @@ -1070,6 +1193,8 @@ Create a new map. |void| **map_force_update**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` +**Deprecated:** This method is no longer supported, as it is incompatible with asynchronous updates. It can only be used in a single-threaded context, at your own risk. + This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. @@ -1880,6 +2005,18 @@ If ``enabled`` is ``true``, the navigation ``region`` will use edge connections ---- +.. _class_NavigationServer2D_method_set_active: + +.. rst-class:: classref-method + +|void| **set_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` + +Control activation of this server. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer2D_method_set_debug_enabled: .. rst-class:: classref-method diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index 5b423112570..6bc2da800d1 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -1283,6 +1283,8 @@ Create a new map. |void| **map_force_update**\ (\ map\: :ref:`RID`\ ) :ref:`🔗` +**Deprecated:** This method is no longer supported, as it is incompatible with asynchronous updates. It can only be used in a single-threaded context, at your own risk. + This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed). Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update. diff --git a/classes/class_node.rst b/classes/class_node.rst index 9c045ec4337..4877ae41023 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -62,35 +62,49 @@ Properties .. table:: :widths: auto - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`AutoTranslateMode` | :ref:`auto_translate_mode` | ``0`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`editor_description` | ``""`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`MultiplayerAPI` | :ref:`multiplayer` | | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`StringName` | :ref:`name` | | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`Node` | :ref:`owner` | | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`PhysicsInterpolationMode` | :ref:`physics_interpolation_mode` | ``0`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`ProcessMode` | :ref:`process_mode` | ``0`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`process_physics_priority` | ``0`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`process_priority` | ``0`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`ProcessThreadGroup` | :ref:`process_thread_group` | ``0`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`int` | :ref:`process_thread_group_order` | | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | |bitfield|\[:ref:`ProcessThreadMessages`\] | :ref:`process_thread_messages` | | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`String` | :ref:`scene_file_path` | | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ - | :ref:`bool` | :ref:`unique_name_in_owner` | ``false`` | - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------+-----------+ + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_controls_nodes` | ``[]`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_described_by_nodes` | ``[]`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`accessibility_description` | ``""`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_flow_to_nodes` | ``[]`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`Array`\[:ref:`NodePath`\] | :ref:`accessibility_labeled_by_nodes` | ``[]`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`AccessibilityLiveMode` | :ref:`accessibility_live` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`accessibility_name` | ``""`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`AutoTranslateMode` | :ref:`auto_translate_mode` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`editor_description` | ``""`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`MultiplayerAPI` | :ref:`multiplayer` | | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`StringName` | :ref:`name` | | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`Node` | :ref:`owner` | | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`PhysicsInterpolationMode` | :ref:`physics_interpolation_mode` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`ProcessMode` | :ref:`process_mode` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process_physics_priority` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process_priority` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`ProcessThreadGroup` | :ref:`process_thread_group` | ``0`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`int` | :ref:`process_thread_group_order` | | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | |bitfield|\[:ref:`ProcessThreadMessages`\] | :ref:`process_thread_messages` | | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`String` | :ref:`scene_file_path` | | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`unique_name_in_owner` | ``false`` | + +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group @@ -105,8 +119,14 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_exit_tree`\ (\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_accessibility_configuration_warnings`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_accessibility_container_name`\ (\ node\: :ref:`Node`\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_configuration_warnings`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_get_focused_accessibility_element`\ (\ ) |virtual| |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_input`\ (\ event\: :ref:`InputEvent`\ ) |virtual| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_physics_process`\ (\ delta\: :ref:`float`\ ) |virtual| | @@ -147,6 +167,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`find_parent`\ (\ pattern\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_accessibility_element`\ (\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_child`\ (\ idx\: :ref:`int`, include_internal\: :ref:`bool` = false\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_child_count`\ (\ include_internal\: :ref:`bool` = false\ ) |const| | @@ -249,6 +271,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`propagate_notification`\ (\ what\: :ref:`int`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`queue_accessibility_update`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`queue_free`\ (\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_child`\ (\ node\: :ref:`Node`\ ) | @@ -624,7 +648,7 @@ enum **DuplicateFlags**: :ref:`🔗` :ref:`DuplicateFlags` **DUPLICATE_SIGNALS** = ``1`` -Duplicate the node's signal connections. +Duplicate the node's signal connections that are connected with the :ref:`Object.CONNECT_PERSIST` flag. .. _class_Node_constant_DUPLICATE_GROUPS: @@ -1023,6 +1047,14 @@ Notification received when the mouse cursor enters the :ref:`Viewport`'s visible area, that is not occluded behind other :ref:`Control`\ s or :ref:`Window`\ s, provided its :ref:`Viewport.gui_disable_input` is ``false`` and regardless if it's currently focused or not. +.. _class_Node_constant_NOTIFICATION_WM_POSITION_CHANGED: + +.. rst-class:: classref-constant + +**NOTIFICATION_WM_POSITION_CHANGED** = ``1012`` :ref:`🔗` + +Notification received when the window is moved. + .. _class_Node_constant_NOTIFICATION_OS_MEMORY_WARNING: .. rst-class:: classref-constant @@ -1131,6 +1163,22 @@ Implemented on desktop and mobile platforms. Notification received when the :ref:`TextServer` is changed. +.. _class_Node_constant_NOTIFICATION_ACCESSIBILITY_UPDATE: + +.. rst-class:: classref-constant + +**NOTIFICATION_ACCESSIBILITY_UPDATE** = ``3000`` :ref:`🔗` + +Notification received when an accessibility information update is required. + +.. _class_Node_constant_NOTIFICATION_ACCESSIBILITY_INVALIDATE: + +.. rst-class:: classref-constant + +**NOTIFICATION_ACCESSIBILITY_INVALIDATE** = ``3001`` :ref:`🔗` + +Notification received when accessibility elements are invalidated. All node accessibility elements are automatically deleted after receiving this message, therefore all existing references to such elements should be discarded. + .. rst-class:: classref-section-separator ---- @@ -1140,6 +1188,125 @@ Notification received when the :ref:`TextServer` is changed. Property Descriptions --------------------- +.. _class_Node_property_accessibility_controls_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_controls_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_controls_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_controls_nodes**\ (\ ) + +The list of nodes which are controlled by this node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_property_accessibility_described_by_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_described_by_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_described_by_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_described_by_nodes**\ (\ ) + +The list of nodes which are describing this node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_property_accessibility_description: + +.. rst-class:: classref-property + +:ref:`String` **accessibility_description** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_description**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_accessibility_description**\ (\ ) + +The human-readable node description that is reported to assistive apps. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_property_accessibility_flow_to_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_flow_to_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_flow_to_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_flow_to_nodes**\ (\ ) + +The list of nodes which this node flows into. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_property_accessibility_labeled_by_nodes: + +.. rst-class:: classref-property + +:ref:`Array`\[:ref:`NodePath`\] **accessibility_labeled_by_nodes** = ``[]`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_labeled_by_nodes**\ (\ value\: :ref:`Array`\[:ref:`NodePath`\]\ ) +- :ref:`Array`\[:ref:`NodePath`\] **get_accessibility_labeled_by_nodes**\ (\ ) + +The list of nodes which label this node. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_property_accessibility_live: + +.. rst-class:: classref-property + +:ref:`AccessibilityLiveMode` **accessibility_live** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_live**\ (\ value\: :ref:`AccessibilityLiveMode`\ ) +- :ref:`AccessibilityLiveMode` **get_accessibility_live**\ (\ ) + +Live region update mode, a live region is **Node** that is updated as a result of an external event when user focus may be elsewhere. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_property_accessibility_name: + +.. rst-class:: classref-property + +:ref:`String` **accessibility_name** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_accessibility_name**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_accessibility_name**\ (\ ) + +The human-readable node name that is reported to assistive apps. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_property_auto_translate_mode: .. rst-class:: classref-property @@ -1428,6 +1595,32 @@ Corresponds to the :ref:`NOTIFICATION_EXIT_TREE` **_get_accessibility_configuration_warnings**\ (\ ) |virtual| |const| :ref:`🔗` + +The elements in the array returned from this method are displayed as warnings in the Scene dock if the script that overrides it is a ``tool`` script, and accessibility warnings are enabled in the editor settings. + +Returning an empty array produces no warnings. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Node_private_method__get_accessibility_container_name: + +.. rst-class:: classref-method + +:ref:`String` **_get_accessibility_container_name**\ (\ node\: :ref:`Node`\ ) |virtual| |const| :ref:`🔗` + +Return a human-readable description of the position of ``node`` child in the custom container, added to the node name. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_private_method__get_configuration_warnings: .. rst-class:: classref-method @@ -1457,6 +1650,18 @@ Call :ref:`update_configuration_warnings()` **_get_focused_accessibility_element**\ (\ ) |virtual| |const| :ref:`🔗` + +Called during accessibility information updates to determine the currently focused sub-element, should return a sub-element RID or the value returned by :ref:`get_accessibility_element()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_private_method__input: .. rst-class:: classref-method @@ -1611,7 +1816,7 @@ Adds a child ``node``. Nodes can have any number of children, but every child mu If ``force_readable_name`` is ``true``, improves the readability of the added ``node``. If not named, the ``node`` is renamed to its type, and if it shares :ref:`name` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations. -If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED`, the child will be added as internal node. These nodes are ignored by methods like :ref:`get_children()`, unless their parameter ``include_internal`` is ``true``. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker`. See :ref:`InternalMode` for available modes. +If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED`, the child will be added as internal node. These nodes are ignored by methods like :ref:`get_children()`, unless their parameter ``include_internal`` is ``true``. It also prevents these nodes being duplicated with their parent. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker`. See :ref:`InternalMode` for available modes. \ **Note:** If ``node`` already has a parent, this method will fail. Use :ref:`remove_child()` first to remove ``node`` from its current parent. For example: @@ -1805,7 +2010,7 @@ The Tween will start automatically on the next process frame or physics frame (d :ref:`Node` **duplicate**\ (\ flags\: :ref:`int` = 15\ ) |const| :ref:`🔗` -Duplicates the node, returning a new node with all of its properties, signals, groups, and children copied from the original. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags`). +Duplicates the node, returning a new node with all of its properties, signals, groups, and children copied from the original. The behavior can be tweaked through the ``flags`` (see :ref:`DuplicateFlags`). Internal nodes are not duplicated. \ **Note:** For nodes with a :ref:`Script` attached, if :ref:`Object._init()` has been defined with required parameters, the duplicated node will not have a :ref:`Script`. @@ -1869,6 +2074,20 @@ Finds the first ancestor of this node whose :ref:`name ---- +.. _class_Node_method_get_accessibility_element: + +.. rst-class:: classref-method + +:ref:`RID` **get_accessibility_element**\ (\ ) |const| :ref:`🔗` + +Returns main accessibility element RID. + +\ **Note:** This method should be called only during accessibility information updates (:ref:`NOTIFICATION_ACCESSIBILITY_UPDATE`). + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_get_child: .. rst-class:: classref-method @@ -2679,6 +2898,18 @@ Calls :ref:`Object.notification()` with ``what ---- +.. _class_Node_method_queue_accessibility_update: + +.. rst-class:: classref-method + +|void| **queue_accessibility_update**\ (\ ) :ref:`🔗` + +Queues an accessibility information update for this node. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node_method_queue_free: .. rst-class:: classref-method diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index 8ba021f5f13..1735cf4251a 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -1,5 +1,8 @@ :github_url: hide +.. meta:: + :keywords: spatial + .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. @@ -14,20 +17,20 @@ Node3D **Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationObstacle3D`, :ref:`NavigationRegion3D`, :ref:`OpenXRCompositionLayer`, :ref:`OpenXRHand`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SkeletonModifier3D`, :ref:`SpringArm3D`, :ref:`SpringBoneCollision3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRFaceModifier3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` -Most basic 3D game object, parent of all 3D-related nodes. +Base object in 3D space, inherited by all 3D nodes. .. rst-class:: classref-introduction-group Description ----------- -Most basic 3D game object, with a :ref:`Transform3D` and visibility settings. All other 3D game objects inherit from **Node3D**. Use **Node3D** as a parent node to move, scale, rotate and show/hide children in a 3D project. +The **Node3D** node is the base representation of a node in 3D space. All other 3D nodes inherit from this class. -Affine operations (rotate, scale, translate) happen in parent's local coordinate system, unless the **Node3D** object is set as top-level. Affine operations in this coordinate system correspond to direct affine operations on the **Node3D**'s transform. The word local below refers to this coordinate system. The coordinate system that is attached to the **Node3D** object itself is referred to as object-local coordinate system. +Affine operations (translation, rotation, scale) are calculated in the coordinate system relative to the parent, unless the **Node3D**'s :ref:`top_level` is ``true``. In this coordinate system, affine operations correspond to direct affine operations on the **Node3D**'s :ref:`transform`. The term *parent space* refers to this coordinate system. The coordinate system that is attached to the **Node3D** itself is referred to as object-local coordinate system, or *local space*. -\ **Note:** Unless otherwise specified, all methods that have angle parameters must have angles specified as *radians*. To convert degrees to radians, use :ref:`@GlobalScope.deg_to_rad()`. +\ **Note:** Unless otherwise specified, all methods that need angle parameters must receive angles in *radians*. To convert degrees to radians, use :ref:`@GlobalScope.deg_to_rad()`. -\ **Note:** Be aware that "Spatial" nodes are now called "Node3D" starting with Godot 4. Any Godot 3.x references to "Spatial" nodes refer to "Node3D" in Godot 4. +\ **Note:** In Godot 3 and older, **Node3D** was named *Spatial*. .. rst-class:: classref-introduction-group @@ -181,7 +184,9 @@ Signals **visibility_changed**\ (\ ) :ref:`🔗` -Emitted when node visibility changes. +Emitted when this node's visibility changes (see :ref:`visible` and :ref:`is_visible_in_tree()`). + +This signal is emitted *after* the related :ref:`NOTIFICATION_VISIBILITY_CHANGED` notification. .. rst-class:: classref-section-separator @@ -204,7 +209,7 @@ enum **RotationEditMode**: :ref:`🔗` :ref:`RotationEditMode` **ROTATION_EDIT_MODE_EULER** = ``0`` -The rotation is edited using :ref:`Vector3` Euler angles. +The rotation is edited using a :ref:`Vector3` in `Euler angles `__. .. _class_Node3D_constant_ROTATION_EDIT_MODE_QUATERNION: @@ -220,7 +225,7 @@ The rotation is edited using a :ref:`Quaternion`. :ref:`RotationEditMode` **ROTATION_EDIT_MODE_BASIS** = ``2`` -The rotation is edited using a :ref:`Basis`. In this mode, :ref:`scale` can't be edited separately. +The rotation is edited using a :ref:`Basis`. In this mode, the raw :ref:`basis`'s axes can be freely modified, but the :ref:`scale` property is not available. .. rst-class:: classref-section-separator @@ -237,9 +242,11 @@ Constants **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗` -**Node3D** nodes receive this notification when their global transform changes. This means that either the current or a parent node changed its transform. +Notification received when this node's :ref:`global_transform` changes, if :ref:`is_transform_notification_enabled()` is ``true``. See also :ref:`set_notify_transform()`. + +\ **Note:** Most 3D nodes such as :ref:`VisualInstance3D` or :ref:`CollisionObject3D` automatically enable this to function correctly. -In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` to work, users first need to ask for it, with :ref:`set_notify_transform()`. The notification is also sent if the node is in the editor context and it has at least one valid gizmo. +\ **Note:** In the editor, nodes will propagate this notification to their children if a gizmo is attached (see :ref:`add_gizmo()`). .. _class_Node3D_constant_NOTIFICATION_ENTER_WORLD: @@ -247,7 +254,7 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` -**Node3D** nodes receive this notification when they are registered to new :ref:`World3D` resource. +Notification received when this node is registered to a new :ref:`World3D` (see :ref:`get_world_3d()`). .. _class_Node3D_constant_NOTIFICATION_EXIT_WORLD: @@ -255,7 +262,7 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` -**Node3D** nodes receive this notification when they are unregistered from current :ref:`World3D` resource. +Notification received when this node is unregistered from the current :ref:`World3D` (see :ref:`get_world_3d()`). .. _class_Node3D_constant_NOTIFICATION_VISIBILITY_CHANGED: @@ -263,7 +270,9 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` -**Node3D** nodes receive this notification when their visibility changes. +Notification received when this node's visibility changes (see :ref:`visible` and :ref:`is_visible_in_tree()`). + +This notification is received *before* the related :ref:`visibility_changed` signal. .. _class_Node3D_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED: @@ -271,9 +280,9 @@ In order for :ref:`NOTIFICATION_TRANSFORM_CHANGED` -**Node3D** nodes receive this notification when their local transform changes. This is not received when the transform of a parent node is changed. +Notification received when this node's :ref:`transform` changes, if :ref:`is_local_transform_notification_enabled()` is ``true``. This is not received when a parent **Node3D**'s :ref:`transform` changes. See also :ref:`set_notify_local_transform()`. -In order for :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` to work, users first need to ask for it, with :ref:`set_notify_local_transform()`. +\ **Note:** Some 3D nodes such as :ref:`CSGShape3D` or :ref:`CollisionShape3D` automatically enable this to function correctly. .. rst-class:: classref-section-separator @@ -295,7 +304,7 @@ Property Descriptions - |void| **set_basis**\ (\ value\: :ref:`Basis`\ ) - :ref:`Basis` **get_basis**\ (\ ) -Basis of the :ref:`transform` property. Represents the rotation, scale, and shear of this node. +Basis of the :ref:`transform` property. Represents the rotation, scale, and shear of this node in parent space (relative to the parent node). .. rst-class:: classref-item-separator @@ -312,7 +321,9 @@ Basis of the :ref:`transform` property. Represe - |void| **set_global_basis**\ (\ value\: :ref:`Basis`\ ) - :ref:`Basis` **get_global_basis**\ (\ ) -Global basis of this node. This is equivalent to ``global_transform.basis``. +Basis of the :ref:`global_transform` property. Represents the rotation, scale, and shear of this node in global space (relative to the world). + +\ **Note:** If the node is not inside the tree, getting this property fails and returns :ref:`Basis.IDENTITY`. .. rst-class:: classref-item-separator @@ -329,7 +340,9 @@ Global basis of this node. This is equivalent to ``global_transform.basis``. - |void| **set_global_position**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_global_position**\ (\ ) -Global position of this node. This is equivalent to ``global_transform.origin``. +Global position (translation) of this node in global space (relative to the world). This is equivalent to the :ref:`global_transform`'s :ref:`Transform3D.origin`. + +\ **Note:** If the node is not inside the tree, getting this property fails and returns :ref:`Vector3.ZERO`. .. rst-class:: classref-item-separator @@ -346,9 +359,17 @@ Global position of this node. This is equivalent to ``global_transform.origin``. - |void| **set_global_rotation**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_global_rotation**\ (\ ) -Rotation part of the global transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). +Global rotation of this node as `Euler angles `__, in radians and in global space (relative to the world). This value is obtained from :ref:`global_basis`'s rotation. + +- The :ref:`Vector3.x` is the angle around the global X axis (pitch); + +- The :ref:`Vector3.y` is the angle around the global Y axis (yaw); + +- The :ref:`Vector3.z` is the angle around the global Z axis (roll). -\ **Note:** In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. +\ **Note:** Unlike :ref:`rotation`, this property always follows the YXZ convention (:ref:`@GlobalScope.EULER_ORDER_YXZ`). + +\ **Note:** If the node is not inside the tree, getting this property fails and returns :ref:`Vector3.ZERO`. .. rst-class:: classref-item-separator @@ -365,7 +386,9 @@ Rotation part of the global transformation in radians, specified in terms of YXZ - |void| **set_global_rotation_degrees**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_global_rotation_degrees**\ (\ ) -Helper property to access :ref:`global_rotation` in degrees instead of radians. +The :ref:`global_rotation` of this node, in degrees instead of radians. + +\ **Note:** If the node is not inside the tree, getting this property fails and returns :ref:`Vector3.ZERO`. .. rst-class:: classref-item-separator @@ -382,7 +405,9 @@ Helper property to access :ref:`global_rotation`\ ) - :ref:`Transform3D` **get_global_transform**\ (\ ) -World3D space (global) :ref:`Transform3D` of this node. +The transformation of this node, in global space (relative to the world). Contains and represents this node's :ref:`global_position`, :ref:`global_rotation`, and global scale. + +\ **Note:** If the node is not inside the tree, getting this property fails and returns :ref:`Transform3D.IDENTITY`. .. rst-class:: classref-item-separator @@ -399,7 +424,7 @@ World3D space (global) :ref:`Transform3D` of this node. - |void| **set_position**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_position**\ (\ ) -Local position or translation of this node relative to the parent. This is equivalent to ``transform.origin``. +Position (translation) of this node in parent space (relative to the parent node). This is equivalent to the :ref:`transform`'s :ref:`Transform3D.origin`. .. rst-class:: classref-item-separator @@ -416,7 +441,9 @@ Local position or translation of this node relative to the parent. This is equiv - |void| **set_quaternion**\ (\ value\: :ref:`Quaternion`\ ) - :ref:`Quaternion` **get_quaternion**\ (\ ) -Access to the node rotation as a :ref:`Quaternion`. This property is ideal for tweening complex rotations. +Rotation of this node represented as a :ref:`Quaternion` in parent space (relative to the parent node). This value is obtained from :ref:`basis`'s rotation. + +\ **Note:** Quaternions are much more suitable for 3D math but are less intuitive. Setting this property can be useful for interpolation (see :ref:`Quaternion.slerp()`). .. rst-class:: classref-item-separator @@ -433,11 +460,17 @@ Access to the node rotation as a :ref:`Quaternion`. This prope - |void| **set_rotation**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_rotation**\ (\ ) -Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotation in the order specified by the :ref:`rotation_order` property. +Rotation of this node as `Euler angles `__, in radians and in parent space (relative to the parent node). This value is obtained from :ref:`basis`'s rotation. -\ **Note:** In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a :ref:`Vector3` data structure not because the rotation is a vector, but only because :ref:`Vector3` exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. +- The :ref:`Vector3.x` is the angle around the local X axis (pitch); -\ **Note:** This property is edited in the inspector in degrees. If you want to use degrees in a script, use :ref:`rotation_degrees`. +- The :ref:`Vector3.y` is the angle around the local Y axis (yaw); + +- The :ref:`Vector3.z` is the angle around the local Z axis (roll). + +The order of each consecutive rotation can be changed with :ref:`rotation_order` (see :ref:`EulerOrder` constants). By default, the YXZ convention is used (:ref:`@GlobalScope.EULER_ORDER_YXZ`). + +\ **Note:** This property is edited in degrees in the inspector. If you want to use degrees in a script, use :ref:`rotation_degrees`. .. rst-class:: classref-item-separator @@ -454,7 +487,9 @@ Rotation part of the local transformation in radians, specified in terms of Eule - |void| **set_rotation_degrees**\ (\ value\: :ref:`Vector3`\ ) - :ref:`Vector3` **get_rotation_degrees**\ (\ ) -Helper property to access :ref:`rotation` in degrees instead of radians. +The :ref:`rotation` of this node, in degrees instead of radians. + +\ **Note:** This is **not** the property available in the Inspector dock. .. rst-class:: classref-item-separator @@ -471,7 +506,7 @@ Helper property to access :ref:`rotation` in deg - |void| **set_rotation_edit_mode**\ (\ value\: :ref:`RotationEditMode`\ ) - :ref:`RotationEditMode` **get_rotation_edit_mode**\ (\ ) -Specify how rotation (and scale) will be presented in the editor. +How this node's rotation and scale are displayed in the Inspector dock. .. rst-class:: classref-item-separator @@ -488,7 +523,7 @@ Specify how rotation (and scale) will be presented in the editor. - |void| **set_rotation_order**\ (\ value\: :ref:`EulerOrder`\ ) - :ref:`EulerOrder` **get_rotation_order**\ (\ ) -Specify the axis rotation order of the :ref:`rotation` property. The final orientation is constructed by rotating the Euler angles in the order specified by this property. +The axis rotation order of the :ref:`rotation` property. The final orientation is calculated by rotating around the local X, Y, and Z axis in this order. .. rst-class:: classref-item-separator @@ -505,11 +540,11 @@ Specify the axis rotation order of the :ref:`rotation`\ ) - :ref:`Vector3` **get_scale**\ (\ ) -Scale part of the local transformation. +Scale of this node in local space (relative to this node). This value is obtained from :ref:`basis`'s scale. -\ **Note:** Mixed negative scales in 3D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, the scale values will either be all positive or all negative. +\ **Note:** The behavior of some 3D node types is not affected by this property. These include :ref:`Light3D`, :ref:`Camera3D`, :ref:`AudioStreamPlayer3D`, and more. -\ **Note:** Not all nodes are visually scaled by the :ref:`scale` property. For example, :ref:`Light3D`\ s are not visually affected by :ref:`scale`. +\ **Warning:** The scale's components must either be all positive or all negative, and **not** exactly ``0.0``. Otherwise, it won't be possible to obtain the scale from the :ref:`basis`. This may cause the intended scale to be lost when reloaded from disk, and potentially other unstable behavior. .. rst-class:: classref-item-separator @@ -526,7 +561,7 @@ Scale part of the local transformation. - |void| **set_as_top_level**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_set_as_top_level**\ (\ ) -If ``true``, the node will not inherit its transformations from its parent. Node transformations are only in global space. +If ``true``, the node does not inherit its transformations from its parent. As such, node transformations will only be in global space, which also means that :ref:`global_transform` and :ref:`transform` will be identical. .. rst-class:: classref-item-separator @@ -543,7 +578,7 @@ If ``true``, the node will not inherit its transformations from its parent. Node - |void| **set_transform**\ (\ value\: :ref:`Transform3D`\ ) - :ref:`Transform3D` **get_transform**\ (\ ) -Local space :ref:`Transform3D` of this node, with respect to the parent node. +The local transformation of this node, in parent space (relative to the parent node). Contains and represents this node's :ref:`position`, :ref:`rotation`, and :ref:`scale`. .. rst-class:: classref-item-separator @@ -560,7 +595,9 @@ Local space :ref:`Transform3D` of this node, with respect to - |void| **set_visibility_parent**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_visibility_parent**\ (\ ) -Defines the visibility range parent for this node and its subtree. The visibility parent must be a GeometryInstance3D. Any visual instance will only be visible if the visibility parent (and all of its visibility ancestors) is hidden by being closer to the camera than its own :ref:`GeometryInstance3D.visibility_range_begin`. Nodes hidden via the :ref:`visible` property are essentially removed from the visibility dependency tree, so dependent instances will not take the hidden node or its ancestors into account. +Path to the visibility range parent for this node and its descendants. The visibility parent must be a :ref:`GeometryInstance3D`. + +Any visual instance will only be visible if the visibility parent (and all of its visibility ancestors) is hidden by being closer to the camera than its own :ref:`GeometryInstance3D.visibility_range_begin`. Nodes hidden via the :ref:`visible` property are essentially removed from the visibility dependency tree, so dependent instances will not take the hidden node or its descendants into account. .. rst-class:: classref-item-separator @@ -577,7 +614,7 @@ Defines the visibility range parent for this node and its subtree. The visibilit - |void| **set_visible**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_visible**\ (\ ) -If ``true``, this node is drawn. The node is only visible if all of its ancestors are visible as well (in other words, :ref:`is_visible_in_tree()` must return ``true``). +If ``true``, this node can be visible. The node is only rendered when all of its ancestors are visible, as well. That means :ref:`is_visible_in_tree()` must return ``true``. .. rst-class:: classref-section-separator @@ -594,9 +631,9 @@ Method Descriptions |void| **add_gizmo**\ (\ gizmo\: :ref:`Node3DGizmo`\ ) :ref:`🔗` -Attach an editor gizmo to this **Node3D**. +Attaches the given ``gizmo`` to this node. Only works in the editor. -\ **Note:** The gizmo object would typically be an instance of :ref:`EditorNode3DGizmo`, but the argument type is kept generic to avoid creating a dependency on editor classes in **Node3D**. +\ **Note:** ``gizmo`` should be an :ref:`EditorNode3DGizmo`. The argument type is :ref:`Node3DGizmo` to avoid depending on editor classes in **Node3D**. .. rst-class:: classref-item-separator @@ -608,7 +645,7 @@ Attach an editor gizmo to this **Node3D**. |void| **clear_gizmos**\ (\ ) :ref:`🔗` -Clear all gizmos attached to this **Node3D**. +Clears all :ref:`EditorNode3DGizmo` objects attached to this node. Only works in the editor. .. rst-class:: classref-item-separator @@ -620,7 +657,7 @@ Clear all gizmos attached to this **Node3D**. |void| **clear_subgizmo_selection**\ (\ ) :ref:`🔗` -Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs become invalid after a property change. +Deselects all subgizmos for this node. Useful to call when the selected subgizmo may no longer exist after a property change. Only works in the editor. .. rst-class:: classref-item-separator @@ -632,7 +669,9 @@ Clears subgizmo selection for this node in the editor. Useful when subgizmo IDs |void| **force_update_transform**\ (\ ) :ref:`🔗` -Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. +Forces the node's :ref:`global_transform` to update, by sending :ref:`NOTIFICATION_TRANSFORM_CHANGED`. Fails if the node is not inside the tree. + +\ **Note:** For performance reasons, transform changes are usually accumulated and applied *once* at the end of the frame. The update propagates through **Node3D** children, as well. Therefore, use this method only when you need an up-to-date transform (such as during physics operations). .. rst-class:: classref-item-separator @@ -644,7 +683,7 @@ Forces the transform to update. Transform changes in physics are not instant for :ref:`Array`\[:ref:`Node3DGizmo`\] **get_gizmos**\ (\ ) |const| :ref:`🔗` -Returns all the gizmos attached to this **Node3D**. +Returns all the :ref:`EditorNode3DGizmo` objects attached to this node. Only works in the editor. .. rst-class:: classref-item-separator @@ -672,9 +711,9 @@ This is particularly important for frame-based operations that take place in :re :ref:`Node3D` **get_parent_node_3d**\ (\ ) |const| :ref:`🔗` -Returns the parent **Node3D**, or ``null`` if no parent exists, the parent is not of type **Node3D**, or :ref:`top_level` is ``true``. +Returns the parent **Node3D** that directly affects this node's :ref:`global_transform`. Returns ``null`` if no parent exists, the parent is not a **Node3D**, or :ref:`top_level` is ``true``. -\ **Note:** Calling this method is not equivalent to ``get_parent() as Node3D``, which does not take :ref:`top_level` into account. +\ **Note:** This method is not always equivalent to :ref:`Node.get_parent()`, which does not take :ref:`top_level` into account. .. rst-class:: classref-item-separator @@ -686,7 +725,9 @@ Returns the parent **Node3D**, or ``null`` if no parent exists, the parent is no :ref:`World3D` **get_world_3d**\ (\ ) |const| :ref:`🔗` -Returns the current :ref:`World3D` resource this **Node3D** node is registered to. +Returns the :ref:`World3D` this node is registered to. + +Usually, this is the same as the world used by this node's viewport (see :ref:`Node.get_viewport()` and :ref:`Viewport.find_world_3d()`). .. rst-class:: classref-item-separator @@ -698,7 +739,7 @@ Returns the current :ref:`World3D` resource this **Node3D** node |void| **global_rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` -Rotates the global (world) transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in global coordinate system. +Rotates this node's :ref:`global_basis` around the global ``axis`` by the given ``angle``, in radians. This operation is calculated in global space (relative to the world) and preserves the :ref:`global_position`. .. rst-class:: classref-item-separator @@ -710,7 +751,9 @@ Rotates the global (world) transformation around axis, a unit :ref:`Vector3`\ ) :ref:`🔗` -Scales the global (world) transformation by the given :ref:`Vector3` scale factors. +Scales this node's :ref:`global_basis` by the given ``scale`` factor. This operation is calculated in global space (relative to the world) and preserves the :ref:`global_position`. + +\ **Note:** This method is not to be confused with the :ref:`scale` property. .. rst-class:: classref-item-separator @@ -722,7 +765,7 @@ Scales the global (world) transformation by the given :ref:`Vector3`\ ) :ref:`🔗` -Moves the global (world) transformation by :ref:`Vector3` offset. The offset is in global coordinate system. +Adds the given translation ``offset`` to the node's :ref:`global_position` in global space (relative to the world). .. rst-class:: classref-item-separator @@ -734,7 +777,7 @@ Moves the global (world) transformation by :ref:`Vector3` offset. |void| **hide**\ (\ ) :ref:`🔗` -Disables rendering of this node. Changes :ref:`visible` to ``false``. +Prevents this node from being rendered. Equivalent to setting :ref:`visible` to ``false``. This is the opposite of :ref:`show()`. .. rst-class:: classref-item-separator @@ -746,7 +789,7 @@ Disables rendering of this node. Changes :ref:`visible` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -Returns whether node notifies about its local transformation changes. **Node3D** will not propagate this by default. +Returns ``true`` if the node receives :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` whenever :ref:`transform` changes. This is enabled with :ref:`set_notify_local_transform()`. .. rst-class:: classref-item-separator @@ -758,7 +801,9 @@ Returns whether node notifies about its local transformation changes. **Node3D** :ref:`bool` **is_scale_disabled**\ (\ ) |const| :ref:`🔗` -Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformation scale. +Returns ``true`` if this node's :ref:`global_transform` is automatically orthonormalized. This results in this node not appearing distorted, as if its global scale were set to :ref:`Vector3.ONE` (or its negative counterpart). See also :ref:`set_disable_scale()` and :ref:`orthonormalize()`. + +\ **Note:** :ref:`transform` is not affected by this setting. .. rst-class:: classref-item-separator @@ -770,7 +815,7 @@ Returns whether this node uses a scale of ``(1, 1, 1)`` or its local transformat :ref:`bool` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗` -Returns whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default. +Returns ``true`` if the node receives :ref:`NOTIFICATION_TRANSFORM_CHANGED` whenever :ref:`global_transform` changes. This is enabled with :ref:`set_notify_transform()`. .. rst-class:: classref-item-separator @@ -782,11 +827,9 @@ Returns whether the node notifies about its global and local transformation chan :ref:`bool` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if the node is present in the :ref:`SceneTree`, its :ref:`visible` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree. +Returns ``true`` if this node is inside the scene tree and the :ref:`visible` property is ``true`` for this node and all of its **Node3D** ancestors *in sequence*. An ancestor of any other type (such as :ref:`Node` or :ref:`Node2D`) breaks the sequence. See also :ref:`Node.get_parent()`. -Visibility is checked only in parent nodes that inherit from **Node3D**. If the parent is of any other type (such as :ref:`Node`, :ref:`AnimationPlayer`, or :ref:`Node2D`), it is assumed to be visible. - -\ **Note:** This method does not take :ref:`VisualInstance3D.layers` into account, so even if this method returns ``true``, the node might end up not being rendered. +\ **Note:** This method cannot take :ref:`VisualInstance3D.layers` into account, so even if this method returns ``true``, the node may not be rendered. .. rst-class:: classref-item-separator @@ -798,18 +841,16 @@ Visibility is checked only in parent nodes that inherit from **Node3D**. If the |void| **look_at**\ (\ target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) :ref:`🔗` -Rotates the node so that the local forward axis (-Z, :ref:`Vector3.FORWARD`) points toward the ``target`` position. +Rotates the node so that the local forward axis (-Z, :ref:`Vector3.FORWARD`) points toward the ``target`` position. This operation is calculated in global space (relative to the world). The local up axis (+Y) points as close to the ``up`` vector as possible while staying perpendicular to the local forward axis. The resulting transform is orthogonal, and the scale is preserved. Non-uniform scaling may not work correctly. -The ``target`` position cannot be the same as the node's position, the ``up`` vector cannot be zero. - -The ``target`` and the ``up`` cannot be :ref:`Vector3.ZERO`, and shouldn't be colinear to avoid unintended rotation around local Z axis. - -Operations take place in global space, which means that the node must be in the scene tree. +The ``target`` position cannot be the same as the node's position, the ``up`` vector cannot be :ref:`Vector3.ZERO`. Furthermore, the direction from the node's position to the ``target`` position cannot be parallel to the ``up`` vector, to avoid an unintended rotation around the local Z axis. If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forward (implies +X is left) and points toward the ``target`` position. By default, the -Z axis (camera forward) is treated as forward (implies +X is right). +\ **Note:** This method fails if the node is not in the scene tree. If necessary, use :ref:`look_at_from_position()` instead. + .. rst-class:: classref-item-separator ---- @@ -820,7 +861,7 @@ If ``use_model_front`` is ``true``, the +Z axis (asset front) is treated as forw |void| **look_at_from_position**\ (\ position\: :ref:`Vector3`, target\: :ref:`Vector3`, up\: :ref:`Vector3` = Vector3(0, 1, 0), use_model_front\: :ref:`bool` = false\ ) :ref:`🔗` -Moves the node to the specified ``position``, and then rotates the node to point toward the ``target`` as per :ref:`look_at()`. Operations take place in global space. +Moves the node to the specified ``position``, then rotates the node to point toward the ``target`` position, similar to :ref:`look_at()`. This operation is calculated in global space (relative to the world). .. rst-class:: classref-item-separator @@ -832,7 +873,7 @@ Moves the node to the specified ``position``, and then rotates the node to point |void| **orthonormalize**\ (\ ) :ref:`🔗` -Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's :ref:`Transform3D`. +Orthonormalizes this node's :ref:`basis`. This method sets this node's :ref:`scale` to :ref:`Vector3.ONE` (or its negative counterpart), but preserves the :ref:`position` and :ref:`rotation`. See also :ref:`Transform3D.orthonormalized()`. .. rst-class:: classref-item-separator @@ -844,7 +885,7 @@ Resets this node's transformations (like scale, skew and taper) preserving its r |void| **rotate**\ (\ axis\: :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` -Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. +Rotates this node's :ref:`basis` around the ``axis`` by the given ``angle``, in radians. This operation is calculated in parent space (relative to the parent) and preserves the :ref:`position`. .. rst-class:: classref-item-separator @@ -856,7 +897,7 @@ Rotates the local transformation around axis, a unit :ref:`Vector3`, angle\: :ref:`float`\ ) :ref:`🔗` -Rotates the local transformation around axis, a unit :ref:`Vector3`, by specified angle in radians. The rotation axis is in object-local coordinate system. +Rotates this node's :ref:`basis` around the ``axis`` by the given ``angle``, in radians. This operation is calculated in local space (relative to this node) and preserves the :ref:`position`. .. rst-class:: classref-item-separator @@ -868,7 +909,7 @@ Rotates the local transformation around axis, a unit :ref:`Vector3`\ ) :ref:`🔗` -Rotates the local transformation around the X axis by angle in radians. +Rotates this node's :ref:`basis` around the X axis by the given ``angle``, in radians. This operation is calculated in parent space (relative to the parent) and preserves the :ref:`position`. .. rst-class:: classref-item-separator @@ -880,7 +921,7 @@ Rotates the local transformation around the X axis by angle in radians. |void| **rotate_y**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` -Rotates the local transformation around the Y axis by angle in radians. +Rotates this node's :ref:`basis` around the Y axis by the given ``angle``, in radians. This operation is calculated in parent space (relative to the parent) and preserves the :ref:`position`. .. rst-class:: classref-item-separator @@ -892,7 +933,7 @@ Rotates the local transformation around the Y axis by angle in radians. |void| **rotate_z**\ (\ angle\: :ref:`float`\ ) :ref:`🔗` -Rotates the local transformation around the Z axis by angle in radians. +Rotates this node's :ref:`basis` around the Z axis by the given ``angle``, in radians. This operation is calculated in parent space (relative to the parent) and preserves the :ref:`position`. .. rst-class:: classref-item-separator @@ -904,7 +945,7 @@ Rotates the local transformation around the Z axis by angle in radians. |void| **scale_object_local**\ (\ scale\: :ref:`Vector3`\ ) :ref:`🔗` -Scales the local transformation by given 3D scale factors in object-local coordinate system. +Scales this node's :ref:`basis` by the given ``scale`` factor. This operation is calculated in local space (relative to this node) and preserves the :ref:`position`. .. rst-class:: classref-item-separator @@ -916,7 +957,9 @@ Scales the local transformation by given 3D scale factors in object-local coordi |void| **set_disable_scale**\ (\ disable\: :ref:`bool`\ ) :ref:`🔗` -Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation scale. Changes to the local transformation scale are preserved. +If ``true``, this node's :ref:`global_transform` is automatically orthonormalized. This results in this node not appearing distorted, as if its global scale were set to :ref:`Vector3.ONE` (or its negative counterpart). See also :ref:`is_scale_disabled()` and :ref:`orthonormalize()`. + +\ **Note:** :ref:`transform` is not affected by this setting. .. rst-class:: classref-item-separator @@ -928,7 +971,7 @@ Sets whether the node uses a scale of ``(1, 1, 1)`` or its local transformation |void| **set_identity**\ (\ ) :ref:`🔗` -Reset all transformations for this node (sets its :ref:`Transform3D` to the identity matrix). +Sets this node's :ref:`transform` to :ref:`Transform3D.IDENTITY`, which resets all transformations in parent space (:ref:`position`, :ref:`rotation`, and :ref:`scale`). .. rst-class:: classref-item-separator @@ -940,7 +983,9 @@ Reset all transformations for this node (sets its :ref:`Transform3D`\ ) :ref:`🔗` -Sets whether the node ignores notification that its transformation (global or local) changed. +If ``true``, the node will not receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` or :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED`. + +It may useful to call this method when handling these notifications to prevent infinite recursion. .. rst-class:: classref-item-separator @@ -952,7 +997,9 @@ Sets whether the node ignores notification that its transformation (global or lo |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -Sets whether the node notifies about its local transformation changes. **Node3D** will not propagate this by default. +If ``true``, the node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED` whenever :ref:`transform` changes. + +\ **Note:** Some 3D nodes such as :ref:`CSGShape3D` or :ref:`CollisionShape3D` automatically enable this to function correctly. .. rst-class:: classref-item-separator @@ -964,7 +1011,11 @@ Sets whether the node notifies about its local transformation changes. **Node3D* |void| **set_notify_transform**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` -Sets whether the node notifies about its global and local transformation changes. **Node3D** will not propagate this by default, unless it is in the editor context and it has a valid gizmo. +If ``true``, the node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED` whenever :ref:`global_transform` changes. + +\ **Note:** Most 3D nodes such as :ref:`VisualInstance3D` or :ref:`CollisionObject3D` automatically enable this to function correctly. + +\ **Note:** In the editor, nodes will propagate this notification to their children if a gizmo is attached (see :ref:`add_gizmo()`). .. rst-class:: classref-item-separator @@ -976,7 +1027,7 @@ Sets whether the node notifies about its global and local transformation changes |void| **set_subgizmo_selection**\ (\ gizmo\: :ref:`Node3DGizmo`, id\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` -Set subgizmo selection for this node in the editor. +Selects the ``gizmo``'s subgizmo with the given ``id`` and sets its transform. Only works in the editor. \ **Note:** The gizmo object would typically be an instance of :ref:`EditorNode3DGizmo`, but the argument type is kept generic to avoid creating a dependency on editor classes in **Node3D**. @@ -990,7 +1041,7 @@ Set subgizmo selection for this node in the editor. |void| **show**\ (\ ) :ref:`🔗` -Enables rendering of this node. Changes :ref:`visible` to ``true``. +Allows this node to be rendered. Equivalent to setting :ref:`visible` to ``true``. This is the opposite of :ref:`hide()`. .. rst-class:: classref-item-separator @@ -1002,7 +1053,7 @@ Enables rendering of this node. Changes :ref:`visible` **to_global**\ (\ local_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -Transforms ``local_point`` from this node's local space to world space. +Returns the ``local_point`` converted from this node's local space to global space. This is the opposite of :ref:`to_local()`. .. rst-class:: classref-item-separator @@ -1014,7 +1065,7 @@ Transforms ``local_point`` from this node's local space to world space. :ref:`Vector3` **to_local**\ (\ global_point\: :ref:`Vector3`\ ) |const| :ref:`🔗` -Transforms ``global_point`` from world space to this node's local space. +Returns the ``global_point`` converted from global space to this node's local space. This is the opposite of :ref:`to_global()`. .. rst-class:: classref-item-separator @@ -1026,9 +1077,11 @@ Transforms ``global_point`` from world space to this node's local space. |void| **translate**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` -Changes the node's position by the given offset :ref:`Vector3`. +Adds the given translation ``offset`` to the node's position, in local space (relative to this node). + +\ **Note:** Prefer using :ref:`translate_object_local()`, instead, as this method may be changed in a future release. -Note that the translation ``offset`` is affected by the node's scale, so if scaled by e.g. ``(10, 1, 1)``, a translation by an offset of ``(2, 0, 0)`` would actually add 20 (``2 * 10``) to the X coordinate. +\ **Note:** Despite the naming convention, this operation is **not** calculated in parent space for compatibility reasons. To translate in parent space, add ``offset`` to the :ref:`position` (``node_3d.position += offset``). .. rst-class:: classref-item-separator @@ -1040,7 +1093,7 @@ Note that the translation ``offset`` is affected by the node's scale, so if scal |void| **translate_object_local**\ (\ offset\: :ref:`Vector3`\ ) :ref:`🔗` -Changes the node's position by the given offset :ref:`Vector3` in local space. +Adds the given translation ``offset`` to the node's position, in local space (relative to this node). .. rst-class:: classref-item-separator @@ -1052,7 +1105,7 @@ Changes the node's position by the given offset :ref:`Vector3` in |void| **update_gizmos**\ (\ ) :ref:`🔗` -Updates all the **Node3D** gizmos attached to this node. +Updates all the :ref:`EditorNode3DGizmo` objects attached to this node. Only works in the editor. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_object.rst b/classes/class_object.rst index 3e5daeab03e..4e27301d307 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`ShaderIncludeDB`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapper`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`ShaderIncludeDB`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` Base class for all other classes in the engine. @@ -533,8 +533,6 @@ Returns the current iterable value. ``iter`` stores the iteration state, but unl Initializes the iterator. ``iter`` stores the iteration state. Since GDScript does not support passing arguments by reference, a single-element array is used as a wrapper. Returns ``true`` so long as the iterator has not reached the end. -Example: - :: class MyRange: @@ -966,155 +964,11 @@ If this method is called during :ref:`NOTIFICATION_PREDELETE` constants). -A signal can only be connected once to the same :ref:`Callable`. If the signal is already connected, this method returns :ref:`@GlobalScope.ERR_INVALID_PARAMETER` and pushes an error message, unless the signal is connected with :ref:`CONNECT_REFERENCE_COUNTED`. To prevent this, use :ref:`is_connected()` first to check for existing connections. - -If the ``callable``'s object is freed, the connection will be lost. - -\ **Examples with recommended syntax:**\ - -Connecting signals is one of the most common operations in Godot and the API gives many options to do so, which are described further down. The code block below shows the recommended approach. - - -.. tabs:: - - .. code-tab:: gdscript - - func _ready(): - var button = Button.new() - # `button_down` here is a Signal variant type, and we thus call the Signal.connect() method, not Object.connect(). - # See discussion below for a more in-depth overview of the API. - button.button_down.connect(_on_button_down) - - # This assumes that a `Player` class exists, which defines a `hit` signal. - var player = Player.new() - # We use Signal.connect() again, and we also use the Callable.bind() method, - # which returns a new Callable with the parameter binds. - player.hit.connect(_on_player_hit.bind("sword", 100)) - - func _on_button_down(): - print("Button down!") - - func _on_player_hit(weapon_type, damage): - print("Hit with weapon %s for %d damage." % [weapon_type, damage]) - - .. code-tab:: csharp - - public override void _Ready() - { - var button = new Button(); - // C# supports passing signals as events, so we can use this idiomatic construct: - button.ButtonDown += OnButtonDown; - - // This assumes that a `Player` class exists, which defines a `Hit` signal. - var player = new Player(); - // We can use lambdas when we need to bind additional parameters. - player.Hit += () => OnPlayerHit("sword", 100); - } - - private void OnButtonDown() - { - GD.Print("Button down!"); - } - - private void OnPlayerHit(string weaponType, int damage) - { - GD.Print($"Hit with weapon {weaponType} for {damage} damage."); - } - - - -\ **\ ``Object.connect()`` or ``Signal.connect()``?**\ - -As seen above, the recommended method to connect signals is not :ref:`connect()`. The code block below shows the four options for connecting signals, using either this legacy method or the recommended :ref:`Signal.connect()`, and using either an implicit :ref:`Callable` or a manually defined one. - - -.. tabs:: - - .. code-tab:: gdscript - - func _ready(): - var button = Button.new() - # Option 1: Object.connect() with an implicit Callable for the defined function. - button.connect("button_down", _on_button_down) - # Option 2: Object.connect() with a constructed Callable using a target object and method name. - button.connect("button_down", Callable(self, "_on_button_down")) - # Option 3: Signal.connect() with an implicit Callable for the defined function. - button.button_down.connect(_on_button_down) - # Option 4: Signal.connect() with a constructed Callable using a target object and method name. - button.button_down.connect(Callable(self, "_on_button_down")) - - func _on_button_down(): - print("Button down!") - - .. code-tab:: csharp - - public override void _Ready() - { - var button = new Button(); - // Option 1: In C#, we can use signals as events and connect with this idiomatic syntax: - button.ButtonDown += OnButtonDown; - // Option 2: GodotObject.Connect() with a constructed Callable from a method group. - button.Connect(Button.SignalName.ButtonDown, Callable.From(OnButtonDown)); - // Option 3: GodotObject.Connect() with a constructed Callable using a target object and method name. - button.Connect(Button.SignalName.ButtonDown, new Callable(this, MethodName.OnButtonDown)); - } - - private void OnButtonDown() - { - GD.Print("Button down!"); - } - - - -While all options have the same outcome (``button``'s :ref:`BaseButton.button_down` signal will be connected to ``_on_button_down``), **option 3** offers the best validation: it will print a compile-time error if either the ``button_down`` :ref:`Signal` or the ``_on_button_down`` :ref:`Callable` are not defined. On the other hand, **option 2** only relies on string names and will only be able to validate either names at runtime: it will print a runtime error if ``"button_down"`` doesn't correspond to a signal, or if ``"_on_button_down"`` is not a registered method in the object ``self``. The main reason for using options 1, 2, or 4 would be if you actually need to use strings (e.g. to connect signals programmatically based on strings read from a configuration file). Otherwise, option 3 is the recommended (and fastest) method. - -\ **Binding and passing parameters:**\ - -The syntax to bind parameters is through :ref:`Callable.bind()`, which returns a copy of the :ref:`Callable` with its parameters bound. - -When calling :ref:`emit_signal()` or :ref:`Signal.emit()`, the signal parameters can be also passed. The examples below show the relationship between these signal parameters and bound parameters. - - -.. tabs:: - - .. code-tab:: gdscript - - func _ready(): - # This assumes that a `Player` class exists, which defines a `hit` signal. - var player = Player.new() - # Using Callable.bind(). - player.hit.connect(_on_player_hit.bind("sword", 100)) - - # Parameters added when emitting the signal are passed first. - player.hit.emit("Dark lord", 5) - - # We pass two arguments when emitting (`hit_by`, `level`), - # and bind two more arguments when connecting (`weapon_type`, `damage`). - func _on_player_hit(hit_by, level, weapon_type, damage): - print("Hit by %s (level %d) with weapon %s for %d damage." % [hit_by, level, weapon_type, damage]) - - .. code-tab:: csharp - - public override void _Ready() - { - // This assumes that a `Player` class exists, which defines a `Hit` signal. - var player = new Player(); - // Using lambda expressions that create a closure that captures the additional parameters. - // The lambda only receives the parameters defined by the signal's delegate. - player.Hit += (hitBy, level) => OnPlayerHit(hitBy, level, "sword", 100); - - // Parameters added when emitting the signal are passed first. - player.EmitSignal(SignalName.Hit, "Dark lord", 5); - } - - // We pass two arguments when emitting (`hit_by`, `level`), - // and bind two more arguments when connecting (`weapon_type`, `damage`). - private void OnPlayerHit(string hitBy, int level, string weaponType, int damage) - { - GD.Print($"Hit by {hitBy} (level {level}) with weapon {weaponType} for {damage} damage."); - } +A signal can only be connected once to the same :ref:`Callable`. If the signal is already connected, this method returns :ref:`@GlobalScope.ERR_INVALID_PARAMETER` and generates an error, unless the signal is connected with :ref:`CONNECT_REFERENCE_COUNTED`. To prevent this, use :ref:`is_connected()` first to check for existing connections. +\ **Note:** If the ``callable``'s object is freed, the connection will be lost. +\ **Note:** In GDScript, it is generally recommended to connect signals with :ref:`Signal.connect()` instead. .. rst-class:: classref-item-separator diff --git a/classes/class_openxranalogthresholdmodifier.rst b/classes/class_openxranalogthresholdmodifier.rst index ad5abb5047b..8c09c5b7bd2 100644 --- a/classes/class_openxranalogthresholdmodifier.rst +++ b/classes/class_openxranalogthresholdmodifier.rst @@ -78,7 +78,7 @@ Haptic pulse to emit when the user releases the input. - |void| **set_off_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_off_threshold**\ (\ ) -When our input value falls below this, our output becomes false. +When our input value falls below this, our output becomes ``false``. .. rst-class:: classref-item-separator @@ -112,7 +112,7 @@ Haptic pulse to emit when the user presses the input. - |void| **set_on_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_on_threshold**\ (\ ) -When our input value is equal or larger than this value, our output becomes true. It stays true until it falls under the :ref:`off_threshold` value. +When our input value is equal or larger than this value, our output becomes ``true``. It stays ``true`` until it falls under the :ref:`off_threshold` value. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_openxrapiextension.rst b/classes/class_openxrapiextension.rst index bba2401bdd9..656f89e5db3 100644 --- a/classes/class_openxrapiextension.rst +++ b/classes/class_openxrapiextension.rst @@ -111,9 +111,13 @@ Methods +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`openxr_swapchain_release`\ (\ swapchain\: :ref:`int`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`register_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`register_frame_info_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_play_space`\ (\ space\: ``const void*``\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_emulate_environment_blend_mode_alpha_blend`\ (\ enabled\: :ref:`bool`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -129,9 +133,11 @@ Methods +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform_from_pose`\ (\ pose\: ``const void*``\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`unregister_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`unregister_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | + | |void| | :ref:`unregister_frame_info_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | + +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`unregister_projection_views_extension`\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr_result`\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) | +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -556,7 +562,7 @@ Releases the image of the provided swapchain. .. rst-class:: classref-method -|void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` +|void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` Registers the given extension as a composition layer provider. @@ -564,11 +570,23 @@ Registers the given extension as a composition layer provider. ---- +.. _class_OpenXRAPIExtension_method_register_frame_info_extension: + +.. rst-class:: classref-method + +|void| **register_frame_info_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` + +Registers the given extension as modifying frame info via the :ref:`OpenXRExtensionWrapper._set_frame_wait_info_and_get_next_pointer()`, :ref:`OpenXRExtensionWrapper._set_view_locate_info_and_get_next_pointer()`, or :ref:`OpenXRExtensionWrapper._set_frame_end_info_and_get_next_pointer()` virtual methods. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_register_projection_views_extension: .. rst-class:: classref-method -|void| **register_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` +|void| **register_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` Registers the given extension as a provider of additional data structures to projections views. @@ -576,6 +594,18 @@ Registers the given extension as a provider of additional data structures to pro ---- +.. _class_OpenXRAPIExtension_method_set_custom_play_space: + +.. rst-class:: classref-method + +|void| **set_custom_play_space**\ (\ space\: ``const void*``\ ) :ref:`🔗` + +Sets the reference space used by OpenXR to the given `XrSpace `__ (cast to a ``void *``). + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_set_emulate_environment_blend_mode_alpha_blend: .. rst-class:: classref-method @@ -664,7 +694,7 @@ Creates a :ref:`Transform3D` from an `XrPosef `\ ) :ref:`🔗` +|void| **unregister_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` Unregisters the given extension as a composition layer provider. @@ -672,11 +702,23 @@ Unregisters the given extension as a composition layer provider. ---- +.. _class_OpenXRAPIExtension_method_unregister_frame_info_extension: + +.. rst-class:: classref-method + +|void| **unregister_frame_info_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` + +Unregisters the given extension as modifying frame info. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRAPIExtension_method_unregister_projection_views_extension: .. rst-class:: classref-method -|void| **unregister_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` +|void| **unregister_projection_views_extension**\ (\ extension\: :ref:`OpenXRExtensionWrapper`\ ) :ref:`🔗` Unregisters the given extension as a provider of additional data structures to projections views. diff --git a/classes/class_openxrcompositionlayer.rst b/classes/class_openxrcompositionlayer.rst index 2dc780167ec..b2f90d3ffd6 100644 --- a/classes/class_openxrcompositionlayer.rst +++ b/classes/class_openxrcompositionlayer.rst @@ -35,19 +35,41 @@ Properties .. table:: :widths: auto - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`alpha_blend` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`Vector2i` | :ref:`android_surface_size` | ``Vector2i(1024, 1024)`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`enable_hole_punch` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`SubViewport` | :ref:`layer_viewport` | | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`int` | :ref:`sort_order` | ``1`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ - | :ref:`bool` | :ref:`use_android_surface` | ``false`` | - +---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+ + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`alpha_blend` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Vector2i` | :ref:`android_surface_size` | ``Vector2i(1024, 1024)`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`enable_hole_punch` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`SubViewport` | :ref:`layer_viewport` | | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`int` | :ref:`sort_order` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_alpha_swizzle` | ``3`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_blue_swizzle` | ``2`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Color` | :ref:`swapchain_state_border_color` | ``Color(0, 0, 0, 0)`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_green_swizzle` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Wrap` | :ref:`swapchain_state_horizontal_wrap` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Filter` | :ref:`swapchain_state_mag_filter` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`float` | :ref:`swapchain_state_max_anisotropy` | ``1.0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Filter` | :ref:`swapchain_state_min_filter` | ``1`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`MipmapMode` | :ref:`swapchain_state_mipmap_mode` | ``2`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Swizzle` | :ref:`swapchain_state_red_swizzle` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`Wrap` | :ref:`swapchain_state_vertical_wrap` | ``0`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`use_android_surface` | ``false`` | + +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group @@ -71,6 +93,191 @@ Methods .. rst-class:: classref-descriptions-group +Enumerations +------------ + +.. _enum_OpenXRCompositionLayer_Filter: + +.. rst-class:: classref-enumeration + +enum **Filter**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_FILTER_NEAREST: + +.. rst-class:: classref-enumeration-constant + +:ref:`Filter` **FILTER_NEAREST** = ``0`` + +Perform nearest-neighbor filtering when sampling the texture. + +.. _class_OpenXRCompositionLayer_constant_FILTER_LINEAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`Filter` **FILTER_LINEAR** = ``1`` + +Perform linear filtering when sampling the texture. + +.. _class_OpenXRCompositionLayer_constant_FILTER_CUBIC: + +.. rst-class:: classref-enumeration-constant + +:ref:`Filter` **FILTER_CUBIC** = ``2`` + +Perform cubic filtering when sampling the texture. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRCompositionLayer_MipmapMode: + +.. rst-class:: classref-enumeration + +enum **MipmapMode**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`MipmapMode` **MIPMAP_MODE_DISABLED** = ``0`` + +Disable mipmapping. + +\ **Note:** Mipmapping can only be disabled in the compatibility renderer. + +.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_NEAREST: + +.. rst-class:: classref-enumeration-constant + +:ref:`MipmapMode` **MIPMAP_MODE_NEAREST** = ``1`` + +Use the mipmap of the nearest resolution. + +.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_LINEAR: + +.. rst-class:: classref-enumeration-constant + +:ref:`MipmapMode` **MIPMAP_MODE_LINEAR** = ``2`` + +Use linear interpolation of the two mipmaps of the nearest resolution. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRCompositionLayer_Wrap: + +.. rst-class:: classref-enumeration + +enum **Wrap**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_BORDER: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_CLAMP_TO_BORDER** = ``0`` + +Clamp the texture to its specified border color. + +.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_CLAMP_TO_EDGE** = ``1`` + +Clamp the texture to its edge color. + +.. _class_OpenXRCompositionLayer_constant_WRAP_REPEAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_REPEAT** = ``2`` + +Repeat the texture infinitely. + +.. _class_OpenXRCompositionLayer_constant_WRAP_MIRRORED_REPEAT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_MIRRORED_REPEAT** = ``3`` + +Repeat the texture infinitely, mirroring it on each repeat. + +.. _class_OpenXRCompositionLayer_constant_WRAP_MIRROR_CLAMP_TO_EDGE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Wrap` **WRAP_MIRROR_CLAMP_TO_EDGE** = ``4`` + +Mirror the texture once and then clamp the texture to its edge color. + +\ **Note:** This wrap mode is not available in the compatibility renderer. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRCompositionLayer_Swizzle: + +.. rst-class:: classref-enumeration + +enum **Swizzle**: :ref:`🔗` + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_RED: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_RED** = ``0`` + +Maps a color channel to the value of the red channel. + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_GREEN: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_GREEN** = ``1`` + +Maps a color channel to the value of the green channel. + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_BLUE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_BLUE** = ``2`` + +Maps a color channel to the value of the blue channel. + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ALPHA: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_ALPHA** = ``3`` + +Maps a color channel to the value of the alpha channel. + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ZERO: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_ZERO** = ``4`` + +Maps a color channel to the value of zero. + +.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ONE: + +.. rst-class:: classref-enumeration-constant + +:ref:`Swizzle` **SWIZZLE_ONE** = ``5`` + +Maps a color channel to the value of one. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + Property Descriptions --------------------- @@ -165,6 +372,215 @@ The sort order for this composition layer. Higher numbers will be shown in front ---- +.. _class_OpenXRCompositionLayer_property_swapchain_state_alpha_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_alpha_swizzle** = ``3`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_alpha_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_alpha_swizzle**\ (\ ) + +The swizzle value for the alpha channel of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_blue_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_blue_swizzle** = ``2`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_blue_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_blue_swizzle**\ (\ ) + +The swizzle value for the blue channel of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_border_color: + +.. rst-class:: classref-property + +:ref:`Color` **swapchain_state_border_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_border_color**\ (\ value\: :ref:`Color`\ ) +- :ref:`Color` **get_border_color**\ (\ ) + +The border color of the swapchain state that is used when the wrap mode clamps to the border. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_green_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_green_swizzle** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_green_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_green_swizzle**\ (\ ) + +The swizzle value for the green channel of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_horizontal_wrap: + +.. rst-class:: classref-property + +:ref:`Wrap` **swapchain_state_horizontal_wrap** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_horizontal_wrap**\ (\ value\: :ref:`Wrap`\ ) +- :ref:`Wrap` **get_horizontal_wrap**\ (\ ) + +The horizontal wrap mode of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_mag_filter: + +.. rst-class:: classref-property + +:ref:`Filter` **swapchain_state_mag_filter** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mag_filter**\ (\ value\: :ref:`Filter`\ ) +- :ref:`Filter` **get_mag_filter**\ (\ ) + +The magnification filter of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_max_anisotropy: + +.. rst-class:: classref-property + +:ref:`float` **swapchain_state_max_anisotropy** = ``1.0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_max_anisotropy**\ (\ value\: :ref:`float`\ ) +- :ref:`float` **get_max_anisotropy**\ (\ ) + +The max anisotropy of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_min_filter: + +.. rst-class:: classref-property + +:ref:`Filter` **swapchain_state_min_filter** = ``1`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_min_filter**\ (\ value\: :ref:`Filter`\ ) +- :ref:`Filter` **get_min_filter**\ (\ ) + +The minification filter of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_mipmap_mode: + +.. rst-class:: classref-property + +:ref:`MipmapMode` **swapchain_state_mipmap_mode** = ``2`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_mipmap_mode**\ (\ value\: :ref:`MipmapMode`\ ) +- :ref:`MipmapMode` **get_mipmap_mode**\ (\ ) + +The mipmap mode of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_red_swizzle: + +.. rst-class:: classref-property + +:ref:`Swizzle` **swapchain_state_red_swizzle** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_red_swizzle**\ (\ value\: :ref:`Swizzle`\ ) +- :ref:`Swizzle` **get_red_swizzle**\ (\ ) + +The swizzle value for the red channel of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRCompositionLayer_property_swapchain_state_vertical_wrap: + +.. rst-class:: classref-property + +:ref:`Wrap` **swapchain_state_vertical_wrap** = ``0`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_vertical_wrap**\ (\ value\: :ref:`Wrap`\ ) +- :ref:`Wrap` **get_vertical_wrap**\ (\ ) + +The vertical wrap mode of the swapchain state. + +\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRCompositionLayer_property_use_android_surface: .. rst-class:: classref-property diff --git a/classes/class_openxrdpadbindingmodifier.rst b/classes/class_openxrdpadbindingmodifier.rst index d2b4872f9ba..12ab9ba41a0 100644 --- a/classes/class_openxrdpadbindingmodifier.rst +++ b/classes/class_openxrdpadbindingmodifier.rst @@ -124,9 +124,9 @@ Input path for this dpad binding modifier. - |void| **set_is_sticky**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_is_sticky**\ (\ ) -If ``false``, when the joystick enters a new dpad zone this becomes true. +If ``false``, when the joystick enters a new dpad zone this becomes ``true``. -If ``true``, when the joystick remains in active dpad zone, this remains true even if we overlap with another zone. +If ``true``, when the joystick remains in active dpad zone, this remains ``true`` even if we overlap with another zone. .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Haptic pulse to emit when the user presses the input. - |void| **set_threshold**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_threshold**\ (\ ) -When our input value is equal or larger than this value, our dpad in that direction becomes true. It stays true until it falls under the :ref:`threshold_released` value. +When our input value is equal or larger than this value, our dpad in that direction becomes ``true``. It stays ``true`` until it falls under the :ref:`threshold_released` value. .. rst-class:: classref-item-separator @@ -194,7 +194,7 @@ When our input value is equal or larger than this value, our dpad in that direct - |void| **set_threshold_released**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_threshold_released**\ (\ ) -When our input value falls below this, our output becomes false. +When our input value falls below this, our output becomes ``false``. .. rst-class:: classref-item-separator diff --git a/classes/class_openxrextensionwrapper.rst b/classes/class_openxrextensionwrapper.rst new file mode 100644 index 00000000000..cada68bf9ee --- /dev/null +++ b/classes/class_openxrextensionwrapper.rst @@ -0,0 +1,664 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRExtensionWrapper.xml. + +.. _class_OpenXRExtensionWrapper: + +OpenXRExtensionWrapper +====================== + +**Inherits:** :ref:`Object` + +**Inherited By:** :ref:`OpenXRExtensionWrapperExtension`, :ref:`OpenXRFutureExtension` + +Allows implementing OpenXR extensions with GDExtension. + +.. rst-class:: classref-introduction-group + +Description +----------- + +**OpenXRExtensionWrapper** allows implementing OpenXR extensions with GDExtension. The extension should be registered with :ref:`register_extension_wrapper()`. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer`\ (\ index\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer_count`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_composition_layer_order`\ (\ index\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_viewport_composition_layer_extension_properties`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`_get_viewport_composition_layer_extension_property_defaults`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_before_instance_created`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_on_event_polled`\ (\ event\: ``const void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_instance_created`\ (\ instance\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_main_swapchains_created`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_post_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_pre_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_process`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_register_metadata`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_session_created`\ (\ session\: :ref:`int`\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_session_destroyed`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_exiting`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_focused`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_idle`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_loss_pending`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_ready`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_stopping`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_synchronized`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_state_visible`\ (\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_on_viewport_composition_layer_destroyed`\ (\ layer\: ``const void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_android_surface_swapchain_create_info_and_get_next_pointer`\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_frame_end_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_frame_wait_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :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_projection_views_and_get_next_pointer`\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_reference_space_create_info_and_get_next_pointer`\ (\ reference_space_type\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_session_create_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_swapchain_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_system_properties_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_view_locate_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_set_viewport_composition_layer_and_get_next_pointer`\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRAPIExtension` | :ref:`get_openxr_api`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`register_extension_wrapper`\ (\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_OpenXRExtensionWrapper_private_method__get_composition_layer: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` + +Returns a pointer to an ``XrCompositionLayerBaseHeader`` struct to provide the given composition layer. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_composition_layer_count: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| :ref:`🔗` + +Returns the number of composition layers this extension wrapper provides via :ref:`_get_composition_layer()`. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_composition_layer_order: + +.. rst-class:: classref-method + +:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` + +Returns an integer that will be used to sort the given composition layer provided via :ref:`_get_composition_layer()`. Lower numbers will move the layer to the front of the list, and higher numbers to the end. The default projection layer has an order of ``0``, so layers provided by this method should probably be above or below (but not exactly) ``0``. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_requested_extensions: + +.. rst-class:: classref-method + +:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |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: + +- If the ``bool *`` is a ``nullptr`` this extension is mandatory. + +- If the ``bool *`` points to a boolean, the boolean will be updated to ``true`` if the extension is enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_suggested_tracker_names: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| :ref:`🔗` + +Returns a :ref:`PackedStringArray` of positional tracker names that are used within the extension wrapper. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_viewport_composition_layer_extension_properties: + +.. rst-class:: classref-method + +:ref:`Array`\[:ref:`Dictionary`\] **_get_viewport_composition_layer_extension_properties**\ (\ ) |virtual| :ref:`🔗` + +Gets an array of :ref:`Dictionary`\ s that represent properties, just like :ref:`Object._get_property_list()`, that will be added to :ref:`OpenXRCompositionLayer` nodes. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__get_viewport_composition_layer_extension_property_defaults: + +.. rst-class:: classref-method + +:ref:`Dictionary` **_get_viewport_composition_layer_extension_property_defaults**\ (\ ) |virtual| :ref:`🔗` + +Gets a :ref:`Dictionary` containing the default values for the properties returned by :ref:`_get_viewport_composition_layer_extension_properties()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_before_instance_created: + +.. rst-class:: classref-method + +|void| **_on_before_instance_created**\ (\ ) |virtual| :ref:`🔗` + +Called before the OpenXR instance is created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_event_polled: + +.. rst-class:: classref-method + +:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| :ref:`🔗` + +Called when there is an OpenXR event to process. When implementing, return ``true`` if the event was handled, return ``false`` otherwise. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_instance_created: + +.. rst-class:: classref-method + +|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| :ref:`🔗` + +Called right after the OpenXR instance is created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_instance_destroyed: + +.. rst-class:: classref-method + +|void| **_on_instance_destroyed**\ (\ ) |virtual| :ref:`🔗` + +Called right before the OpenXR instance is destroyed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_main_swapchains_created: + +.. rst-class:: classref-method + +|void| **_on_main_swapchains_created**\ (\ ) |virtual| :ref:`🔗` + +Called right after the main swapchains are (re)created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_post_draw_viewport: + +.. rst-class:: classref-method + +|void| **_on_post_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` + +Called right after the given viewport is rendered. + +\ **Note:** The draw commands might only be queued at this point, not executed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_pre_draw_viewport: + +.. rst-class:: classref-method + +|void| **_on_pre_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` + +Called right before the given viewport is rendered. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_pre_render: + +.. rst-class:: classref-method + +|void| **_on_pre_render**\ (\ ) |virtual| :ref:`🔗` + +Called right before the XR viewports begin their rendering step. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_process: + +.. rst-class:: classref-method + +|void| **_on_process**\ (\ ) |virtual| :ref:`🔗` + +Called as part of the OpenXR process handling. This happens right before general and physics processing steps of the main loop. During this step controller data is queried and made available to game logic. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_register_metadata: + +.. rst-class:: classref-method + +|void| **_on_register_metadata**\ (\ ) |virtual| :ref:`🔗` + +Allows extensions to register additional controller metadata. This function is called even when the OpenXR API is not constructed as the metadata needs to be available to the editor. + +Extensions should also provide metadata regardless of whether they are supported on the host system. The controller data is used to setup action maps for users who may have access to the relevant hardware. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_session_created: + +.. rst-class:: classref-method + +|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| :ref:`🔗` + +Called right after the OpenXR session is created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_session_destroyed: + +.. rst-class:: classref-method + +|void| **_on_session_destroyed**\ (\ ) |virtual| :ref:`🔗` + +Called right before the OpenXR session is destroyed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_exiting: + +.. rst-class:: classref-method + +|void| **_on_state_exiting**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to exiting. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_focused: + +.. rst-class:: classref-method + +|void| **_on_state_focused**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to focused. This state is the active state when the game runs. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_idle: + +.. rst-class:: classref-method + +|void| **_on_state_idle**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to idle. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_loss_pending: + +.. rst-class:: classref-method + +|void| **_on_state_loss_pending**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to loss pending. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_ready: + +.. rst-class:: classref-method + +|void| **_on_state_ready**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to ready. This means OpenXR is ready to set up the session. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_stopping: + +.. rst-class:: classref-method + +|void| **_on_state_stopping**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to stopping. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_synchronized: + +.. rst-class:: classref-method + +|void| **_on_state_synchronized**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to synchronized. OpenXR also returns to this state when the application loses focus. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_state_visible: + +.. rst-class:: classref-method + +|void| **_on_state_visible**\ (\ ) |virtual| :ref:`🔗` + +Called when the OpenXR session state is changed to visible. This means OpenXR is now ready to receive frames. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__on_viewport_composition_layer_destroyed: + +.. rst-class:: classref-method + +|void| **_on_viewport_composition_layer_destroyed**\ (\ layer\: ``const void*``\ ) |virtual| :ref:`🔗` + +Called when a composition layer created via :ref:`OpenXRCompositionLayer` is destroyed. + +\ ``layer`` is a pointer to an ``XrCompositionLayerBaseHeader`` struct. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_android_surface_swapchain_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_android_surface_swapchain_create_info_and_get_next_pointer**\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to Android surface swapchains created by :ref:`OpenXRCompositionLayer`. + +\ ``property_values`` contains the values of the properties returned by :ref:`_get_viewport_composition_layer_extension_properties()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_frame_end_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_frame_end_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to ``XrFrameEndInfo``. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_frame_info_extension()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_frame_wait_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_frame_wait_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to ``XrFrameWaitInfo``. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_frame_info_extension()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_hand_joint_locations_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures when each hand tracker is created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_instance_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures when the OpenXR instance is created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_projection_views_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_projection_views_and_get_next_pointer**\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to the projection view of the given ``view_index``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_reference_space_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_reference_space_create_info_and_get_next_pointer**\ (\ reference_space_type\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to ``XrReferenceSpaceCreateInfo``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_session_create_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures when the OpenXR session is created. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_swapchain_create_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures when creating OpenXR swapchains. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_system_properties_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures when querying OpenXR system abilities. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_view_locate_info_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_view_locate_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to ``XrViewLocateInfo``. + +This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_frame_info_extension()`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_private_method__set_viewport_composition_layer_and_get_next_pointer: + +.. rst-class:: classref-method + +:ref:`int` **_set_viewport_composition_layer_and_get_next_pointer**\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` + +Adds additional data structures to composition layers created by :ref:`OpenXRCompositionLayer`. + +\ ``property_values`` contains the values of the properties returned by :ref:`_get_viewport_composition_layer_extension_properties()`. + +\ ``layer`` is a pointer to an ``XrCompositionLayerBaseHeader`` struct. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_method_get_openxr_api: + +.. rst-class:: classref-method + +:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) :ref:`🔗` + +Returns the created :ref:`OpenXRAPIExtension`, which can be used to access the OpenXR API. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRExtensionWrapper_method_register_extension_wrapper: + +.. rst-class:: classref-method + +|void| **register_extension_wrapper**\ (\ ) :ref:`🔗` + +Registers the extension. This should happen at core module initialization level. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrextensionwrapperextension.rst b/classes/class_openxrextensionwrapperextension.rst index 626e323ef35..17086f0f492 100644 --- a/classes/class_openxrextensionwrapperextension.rst +++ b/classes/class_openxrextensionwrapperextension.rst @@ -10,585 +10,18 @@ OpenXRExtensionWrapperExtension =============================== -**Inherits:** :ref:`Object` +**Deprecated:** Use :ref:`OpenXRExtensionWrapper` instead. -Allows clients to implement OpenXR extensions with GDExtension. +**Inherits:** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` + +Allows implementing OpenXR extensions with GDExtension. .. rst-class:: classref-introduction-group Description ----------- -**OpenXRExtensionWrapperExtension** allows clients to implement OpenXR extensions with GDExtension. The extension should be registered with :ref:`register_extension_wrapper()`. - -.. rst-class:: classref-reftable-group - -Methods -------- - -.. table:: - :widths: auto - - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer`\ (\ index\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer_count`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_composition_layer_order`\ (\ index\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_requested_extensions`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_viewport_composition_layer_extension_properties`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`_get_viewport_composition_layer_extension_property_defaults`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_before_instance_created`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_on_event_polled`\ (\ event\: ``const void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_instance_created`\ (\ instance\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_instance_destroyed`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_main_swapchains_created`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_post_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_pre_draw_viewport`\ (\ viewport\: :ref:`RID`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_pre_render`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_process`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_register_metadata`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_session_created`\ (\ session\: :ref:`int`\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_session_destroyed`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_exiting`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_focused`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_idle`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_loss_pending`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_ready`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_stopping`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_synchronized`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_state_visible`\ (\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_on_viewport_composition_layer_destroyed`\ (\ layer\: ``const void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_android_surface_swapchain_create_info_and_get_next_pointer`\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :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_projection_views_and_get_next_pointer`\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_session_create_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_swapchain_create_info_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_system_properties_and_get_next_pointer`\ (\ next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_set_viewport_composition_layer_and_get_next_pointer`\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OpenXRAPIExtension` | :ref:`get_openxr_api`\ (\ ) | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`register_extension_wrapper`\ (\ ) | - +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. rst-class:: classref-section-separator - ----- - -.. rst-class:: classref-descriptions-group - -Method Descriptions -------------------- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer: - -.. rst-class:: classref-method - -:ref:`int` **_get_composition_layer**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` - -Returns a pointer to an ``XrCompositionLayerBaseHeader`` struct to provide the given composition layer. - -This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider()`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer_count: - -.. rst-class:: classref-method - -:ref:`int` **_get_composition_layer_count**\ (\ ) |virtual| :ref:`🔗` - -Returns the number of composition layers this extension wrapper provides via :ref:`_get_composition_layer()`. - -This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider()`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_composition_layer_order: - -.. rst-class:: classref-method - -:ref:`int` **_get_composition_layer_order**\ (\ index\: :ref:`int`\ ) |virtual| :ref:`🔗` - -Returns an integer that will be used to sort the given composition layer provided via :ref:`_get_composition_layer()`. Lower numbers will move the layer to the front of the list, and higher numbers to the end. The default projection layer has an order of ``0``, so layers provided by this method should probably be above or below (but not exactly) ``0``. - -This will only be called if the extension previously registered itself with :ref:`OpenXRAPIExtension.register_composition_layer_provider()`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_requested_extensions: - -.. rst-class:: classref-method - -:ref:`Dictionary` **_get_requested_extensions**\ (\ ) |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: - -- If the ``bool *`` is a ``nullptr`` this extension is mandatory. - -- If the ``bool *`` points to a boolean, the boolean will be updated to ``true`` if the extension is enabled. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_suggested_tracker_names: - -.. rst-class:: classref-method - -:ref:`PackedStringArray` **_get_suggested_tracker_names**\ (\ ) |virtual| :ref:`🔗` - -Returns a :ref:`PackedStringArray` of positional tracker names that are used within the extension wrapper. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_viewport_composition_layer_extension_properties: - -.. rst-class:: classref-method - -:ref:`Array`\[:ref:`Dictionary`\] **_get_viewport_composition_layer_extension_properties**\ (\ ) |virtual| :ref:`🔗` - -Gets an array of :ref:`Dictionary`\ s that represent properties, just like :ref:`Object._get_property_list()`, that will be added to :ref:`OpenXRCompositionLayer` nodes. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__get_viewport_composition_layer_extension_property_defaults: - -.. rst-class:: classref-method - -:ref:`Dictionary` **_get_viewport_composition_layer_extension_property_defaults**\ (\ ) |virtual| :ref:`🔗` - -Gets a :ref:`Dictionary` containing the default values for the properties returned by :ref:`_get_viewport_composition_layer_extension_properties()`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_before_instance_created: - -.. rst-class:: classref-method - -|void| **_on_before_instance_created**\ (\ ) |virtual| :ref:`🔗` - -Called before the OpenXR instance is created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_event_polled: - -.. rst-class:: classref-method - -:ref:`bool` **_on_event_polled**\ (\ event\: ``const void*``\ ) |virtual| :ref:`🔗` - -Called when there is an OpenXR event to process. When implementing, return ``true`` if the event was handled, return ``false`` otherwise. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_instance_created: - -.. rst-class:: classref-method - -|void| **_on_instance_created**\ (\ instance\: :ref:`int`\ ) |virtual| :ref:`🔗` - -Called right after the OpenXR instance is created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_instance_destroyed: - -.. rst-class:: classref-method - -|void| **_on_instance_destroyed**\ (\ ) |virtual| :ref:`🔗` - -Called right before the OpenXR instance is destroyed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_main_swapchains_created: - -.. rst-class:: classref-method - -|void| **_on_main_swapchains_created**\ (\ ) |virtual| :ref:`🔗` - -Called right after the main swapchains are (re)created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_post_draw_viewport: - -.. rst-class:: classref-method - -|void| **_on_post_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -Called right after the given viewport is rendered. - -\ **Note:** The draw commands might only be queued at this point, not executed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_pre_draw_viewport: - -.. rst-class:: classref-method - -|void| **_on_pre_draw_viewport**\ (\ viewport\: :ref:`RID`\ ) |virtual| :ref:`🔗` - -Called right before the given viewport is rendered. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_pre_render: - -.. rst-class:: classref-method - -|void| **_on_pre_render**\ (\ ) |virtual| :ref:`🔗` - -Called right before the XR viewports begin their rendering step. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_process: - -.. rst-class:: classref-method - -|void| **_on_process**\ (\ ) |virtual| :ref:`🔗` - -Called as part of the OpenXR process handling. This happens right before general and physics processing steps of the main loop. During this step controller data is queried and made available to game logic. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_register_metadata: - -.. rst-class:: classref-method - -|void| **_on_register_metadata**\ (\ ) |virtual| :ref:`🔗` - -Allows extensions to register additional controller metadata. This function is called even when the OpenXR API is not constructed as the metadata needs to be available to the editor. - -Extensions should also provide metadata regardless of whether they are supported on the host system. The controller data is used to setup action maps for users who may have access to the relevant hardware. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_session_created: - -.. rst-class:: classref-method - -|void| **_on_session_created**\ (\ session\: :ref:`int`\ ) |virtual| :ref:`🔗` - -Called right after the OpenXR session is created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_session_destroyed: - -.. rst-class:: classref-method - -|void| **_on_session_destroyed**\ (\ ) |virtual| :ref:`🔗` - -Called right before the OpenXR session is destroyed. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_exiting: - -.. rst-class:: classref-method - -|void| **_on_state_exiting**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to exiting. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_focused: - -.. rst-class:: classref-method - -|void| **_on_state_focused**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to focused. This state is the active state when the game runs. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_idle: - -.. rst-class:: classref-method - -|void| **_on_state_idle**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to idle. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_loss_pending: - -.. rst-class:: classref-method - -|void| **_on_state_loss_pending**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to loss pending. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_ready: - -.. rst-class:: classref-method - -|void| **_on_state_ready**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to ready. This means OpenXR is ready to set up the session. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_stopping: - -.. rst-class:: classref-method - -|void| **_on_state_stopping**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to stopping. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_synchronized: - -.. rst-class:: classref-method - -|void| **_on_state_synchronized**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to synchronized. OpenXR also returns to this state when the application loses focus. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_state_visible: - -.. rst-class:: classref-method - -|void| **_on_state_visible**\ (\ ) |virtual| :ref:`🔗` - -Called when the OpenXR session state is changed to visible. This means OpenXR is now ready to receive frames. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__on_viewport_composition_layer_destroyed: - -.. rst-class:: classref-method - -|void| **_on_viewport_composition_layer_destroyed**\ (\ layer\: ``const void*``\ ) |virtual| :ref:`🔗` - -Called when a composition layer created via :ref:`OpenXRCompositionLayer` is destroyed. - -\ ``layer`` is a pointer to an ``XrCompositionLayerBaseHeader`` struct. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_android_surface_swapchain_create_info_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_android_surface_swapchain_create_info_and_get_next_pointer**\ (\ property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures to Android surface swapchains created by :ref:`OpenXRCompositionLayer`. - -\ ``property_values`` contains the values of the properties returned by :ref:`_get_viewport_composition_layer_extension_properties()`. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_hand_joint_locations_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_hand_joint_locations_and_get_next_pointer**\ (\ hand_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures when each hand tracker is created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_instance_create_info_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_instance_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures when the OpenXR instance is created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_projection_views_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_projection_views_and_get_next_pointer**\ (\ view_index\: :ref:`int`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures to the projection view of the given ``view_index``. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_session_create_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_session_create_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures when the OpenXR session is created. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_swapchain_create_info_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_swapchain_create_info_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures when creating OpenXR swapchains. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_system_properties_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_system_properties_and_get_next_pointer**\ (\ next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures when querying OpenXR system abilities. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_private_method__set_viewport_composition_layer_and_get_next_pointer: - -.. rst-class:: classref-method - -:ref:`int` **_set_viewport_composition_layer_and_get_next_pointer**\ (\ layer\: ``const void*``, property_values\: :ref:`Dictionary`, next_pointer\: ``void*``\ ) |virtual| :ref:`🔗` - -Adds additional data structures to composition layers created by :ref:`OpenXRCompositionLayer`. - -\ ``property_values`` contains the values of the properties returned by :ref:`_get_viewport_composition_layer_extension_properties()`. - -\ ``layer`` is a pointer to an ``XrCompositionLayerBaseHeader`` struct. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_method_get_openxr_api: - -.. rst-class:: classref-method - -:ref:`OpenXRAPIExtension` **get_openxr_api**\ (\ ) :ref:`🔗` - -Returns the created :ref:`OpenXRAPIExtension`, which can be used to access the OpenXR API. - -.. rst-class:: classref-item-separator - ----- - -.. _class_OpenXRExtensionWrapperExtension_method_register_extension_wrapper: - -.. rst-class:: classref-method - -|void| **register_extension_wrapper**\ (\ ) :ref:`🔗` - -Registers the extension. This should happen at core module initialization level. +**OpenXRExtensionWrapperExtension** allows implementing OpenXR extensions with GDExtension. The extension should be registered with :ref:`OpenXRExtensionWrapper.register_extension_wrapper()`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_openxrfutureextension.rst b/classes/class_openxrfutureextension.rst new file mode 100644 index 00000000000..ea9eb242e26 --- /dev/null +++ b/classes/class_openxrfutureextension.rst @@ -0,0 +1,100 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRFutureExtension.xml. + +.. _class_OpenXRFutureExtension: + +OpenXRFutureExtension +===================== + +**Inherits:** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` + +The OpenXR Future extension allows for asynchronous APIs to be used. + +.. rst-class:: classref-introduction-group + +Description +----------- + +This is a support extension in OpenXR that allows other OpenXR extensions to start asynchronous functions and get a callback after this function finishes. It is not intended for consumption within GDScript but can be accessed from GDExtension. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`cancel_future`\ (\ future\: :ref:`int`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_active`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OpenXRFutureResult` | :ref:`register_future`\ (\ future\: :ref:`int`, on_success\: :ref:`Callable` = Callable()\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_OpenXRFutureExtension_method_cancel_future: + +.. rst-class:: classref-method + +|void| **cancel_future**\ (\ future\: :ref:`int`\ ) :ref:`🔗` + +Cancels an in-progress future. ``future`` must be an ``XrFutureEXT`` value previously returned by an API that started an asynchronous function. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureExtension_method_is_active: + +.. rst-class:: classref-method + +:ref:`bool` **is_active**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if futures are available in the OpenXR runtime used. This function will only return a usable result after OpenXR has been initialized. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureExtension_method_register_future: + +.. rst-class:: classref-method + +:ref:`OpenXRFutureResult` **register_future**\ (\ future\: :ref:`int`, on_success\: :ref:`Callable` = Callable()\ ) :ref:`🔗` + +Register an OpenXR Future object so we monitor for completion. ``future`` must be an ``XrFutureEXT`` value previously returned by an API that started an asynchronous function. + +You can optionally specify ``on_success``, it will be invoked on successful completion of the future. + +Or you can use the returned :ref:`OpenXRFutureResult` object to ``await`` its :ref:`OpenXRFutureResult.completed` signal. + +:: + + var future_result = OpenXRFutureExtension.register_future(future) + await future_result.completed + if future_result.get_status() == OpenXRFutureResult.RESULT_FINISHED: + # Handle your success + pass + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrfutureresult.rst b/classes/class_openxrfutureresult.rst new file mode 100644 index 00000000000..100699f8f9f --- /dev/null +++ b/classes/class_openxrfutureresult.rst @@ -0,0 +1,144 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRFutureResult.xml. + +.. _class_OpenXRFutureResult: + +OpenXRFutureResult +================== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Result object tracking the asynchronous result of an OpenXR Future object. + +.. rst-class:: classref-introduction-group + +Description +----------- + +Result object tracking the asynchronous result of an OpenXR Future object, you can use this object to track the result status. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------------+-----------------------------------------------------------------------------+ + | |void| | :ref:`cancel_future`\ (\ ) | + +-----------------------------------------------------------+-----------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_future`\ (\ ) |const| | + +-----------------------------------------------------------+-----------------------------------------------------------------------------+ + | :ref:`ResultStatus` | :ref:`get_status`\ (\ ) |const| | + +-----------------------------------------------------------+-----------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Signals +------- + +.. _class_OpenXRFutureResult_signal_completed: + +.. rst-class:: classref-signal + +**completed**\ (\ result\: :ref:`OpenXRFutureResult`\ ) :ref:`🔗` + +Emitted when the asynchronous function is finished or has been cancelled. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Enumerations +------------ + +.. _enum_OpenXRFutureResult_ResultStatus: + +.. rst-class:: classref-enumeration + +enum **ResultStatus**: :ref:`🔗` + +.. _class_OpenXRFutureResult_constant_RESULT_RUNNING: + +.. rst-class:: classref-enumeration-constant + +:ref:`ResultStatus` **RESULT_RUNNING** = ``0`` + +The asynchronous function is running. + +.. _class_OpenXRFutureResult_constant_RESULT_FINISHED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ResultStatus` **RESULT_FINISHED** = ``1`` + +The asynchronous function has finished. + +.. _class_OpenXRFutureResult_constant_RESULT_CANCELLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`ResultStatus` **RESULT_CANCELLED** = ``2`` + +The asynchronous function has been cancelled. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_OpenXRFutureResult_method_cancel_future: + +.. rst-class:: classref-method + +|void| **cancel_future**\ (\ ) :ref:`🔗` + +Cancel this future, this will interrupt and stop the asynchronous function. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureResult_method_get_future: + +.. rst-class:: classref-method + +:ref:`int` **get_future**\ (\ ) |const| :ref:`🔗` + +Return the ``XrFutureEXT`` value this result relates to. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRFutureResult_method_get_status: + +.. rst-class:: classref-method + +:ref:`ResultStatus` **get_status**\ (\ ) |const| :ref:`🔗` + +Returns the status of this result. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_openxrinterface.rst b/classes/class_openxrinterface.rst index b20aacaec9a..64f3c6e4aab 100644 --- a/classes/class_openxrinterface.rst +++ b/classes/class_openxrinterface.rst @@ -93,6 +93,10 @@ Methods +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_action_set_active`\ (\ name\: :ref:`String`, active\: :ref:`bool`\ ) | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cpu_level`\ (\ level\: :ref:`PerfSettingsLevel`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_gpu_level`\ (\ level\: :ref:`PerfSettingsLevel`\ ) | + +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_motion_range`\ (\ hand\: :ref:`Hand`, motion_range\: :ref:`HandMotionRange`\ ) | +--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,6 +109,30 @@ Methods Signals ------- +.. _class_OpenXRInterface_signal_cpu_level_changed: + +.. rst-class:: classref-signal + +**cpu_level_changed**\ (\ sub_domain\: :ref:`int`, from_level\: :ref:`int`, to_level\: :ref:`int`\ ) :ref:`🔗` + +Informs the device CPU performance level has changed in the specified subdomain. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInterface_signal_gpu_level_changed: + +.. rst-class:: classref-signal + +**gpu_level_changed**\ (\ sub_domain\: :ref:`int`, from_level\: :ref:`int`, to_level\: :ref:`int`\ ) :ref:`🔗` + +Informs the device GPU performance level has changed in the specified subdomain. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_signal_instance_exiting: .. rst-class:: classref-signal @@ -312,7 +340,7 @@ The source of hand tracking is a controller, bone positions are inferred from co :ref:`HandTrackedSource` **HAND_TRACKED_SOURCE_MAX** = ``3`` -Maximum value for the hand tracked source enum. +Represents the size of the :ref:`HandTrackedSource` enum. .. rst-class:: classref-item-separator @@ -378,7 +406,7 @@ Thumb tip joint. :ref:`HandJoints` **HAND_JOINT_INDEX_METACARPAL** = ``6`` -Index metacarpal joint. +Index finger metacarpal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_PROXIMAL: @@ -386,7 +414,7 @@ Index metacarpal joint. :ref:`HandJoints` **HAND_JOINT_INDEX_PROXIMAL** = ``7`` -Index proximal joint. +Index finger phalanx proximal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_INTERMEDIATE: @@ -394,7 +422,7 @@ Index proximal joint. :ref:`HandJoints` **HAND_JOINT_INDEX_INTERMEDIATE** = ``8`` -Index intermediate joint. +Index finger phalanx intermediate joint. .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_DISTAL: @@ -402,7 +430,7 @@ Index intermediate joint. :ref:`HandJoints` **HAND_JOINT_INDEX_DISTAL** = ``9`` -Index distal joint. +Index finger phalanx distal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_TIP: @@ -410,7 +438,7 @@ Index distal joint. :ref:`HandJoints` **HAND_JOINT_INDEX_TIP** = ``10`` -Index tip joint. +Index finger tip joint. .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_METACARPAL: @@ -418,7 +446,7 @@ Index tip joint. :ref:`HandJoints` **HAND_JOINT_MIDDLE_METACARPAL** = ``11`` -Middle metacarpal joint. +Middle finger metacarpal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_PROXIMAL: @@ -426,7 +454,7 @@ Middle metacarpal joint. :ref:`HandJoints` **HAND_JOINT_MIDDLE_PROXIMAL** = ``12`` -Middle proximal joint. +Middle finger phalanx proximal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_INTERMEDIATE: @@ -434,7 +462,7 @@ Middle proximal joint. :ref:`HandJoints` **HAND_JOINT_MIDDLE_INTERMEDIATE** = ``13`` -Middle intermediate joint. +Middle finger phalanx intermediate joint. .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_DISTAL: @@ -442,7 +470,7 @@ Middle intermediate joint. :ref:`HandJoints` **HAND_JOINT_MIDDLE_DISTAL** = ``14`` -Middle distal joint. +Middle finger phalanx distal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_TIP: @@ -450,7 +478,7 @@ Middle distal joint. :ref:`HandJoints` **HAND_JOINT_MIDDLE_TIP** = ``15`` -Middle tip joint. +Middle finger tip joint. .. _class_OpenXRInterface_constant_HAND_JOINT_RING_METACARPAL: @@ -458,7 +486,7 @@ Middle tip joint. :ref:`HandJoints` **HAND_JOINT_RING_METACARPAL** = ``16`` -Ring metacarpal joint. +Ring finger metacarpal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_RING_PROXIMAL: @@ -466,7 +494,7 @@ Ring metacarpal joint. :ref:`HandJoints` **HAND_JOINT_RING_PROXIMAL** = ``17`` -Ring proximal joint. +Ring finger phalanx proximal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_RING_INTERMEDIATE: @@ -474,7 +502,7 @@ Ring proximal joint. :ref:`HandJoints` **HAND_JOINT_RING_INTERMEDIATE** = ``18`` -Ring intermediate joint. +Ring finger phalanx intermediate joint. .. _class_OpenXRInterface_constant_HAND_JOINT_RING_DISTAL: @@ -482,7 +510,7 @@ Ring intermediate joint. :ref:`HandJoints` **HAND_JOINT_RING_DISTAL** = ``19`` -Ring distal joint. +Ring finger phalanx distal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_RING_TIP: @@ -490,7 +518,7 @@ Ring distal joint. :ref:`HandJoints` **HAND_JOINT_RING_TIP** = ``20`` -Ring tip joint. +Ring finger tip joint. .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_METACARPAL: @@ -498,7 +526,7 @@ Ring tip joint. :ref:`HandJoints` **HAND_JOINT_LITTLE_METACARPAL** = ``21`` -Little metacarpal joint. +Pinky finger metacarpal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_PROXIMAL: @@ -506,7 +534,7 @@ Little metacarpal joint. :ref:`HandJoints` **HAND_JOINT_LITTLE_PROXIMAL** = ``22`` -Little proximal joint. +Pinky finger phalanx proximal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_INTERMEDIATE: @@ -514,7 +542,7 @@ Little proximal joint. :ref:`HandJoints` **HAND_JOINT_LITTLE_INTERMEDIATE** = ``23`` -Little intermediate joint. +Pinky finger phalanx intermediate joint. .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_DISTAL: @@ -522,7 +550,7 @@ Little intermediate joint. :ref:`HandJoints` **HAND_JOINT_LITTLE_DISTAL** = ``24`` -Little distal joint. +Pinky finger phalanx distal joint. .. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_TIP: @@ -530,7 +558,7 @@ Little distal joint. :ref:`HandJoints` **HAND_JOINT_LITTLE_TIP** = ``25`` -Little tip joint. +Pinky finger tip joint. .. _class_OpenXRInterface_constant_HAND_JOINT_MAX: @@ -538,7 +566,117 @@ Little tip joint. :ref:`HandJoints` **HAND_JOINT_MAX** = ``26`` -Maximum value for the hand joint enum. +Represents the size of the :ref:`HandJoints` enum. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRInterface_PerfSettingsLevel: + +.. rst-class:: classref-enumeration + +enum **PerfSettingsLevel**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_POWER_SAVINGS: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_POWER_SAVINGS** = ``0`` + +The application has entered a non-XR section (head-locked / static screen), during which power savings are to be prioritized. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_SUSTAINED_LOW: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_SUSTAINED_LOW** = ``1`` + +The application has entered a low and stable complexity section, during which reducing power is more important than occasional late rendering frames. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_SUSTAINED_HIGH** = ``2`` + +The application has entered a high or dynamic complexity section, during which the XR Runtime strives for consistent XR compositing and frame rendering within a thermally sustainable range. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_BOOST: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsLevel` **PERF_SETTINGS_LEVEL_BOOST** = ``3`` + +The application has entered a section with very high complexity, during which the XR Runtime is allowed to step up beyond the thermally sustainable range. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRInterface_PerfSettingsSubDomain: + +.. rst-class:: classref-enumeration + +enum **PerfSettingsSubDomain**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsSubDomain` **PERF_SETTINGS_SUB_DOMAIN_COMPOSITING** = ``0`` + +The compositing performance within the runtime has reached a new level. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_RENDERING: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsSubDomain` **PERF_SETTINGS_SUB_DOMAIN_RENDERING** = ``1`` + +The application rendering performance has reached a new level. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_THERMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsSubDomain` **PERF_SETTINGS_SUB_DOMAIN_THERMAL** = ``2`` + +The temperature of the device has reached a new level. + +.. rst-class:: classref-item-separator + +---- + +.. _enum_OpenXRInterface_PerfSettingsNotificationLevel: + +.. rst-class:: classref-enumeration + +enum **PerfSettingsNotificationLevel**: :ref:`🔗` + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_NORMAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsNotificationLevel` **PERF_SETTINGS_NOTIF_LEVEL_NORMAL** = ``0`` + +The sub-domain has reached a level where no further actions other than currently applied are necessary. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_WARNING: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsNotificationLevel` **PERF_SETTINGS_NOTIF_LEVEL_WARNING** = ``1`` + +The sub-domain has reached an early warning level where the application should start proactive mitigation actions. + +.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED: + +.. rst-class:: classref-enumeration-constant + +:ref:`PerfSettingsNotificationLevel` **PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED** = ``2`` + +The sub-domain has reached a critical level where the application should start drastic mitigation actions. .. rst-class:: classref-item-separator @@ -944,6 +1082,30 @@ Sets the given action set as active or inactive. ---- +.. _class_OpenXRInterface_method_set_cpu_level: + +.. rst-class:: classref-method + +|void| **set_cpu_level**\ (\ level\: :ref:`PerfSettingsLevel`\ ) :ref:`🔗` + +Sets the CPU performance level of the OpenXR device. + +.. rst-class:: classref-item-separator + +---- + +.. _class_OpenXRInterface_method_set_gpu_level: + +.. rst-class:: classref-method + +|void| **set_gpu_level**\ (\ level\: :ref:`PerfSettingsLevel`\ ) :ref:`🔗` + +Sets the GPU performance level of the OpenXR device. + +.. rst-class:: classref-item-separator + +---- + .. _class_OpenXRInterface_method_set_motion_range: .. rst-class:: classref-method diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index fb78fbafe86..25d5f638397 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -62,61 +62,65 @@ Methods .. table:: :widths: auto - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_separator`\ (\ text\: :ref:`String` = ""\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_popup`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selectable_item`\ (\ from_last\: :ref:`bool` = false\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_selected_id`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_selected_metadata`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_selectable_items`\ (\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator`\ (\ idx\: :ref:`int`\ ) |const| | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ idx\: :ref:`int`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_id`\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`show_popup`\ (\ ) | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_separator`\ (\ text\: :ref:`String` = ""\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_item_auto_translate_mode`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_popup`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selectable_item`\ (\ from_last\: :ref:`bool` = false\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_selected_id`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_selected_metadata`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_selectable_items`\ (\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator`\ (\ idx\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ idx\: :ref:`int`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_disable_shortcuts`\ (\ disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_auto_translate_mode`\ (\ idx\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ idx\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ idx\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_id`\ (\ idx\: :ref:`int`, id\: :ref:`int`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ idx\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ idx\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ idx\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`show_popup`\ (\ ) | + +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -296,6 +300,18 @@ Clears all the items in the **OptionButton**. ---- +.. _class_OptionButton_method_get_item_auto_translate_mode: + +.. rst-class:: classref-method + +:ref:`AutoTranslateMode` **get_item_auto_translate_mode**\ (\ idx\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the auto translate mode of the item at index ``idx``. + +.. rst-class:: classref-item-separator + +---- + .. _class_OptionButton_method_get_item_icon: .. rst-class:: classref-method @@ -494,6 +510,20 @@ If ``true``, shortcuts are disabled and cannot be used to trigger the button. ---- +.. _class_OptionButton_method_set_item_auto_translate_mode: + +.. rst-class:: classref-method + +|void| **set_item_auto_translate_mode**\ (\ idx\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`🔗` + +Sets the auto translate mode of the item at index ``idx``. + +Items use :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT` by default, which uses the same auto translate mode as the **OptionButton** itself. + +.. rst-class:: classref-item-separator + +---- + .. _class_OptionButton_method_set_item_disabled: .. rst-class:: classref-method diff --git a/classes/class_os.rst b/classes/class_os.rst index 654f21f5289..a1c9ca2113b 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -179,9 +179,9 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`open_midi_inputs`\ (\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`read_buffer_from_stdin`\ (\ buffer_size\: :ref:`int`\ ) | + | :ref:`PackedByteArray` | :ref:`read_buffer_from_stdin`\ (\ buffer_size\: :ref:`int` = 1024\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`read_string_from_stdin`\ (\ buffer_size\: :ref:`int`\ ) | + | :ref:`String` | :ref:`read_string_from_stdin`\ (\ buffer_size\: :ref:`int` = 1024\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`request_permission`\ (\ name\: :ref:`String`\ ) | +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1223,7 +1223,9 @@ Returns the amount of static memory being used by the program in bytes. Only wor :ref:`StdHandleType` **get_stderr_type**\ (\ ) |const| :ref:`🔗` -Returns type of the standard error device. +Returns the type of the standard error device. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. .. rst-class:: classref-item-separator @@ -1235,7 +1237,11 @@ Returns type of the standard error device. :ref:`StdHandleType` **get_stdin_type**\ (\ ) |const| :ref:`🔗` -Returns type of the standard input device. +Returns the type of the standard input device. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. + +\ **Note:** On exported Windows builds, run the console wrapper executable to access the standard input. If you need a single executable with full console support, use a custom build compiled with the ``windows_subsystem=console`` flag. .. rst-class:: classref-item-separator @@ -1247,7 +1253,9 @@ Returns type of the standard input device. :ref:`StdHandleType` **get_stdout_type**\ (\ ) |const| :ref:`🔗` -Returns type of the standard output device. +Returns the type of the standard output device. + +\ **Note:** This method is implemented on Linux, macOS, and Windows. .. rst-class:: classref-item-separator @@ -1669,9 +1677,9 @@ Initializes the singleton for the system MIDI driver, allowing Godot to receive .. rst-class:: classref-method -:ref:`PackedByteArray` **read_buffer_from_stdin**\ (\ buffer_size\: :ref:`int`\ ) :ref:`🔗` +:ref:`PackedByteArray` **read_buffer_from_stdin**\ (\ buffer_size\: :ref:`int` = 1024\ ) :ref:`🔗` -Reads a user input as raw data from the standard input. This operation can be *blocking*, which causes the window to freeze if :ref:`read_string_from_stdin()` is called on the main thread. +Reads a user input as raw data from the standard input. This operation can be *blocking*, which causes the window to freeze if :ref:`read_buffer_from_stdin()` is called on the main thread. - If standard input is console, this method will block until the program receives a line break in standard input (usually by the user pressing :kbd:`Enter`). @@ -1691,7 +1699,7 @@ Reads a user input as raw data from the standard input. This operation can be *b .. rst-class:: classref-method -:ref:`String` **read_string_from_stdin**\ (\ buffer_size\: :ref:`int`\ ) :ref:`🔗` +:ref:`String` **read_string_from_stdin**\ (\ buffer_size\: :ref:`int` = 1024\ ) :ref:`🔗` Reads a user input as a UTF-8 encoded string from the standard input. This operation can be *blocking*, which causes the window to freeze if :ref:`read_string_from_stdin()` is called on the main thread. diff --git a/classes/class_packedbytearray.rst b/classes/class_packedbytearray.rst index 23d859d2993..3fce1518c09 100644 --- a/classes/class_packedbytearray.rst +++ b/classes/class_packedbytearray.rst @@ -21,7 +21,7 @@ An array specifically designed to hold bytes. Packs data tightly, so it saves me \ **PackedByteArray** also provides methods to encode/decode various types to/from bytes. The way values are encoded is an implementation detail and shouldn't be relied upon when interacting with external apps. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -58,6 +58,12 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`bsearch`\ (\ value\: :ref:`int`, before\: :ref:`bool` = true\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bswap16`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bswap32`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`bswap64`\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`compress`\ (\ compression_mode\: :ref:`int` = 0\ ) |const| | @@ -120,6 +126,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`encode_var`\ (\ byte_offset\: :ref:`int`, value\: :ref:`Variant`, allow_objects\: :ref:`bool` = false\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -128,6 +136,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_ascii`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_string_from_multibyte_char`\ (\ encoding\: :ref:`String` = ""\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_utf8`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string_from_utf16`\ (\ ) |const| | @@ -275,6 +285,42 @@ Finds the index of an existing value (or the insertion index that maintains sort ---- +.. _class_PackedByteArray_method_bswap16: + +.. rst-class:: classref-method + +|void| **bswap16**\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) :ref:`🔗` + +Swaps the byte order of ``count`` 16-bit segments of the array starting at ``offset``. Swap is done in-place. If ``count`` is less than zero, all segments to the end of array are processed, if processed data size is not a multiple of 2, the byte after the last processed 16-bit segment is not modified. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_bswap32: + +.. rst-class:: classref-method + +|void| **bswap32**\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) :ref:`🔗` + +Swaps the byte order of ``count`` 32-bit segments of the array starting at ``offset``. Swap is done in-place. If ``count`` is less than zero, all segments to the end of array are processed, if processed data size is not a multiple of 4, bytes after the last processed 32-bit segment are not modified. + +.. rst-class:: classref-item-separator + +---- + +.. _class_PackedByteArray_method_bswap64: + +.. rst-class:: classref-method + +|void| **bswap64**\ (\ offset\: :ref:`int` = 0, count\: :ref:`int` = -1\ ) :ref:`🔗` + +Swaps the byte order of ``count`` 64-bit segments of the array starting at ``offset``. Swap is done in-place. If ``count`` is less than zero, all segments to the end of array are processed, if processed data size is not a multiple of 8, bytes after the last processed 64-bit segment are not modified. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_clear: .. rst-class:: classref-method @@ -655,6 +701,18 @@ Encodes a :ref:`Variant` at the index of ``byte_offset`` bytes. A ---- +.. _class_PackedByteArray_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`int`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_fill: .. rst-class:: classref-method @@ -703,6 +761,24 @@ Converts ASCII/Latin-1 encoded array to :ref:`String`. Fast altern ---- +.. _class_PackedByteArray_method_get_string_from_multibyte_char: + +.. rst-class:: classref-method + +:ref:`String` **get_string_from_multibyte_char**\ (\ encoding\: :ref:`String` = ""\ ) |const| :ref:`🔗` + +Converts system multibyte code page encoded array to :ref:`String`. If conversion fails, empty string is returned. This is the inverse of :ref:`String.to_multibyte_char_buffer()`. + +The values permitted for ``encoding`` are system dependent. If ``encoding`` is empty string, system default encoding is used. + +- For Windows, see `Code Page Identifiers `__ .NET names. + +- For macOS and Linux/BSD, see ``libiconv`` library documentation and ``iconv --list`` for a list of supported encodings. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedByteArray_method_get_string_from_utf8: .. rst-class:: classref-method @@ -721,7 +797,7 @@ Converts UTF-8 encoded array to :ref:`String`. Slower than :ref:`g :ref:`String` **get_string_from_utf16**\ (\ ) |const| :ref:`🔗` -Converts UTF-16 encoded array to :ref:`String`. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of :ref:`String.to_utf16_buffer()`. +Converts UTF-16 encoded array to :ref:`String`. If the BOM is missing, little-endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of :ref:`String.to_utf16_buffer()`. .. rst-class:: classref-item-separator @@ -733,7 +809,7 @@ Converts UTF-16 encoded array to :ref:`String`. If the BOM is miss :ref:`String` **get_string_from_utf32**\ (\ ) |const| :ref:`🔗` -Converts UTF-32 encoded array to :ref:`String`. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string. This is the inverse of :ref:`String.to_utf32_buffer()`. +Converts UTF-32 encoded array to :ref:`String`. Returns empty string if source array is not valid UTF-32 string. This is the inverse of :ref:`String.to_utf32_buffer()`. .. rst-class:: classref-item-separator @@ -858,6 +934,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedcolorarray.rst b/classes/class_packedcolorarray.rst index 58b78c991a4..cf9fea9bcb1 100644 --- a/classes/class_packedcolorarray.rst +++ b/classes/class_packedcolorarray.rst @@ -21,7 +21,7 @@ An array specifically designed to hold :ref:`Color`. Packs data tig \ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedColorArray** versus ``Array[Color]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map()`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -64,6 +64,8 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`duplicate`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -241,6 +243,18 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedColorArray_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Color`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedColorArray_method_fill: .. rst-class:: classref-method @@ -345,6 +359,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedfloat32array.rst b/classes/class_packedfloat32array.rst index 8d107ebb6b9..d321550b229 100644 --- a/classes/class_packedfloat32array.rst +++ b/classes/class_packedfloat32array.rst @@ -21,7 +21,7 @@ An array specifically designed to hold 32-bit floating-point values (float). Pac If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array`. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -64,6 +64,8 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -239,6 +241,20 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedFloat32Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`float`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +\ **Note:** :ref:`@GDScript.NAN` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedFloat32Array_method_fill: .. rst-class:: classref-method @@ -347,6 +363,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedfloat64array.rst b/classes/class_packedfloat64array.rst index 749ef08527c..d044dfacc4e 100644 --- a/classes/class_packedfloat64array.rst +++ b/classes/class_packedfloat64array.rst @@ -23,7 +23,7 @@ If you only need to pack 32-bit floats tightly, see :ref:`PackedFloat32Array`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -66,6 +66,8 @@ Methods +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat64Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -241,6 +243,20 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedFloat64Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`float`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +\ **Note:** :ref:`@GDScript.NAN` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedFloat64Array_method_fill: .. rst-class:: classref-method @@ -349,6 +365,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedint32array.rst b/classes/class_packedint32array.rst index d44049d2782..ea19595ff0b 100644 --- a/classes/class_packedint32array.rst +++ b/classes/class_packedint32array.rst @@ -21,7 +21,7 @@ An array specifically designed to hold 32-bit integer values. Packs data tightly \ **Note:** This type stores signed 32-bit integers, which means it can take values in the interval ``[-2^31, 2^31 - 1]``, i.e. ``[-2147483648, 2147483647]``. Exceeding those bounds will wrap around. In comparison, :ref:`int` uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see :ref:`PackedInt64Array`. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -64,6 +64,8 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`duplicate`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -235,6 +237,18 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedInt32Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`int`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedInt32Array_method_fill: .. rst-class:: classref-method @@ -339,6 +353,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedint64array.rst b/classes/class_packedint64array.rst index e9989608081..7422979dde7 100644 --- a/classes/class_packedint64array.rst +++ b/classes/class_packedint64array.rst @@ -23,7 +23,7 @@ An array specifically designed to hold 64-bit integer values. Packs data tightly \ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedInt64Array** versus ``Array[int]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map()`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -66,6 +66,8 @@ Methods +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`duplicate`\ (\ ) | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -237,6 +239,18 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedInt64Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`int`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedInt64Array_method_fill: .. rst-class:: classref-method @@ -341,6 +355,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedstringarray.rst b/classes/class_packedstringarray.rst index 8903963daa5..d36d25e858e 100644 --- a/classes/class_packedstringarray.rst +++ b/classes/class_packedstringarray.rst @@ -29,7 +29,7 @@ If you want to join the strings in the array, use :ref:`String.join()`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -79,6 +79,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`duplicate`\ (\ ) | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -250,6 +252,18 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedStringArray_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`String`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedStringArray_method_fill: .. rst-class:: classref-method @@ -354,6 +368,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedvector2array.rst b/classes/class_packedvector2array.rst index fabd1a9c713..898ce5e8cac 100644 --- a/classes/class_packedvector2array.rst +++ b/classes/class_packedvector2array.rst @@ -21,7 +21,7 @@ An array specifically designed to hold :ref:`Vector2`. Packs data \ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedVector2Array** versus ``Array[Vector2]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map()`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -71,6 +71,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -254,6 +256,20 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedVector2Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Vector2`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedVector2Array_method_fill: .. rst-class:: classref-method @@ -362,6 +378,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedvector3array.rst b/classes/class_packedvector3array.rst index f8cda061ea4..bb55dac1cd0 100644 --- a/classes/class_packedvector3array.rst +++ b/classes/class_packedvector3array.rst @@ -21,7 +21,7 @@ An array specifically designed to hold :ref:`Vector3`. Packs data \ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedVector3Array** versus ``Array[Vector3]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map()`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -64,6 +64,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -247,6 +249,20 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedVector3Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Vector3`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedVector3Array_method_fill: .. rst-class:: classref-method @@ -355,6 +371,8 @@ Removes an element from the array by index. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_packedvector4array.rst b/classes/class_packedvector4array.rst index eefec7bbaa6..cfd0bb4fbf8 100644 --- a/classes/class_packedvector4array.rst +++ b/classes/class_packedvector4array.rst @@ -21,7 +21,7 @@ An array specifically designed to hold :ref:`Vector4`. Packs data \ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedVector4Array** versus ``Array[Vector4]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map()`. Typed arrays are in turn faster to iterate on and modify than untyped arrays. -\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will *not* affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again. +\ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again. .. note:: @@ -64,6 +64,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector4Array` | :ref:`duplicate`\ (\ ) | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + | :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| | @@ -245,6 +247,20 @@ Creates a copy of the array, and returns it. ---- +.. _class_PackedVector4Array_method_erase: + +.. rst-class:: classref-method + +:ref:`bool` **erase**\ (\ value\: :ref:`Vector4`\ ) :ref:`🔗` + +Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()` instead. + +\ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included. + +.. rst-class:: classref-item-separator + +---- + .. _class_PackedVector4Array_method_fill: .. rst-class:: classref-method @@ -351,7 +367,9 @@ Removes an element from the array by index. :ref:`int` **resize**\ (\ new_size\: :ref:`int`\ ) :ref:`🔗` -Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. +Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()` once and assigning the new values is faster than adding new elements one by one. + +Returns :ref:`@GlobalScope.OK` on success, or one of the following :ref:`Error` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY` if allocations fail. Use :ref:`size()` to find the actual size of the array after resize. .. rst-class:: classref-item-separator diff --git a/classes/class_path3d.rst b/classes/class_path3d.rst index 500c6ba958e..cf562f85e76 100644 --- a/classes/class_path3d.rst +++ b/classes/class_path3d.rst @@ -31,9 +31,11 @@ Properties .. table:: :widths: auto - +-------------------------------+-------------------------------------------+ - | :ref:`Curve3D` | :ref:`curve` | - +-------------------------------+-------------------------------------------+ + +-------------------------------+---------------------------------------------------------------------+-----------------------+ + | :ref:`Curve3D` | :ref:`curve` | | + +-------------------------------+---------------------------------------------------------------------+-----------------------+ + | :ref:`Color` | :ref:`debug_custom_color` | ``Color(0, 0, 0, 1)`` | + +-------------------------------+---------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator @@ -52,6 +54,18 @@ Signals Emitted when the :ref:`curve` changes. +.. rst-class:: classref-item-separator + +---- + +.. _class_Path3D_signal_debug_color_changed: + +.. rst-class:: classref-signal + +**debug_color_changed**\ (\ ) :ref:`🔗` + +Emitted when the :ref:`debug_custom_color` changes. + .. rst-class:: classref-section-separator ---- @@ -74,6 +88,25 @@ Property Descriptions A :ref:`Curve3D` describing the path. +.. rst-class:: classref-item-separator + +---- + +.. _class_Path3D_property_debug_custom_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug_custom_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |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. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_performance.rst b/classes/class_performance.rst index a321e19872e..03a6869c5c2 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -266,7 +266,7 @@ Output latency of the :ref:`AudioServer`. Equivalent to calli :ref:`Monitor` **NAVIGATION_ACTIVE_MAPS** = ``24`` -Number of active navigation maps in the :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 two empty default navigation maps created by World2D and World3D. .. _class_Performance_constant_NAVIGATION_REGION_COUNT: @@ -274,7 +274,7 @@ Number of active navigation maps in the :ref:`NavigationServer3D` **NAVIGATION_REGION_COUNT** = ``25`` -Number of active navigation regions in the :ref:`NavigationServer3D`. +Number of active navigation regions in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_AGENT_COUNT: @@ -282,7 +282,7 @@ Number of active navigation regions in the :ref:`NavigationServer3D` **NAVIGATION_AGENT_COUNT** = ``26`` -Number of active navigation agents processing avoidance in the :ref:`NavigationServer3D`. +Number of active navigation agents processing avoidance in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_LINK_COUNT: @@ -290,7 +290,7 @@ Number of active navigation agents processing avoidance in the :ref:`NavigationS :ref:`Monitor` **NAVIGATION_LINK_COUNT** = ``27`` -Number of active navigation links in the :ref:`NavigationServer3D`. +Number of active navigation links in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_POLYGON_COUNT: @@ -298,7 +298,7 @@ Number of active navigation links in the :ref:`NavigationServer3D` **NAVIGATION_POLYGON_COUNT** = ``28`` -Number of navigation mesh polygons in the :ref:`NavigationServer3D`. +Number of navigation mesh polygons in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_EDGE_COUNT: @@ -306,7 +306,7 @@ Number of navigation mesh polygons in the :ref:`NavigationServer3D` **NAVIGATION_EDGE_COUNT** = ``29`` -Number of navigation mesh polygon edges in the :ref:`NavigationServer3D`. +Number of navigation mesh polygon edges in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_EDGE_MERGE_COUNT: @@ -314,7 +314,7 @@ Number of navigation mesh polygon edges in the :ref:`NavigationServer3D` **NAVIGATION_EDGE_MERGE_COUNT** = ``30`` -Number of navigation mesh polygon edges that were merged due to edge key overlap in the :ref:`NavigationServer3D`. +Number of navigation mesh polygon edges that were merged due to edge key overlap in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_EDGE_CONNECTION_COUNT: @@ -322,7 +322,7 @@ Number of navigation mesh polygon edges that were merged due to edge key overlap :ref:`Monitor` **NAVIGATION_EDGE_CONNECTION_COUNT** = ``31`` -Number of polygon edges that are considered connected by edge proximity :ref:`NavigationServer3D`. +Number of polygon edges that are considered connected by edge proximity :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_NAVIGATION_EDGE_FREE_COUNT: @@ -330,7 +330,7 @@ Number of polygon edges that are considered connected by edge proximity :ref:`Na :ref:`Monitor` **NAVIGATION_EDGE_FREE_COUNT** = ``32`` -Number of navigation mesh polygon edges that could not be merged in the :ref:`NavigationServer3D`. The edges still may be connected by edge proximity or with links. +Number of navigation mesh polygon edges that could not be merged in :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. The edges still may be connected by edge proximity or with links. .. _class_Performance_constant_NAVIGATION_OBSTACLE_COUNT: @@ -338,7 +338,7 @@ Number of navigation mesh polygon edges that could not be merged in the :ref:`Na :ref:`Monitor` **NAVIGATION_OBSTACLE_COUNT** = ``33`` -Number of active navigation obstacles in the :ref:`NavigationServer3D`. +Number of active navigation obstacles in the :ref:`NavigationServer2D` and :ref:`NavigationServer3D`. .. _class_Performance_constant_PIPELINE_COMPILATIONS_CANVAS: @@ -380,11 +380,171 @@ Number of pipeline compilations that were triggered while drawing the scene. The Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever. +.. _class_Performance_constant_NAVIGATION_2D_ACTIVE_MAPS: + +.. rst-class:: classref-enumeration-constant + +: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. + +.. _class_Performance_constant_NAVIGATION_2D_REGION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_REGION_COUNT** = ``40`` + +Number of active navigation regions in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_AGENT_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_AGENT_COUNT** = ``41`` + +Number of active navigation agents processing avoidance in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_LINK_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_LINK_COUNT** = ``42`` + +Number of active navigation links in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_POLYGON_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_POLYGON_COUNT** = ``43`` + +Number of navigation mesh polygons in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_COUNT** = ``44`` + +Number of navigation mesh polygon edges in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_MERGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_MERGE_COUNT** = ``45`` + +Number of navigation mesh polygon edges that were merged due to edge key overlap in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_CONNECTION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_CONNECTION_COUNT** = ``46`` + +Number of polygon edges that are considered connected by edge proximity :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_2D_EDGE_FREE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_EDGE_FREE_COUNT** = ``47`` + +Number of navigation mesh polygon edges that could not be merged in the :ref:`NavigationServer2D`. The edges still may be connected by edge proximity or with links. + +.. _class_Performance_constant_NAVIGATION_2D_OBSTACLE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_2D_OBSTACLE_COUNT** = ``48`` + +Number of active navigation obstacles in the :ref:`NavigationServer2D`. + +.. _class_Performance_constant_NAVIGATION_3D_ACTIVE_MAPS: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **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. + +.. _class_Performance_constant_NAVIGATION_3D_REGION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_REGION_COUNT** = ``50`` + +Number of active navigation regions in the :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_AGENT_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_AGENT_COUNT** = ``51`` + +Number of active navigation agents processing avoidance in the :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_LINK_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_LINK_COUNT** = ``52`` + +Number of active navigation links in the :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_POLYGON_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_POLYGON_COUNT** = ``53`` + +Number of navigation mesh polygons in the :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_COUNT** = ``54`` + +Number of navigation mesh polygon edges in the :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_MERGE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_MERGE_COUNT** = ``55`` + +Number of navigation mesh polygon edges that were merged due to edge key overlap in the :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_CONNECTION_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_CONNECTION_COUNT** = ``56`` + +Number of polygon edges that are considered connected by edge proximity :ref:`NavigationServer3D`. + +.. _class_Performance_constant_NAVIGATION_3D_EDGE_FREE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_EDGE_FREE_COUNT** = ``57`` + +Number of navigation mesh polygon edges that could not be merged in the :ref:`NavigationServer3D`. The edges still may be connected by edge proximity or with links. + +.. _class_Performance_constant_NAVIGATION_3D_OBSTACLE_COUNT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Monitor` **NAVIGATION_3D_OBSTACLE_COUNT** = ``58`` + +Number of active navigation obstacles in the :ref:`NavigationServer3D`. + .. _class_Performance_constant_MONITOR_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Monitor` **MONITOR_MAX** = ``39`` +:ref:`Monitor` **MONITOR_MAX** = ``59`` Represents the size of the :ref:`Monitor` enum. diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index 46cbfc96ca7..eea1fadd712 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -99,9 +99,7 @@ Returned points are a list of pairs of contact points. For each pair the first o :ref:`Dictionary` **get_rest_info**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters2D`\ ) :ref:`🔗` -Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. - -\ **Note:** This method does not take into account the ``motion`` property of the object. The returned object is a dictionary containing the following fields: +Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters2D` object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: \ ``collider_id``: The colliding object's ID. @@ -115,6 +113,8 @@ Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryPara \ ``shape``: The shape index of the colliding shape. +If the shape did not intersect anything, then an empty dictionary is returned instead. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_physicsdirectspacestate3d.rst b/classes/class_physicsdirectspacestate3d.rst index 11d9e5f032e..4393836176d 100644 --- a/classes/class_physicsdirectspacestate3d.rst +++ b/classes/class_physicsdirectspacestate3d.rst @@ -69,7 +69,7 @@ Method Descriptions :ref:`PackedFloat32Array` **cast_motion**\ (\ parameters\: :ref:`PhysicsShapeQueryParameters3D`\ ) :ref:`🔗` -Checks how far a :ref:`Shape3D` can move without colliding. All the parameters for the query, including the shape, are supplied through a :ref:`PhysicsShapeQueryParameters3D` object. +Checks how far a :ref:`Shape3D` can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a :ref:`PhysicsShapeQueryParameters3D` object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of ``[1.0, 1.0]`` will be returned. diff --git a/classes/class_popup.rst b/classes/class_popup.rst index 912e6e85b29..5ede05f234f 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -31,19 +31,25 @@ Properties .. table:: :widths: auto - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | borderless | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | popup_window | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | transient | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | unresizable | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | visible | ``false`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ - | :ref:`bool` | wrap_controls | ``true`` (overrides :ref:`Window`) | - +-------------------------+---------------+-------------------------------------------------------------------------+ + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | borderless | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | maximize_disabled | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | minimize_disabled | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | popup_window | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | popup_wm_hint | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | transient | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | unresizable | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | visible | ``false`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ + | :ref:`bool` | wrap_controls | ``true`` (overrides :ref:`Window`) | + +-------------------------+-------------------+-----------------------------------------------------------------------------+ .. rst-class:: classref-section-separator diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 1dac31e99ef..22a3d9635ba 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -67,149 +67,153 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`activate_item_by_event`\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_radio_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_radio_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_icon_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_multistate_item`\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_radio_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_radio_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_separator`\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_submenu_item`\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_submenu_node_item`\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ free_submenus\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_focused_item`\ (\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_item_accelerator`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_icon_max_width`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_indent`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_language`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_multistate`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_multistate_max`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shortcut` | :ref:`get_item_shortcut`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_submenu`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PopupMenu` | :ref:`get_item_submenu_node`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checkable`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checked`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_radio_checkable`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_shortcut_disabled`\ (\ index\: :ref:`int`\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_native_menu`\ (\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_system_menu`\ (\ ) |const| | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_item`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`scroll_to_item`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_focused_item`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_accelerator`\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_as_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_as_radio_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_as_separator`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_checked`\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon`\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_max_width`\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_icon_modulate`\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_id`\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_indent`\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_language`\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_metadata`\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_multistate`\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_multistate_max`\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_shortcut`\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_shortcut_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_submenu`\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_submenu_node`\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text`\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_text_direction`\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_item_tooltip`\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`toggle_item_checked`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`toggle_item_multistate`\ (\ index\: :ref:`int`\ ) | - +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`activate_item_by_event`\ (\ event\: :ref:`InputEvent`, for_global_only\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_radio_check_item`\ (\ texture\: :ref:`Texture2D`, label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_radio_check_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_icon_shortcut`\ (\ texture\: :ref:`Texture2D`, shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_multistate_item`\ (\ label\: :ref:`String`, max_states\: :ref:`int`, default_state\: :ref:`int` = 0, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_radio_check_item`\ (\ label\: :ref:`String`, id\: :ref:`int` = -1, accel\: :ref:`Key` = 0\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_radio_check_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_separator`\ (\ label\: :ref:`String` = "", id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_shortcut`\ (\ shortcut\: :ref:`Shortcut`, id\: :ref:`int` = -1, global\: :ref:`bool` = false, allow_echo\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_submenu_item`\ (\ label\: :ref:`String`, submenu\: :ref:`String`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_submenu_node_item`\ (\ label\: :ref:`String`, submenu\: :ref:`PopupMenu`, id\: :ref:`int` = -1\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ free_submenus\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_focused_item`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_item_accelerator`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_item_auto_translate_mode`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_icon_max_width`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_icon_modulate`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_indent`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index`\ (\ id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_language`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_multistate`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_multistate_max`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shortcut` | :ref:`get_item_shortcut`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_submenu`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PopupMenu` | :ref:`get_item_submenu_node`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_item_text_direction`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checkable`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checked`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_radio_checkable`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_shortcut_disabled`\ (\ index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_native_menu`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_system_menu`\ (\ ) |const| | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_item`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`scroll_to_item`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_focused_item`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_accelerator`\ (\ index\: :ref:`int`, accel\: :ref:`Key`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_radio_checkable`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_as_separator`\ (\ index\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_auto_translate_mode`\ (\ index\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_checked`\ (\ index\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon`\ (\ index\: :ref:`int`, icon\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_max_width`\ (\ index\: :ref:`int`, width\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_icon_modulate`\ (\ index\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_id`\ (\ index\: :ref:`int`, id\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_indent`\ (\ index\: :ref:`int`, indent\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_language`\ (\ index\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_metadata`\ (\ index\: :ref:`int`, metadata\: :ref:`Variant`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_multistate`\ (\ index\: :ref:`int`, state\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_multistate_max`\ (\ index\: :ref:`int`, max_states\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shortcut`\ (\ index\: :ref:`int`, shortcut\: :ref:`Shortcut`, global\: :ref:`bool` = false\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_shortcut_disabled`\ (\ index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_submenu`\ (\ index\: :ref:`int`, submenu\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_submenu_node`\ (\ index\: :ref:`int`, submenu\: :ref:`PopupMenu`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text`\ (\ index\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_text_direction`\ (\ index\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_item_tooltip`\ (\ index\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_item_checked`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`toggle_item_multistate`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -810,6 +814,18 @@ Returns the accelerator of the item at the given ``index``. An accelerator is a ---- +.. _class_PopupMenu_method_get_item_auto_translate_mode: + +.. rst-class:: classref-method + +:ref:`AutoTranslateMode` **get_item_auto_translate_mode**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the auto translate mode of the item at the given ``index``. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_get_item_icon: .. rst-class:: classref-method @@ -1196,6 +1212,20 @@ Mark the item at the given ``index`` as a separator, which means that it would b ---- +.. _class_PopupMenu_method_set_item_auto_translate_mode: + +.. rst-class:: classref-method + +|void| **set_item_auto_translate_mode**\ (\ index\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) :ref:`🔗` + +Sets the auto translate mode of the item at the given ``index``. + +Items use :ref:`Node.AUTO_TRANSLATE_MODE_INHERIT` by default, which uses the same auto translate mode as the **PopupMenu** itself. + +.. rst-class:: classref-item-separator + +---- + .. _class_PopupMenu_method_set_item_checked: .. rst-class:: classref-method diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index 3fbe6b1667b..2a71d1f8495 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -152,6 +152,18 @@ enum **CompressionMode**: :ref:`🔗` **COMPRESSION_MODE_ASTC** = ``6`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index b9eb6ceeb1a..79939bf9380 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -113,7 +113,7 @@ Overrides the :ref:`AABB` with one defined by user for use with frus - |void| **set_flip_faces**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_flip_faces**\ (\ ) -If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn. +If ``true``, the order of the vertices in each triangle is reversed, resulting in the backside of the mesh being drawn. This gives the same result as using :ref:`BaseMaterial3D.CULL_FRONT` in :ref:`BaseMaterial3D.cull_mode`. diff --git a/classes/class_projection.rst b/classes/class_projection.rst index 339dd37ec70..a68da7dd324 100644 --- a/classes/class_projection.rst +++ b/classes/class_projection.rst @@ -570,7 +570,7 @@ Returns the factor by which the visible level of detail is scaled by this **Proj :ref:`int` **get_pixels_per_meter**\ (\ for_pixel_width\: :ref:`int`\ ) |const| :ref:`🔗` -Returns the number of pixels with the given pixel width displayed per meter, after this **Projection** is applied. +Returns ``for_pixel_width`` divided by the viewport's width measured in meters on the near plane, after this **Projection** is applied. .. rst-class:: classref-item-separator diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 270cdce5644..5e3776698e1 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -48,6 +48,10 @@ Properties .. table:: :widths: auto + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility/general/accessibility_support` | ``0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`accessibility/general/updates_per_second` | ``60`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`animation/warnings/check_angle_interpolation_type_conflicting` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -317,23 +321,41 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/shader_language/warnings/unused_varying` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/agents_radius_color` | ``Color(1, 1, 0, 0.25)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/agents_radius_color` | ``Color(1, 1, 0, 0.25)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/avoidance/2d/enable_agents_radius` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/avoidance/2d/enable_obstacles_radius` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/avoidance/2d/enable_obstacles_static` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_radius_color` | ``Color(1, 0.5, 0, 0.25)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_edge_pushin_color` | ``Color(1, 0, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/avoidance/enable_agents_radius` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_edge_pushout_color` | ``Color(1, 1, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/avoidance/enable_obstacles_radius` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_face_pushin_color` | ``Color(1, 0, 0, 0)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/avoidance/enable_obstacles_static` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/2d/obstacles_static_face_pushout_color` | ``Color(1, 1, 0, 0.5)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_radius_color` | ``Color(1, 0.5, 0, 0.25)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/agents_radius_color` | ``Color(1, 1, 0, 0.25)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_edge_pushin_color` | ``Color(1, 0, 0, 1)`` | + | :ref:`bool` | :ref:`debug/shapes/avoidance/3d/enable_agents_radius` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_edge_pushout_color` | ``Color(1, 1, 0, 1)`` | + | :ref:`bool` | :ref:`debug/shapes/avoidance/3d/enable_obstacles_radius` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_face_pushin_color` | ``Color(1, 0, 0, 0)`` | + | :ref:`bool` | :ref:`debug/shapes/avoidance/3d/enable_obstacles_static` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/avoidance/obstacles_static_face_pushout_color` | ``Color(1, 1, 0, 0.5)`` | + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_radius_color` | ``Color(1, 0.5, 0, 0.25)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_edge_pushin_color` | ``Color(1, 0, 0, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_edge_pushout_color` | ``Color(1, 1, 0, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_face_pushin_color` | ``Color(1, 0, 0, 0)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/avoidance/3d/obstacles_static_face_pushout_color` | ``Color(1, 1, 0, 0.5)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color(1, 0.2, 0.1, 0.8)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -343,41 +365,69 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color(0, 0.6, 0.7, 0.42)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/agent_path_color` | ``Color(1, 0, 0, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/agent_path_color` | ``Color(1, 0, 0, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`debug/shapes/navigation/2d/agent_path_point_size` | ``4.0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/edge_connection_color` | ``Color(1, 0, 1, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_agent_paths` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`debug/shapes/navigation/agent_path_point_size` | ``4.0`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_edge_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/edge_connection_color` | ``Color(1, 0, 1, 1)`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_edge_lines` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_agent_paths` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_geometry_face_random_color` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_agent_paths_xray` | ``true`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/2d/enable_link_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections_xray` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines_xray` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_geometry_face_random_color` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_link_connections` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/2d/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`debug/shapes/navigation/enable_link_connections_xray` | ``true`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/agent_path_color` | ``Color(1, 0, 0, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | + | :ref:`float` | :ref:`debug/shapes/navigation/3d/agent_path_point_size` | ``4.0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/edge_connection_color` | ``Color(1, 0, 1, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_agent_paths` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_agent_paths_xray` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`debug/shapes/navigation/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_connections_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_lines` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_edge_lines_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_geometry_face_random_color` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_link_connections` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`debug/shapes/navigation/3d/enable_link_connections_xray` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/shapes/navigation/3d/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`debug/shapes/paths/geometry_color` | ``Color(0.1, 1, 0.7, 0.4)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -433,6 +483,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`display/window/size/initial_screen` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/maximize_disabled` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`display/window/size/minimize_disabled` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`display/window/size/mode` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`display/window/size/no_focus` | ``false`` | @@ -527,7 +581,7 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`gui/common/snap_controls_to_pixels` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`gui/common/swap_cancel_ok` | | + | :ref:`int` | :ref:`gui/common/swap_cancel_ok` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -563,8 +617,12 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_accept` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_accessibility_drag_and_drop` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_cancel` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_colorpicker_delete_preset` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_copy` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_cut` | | @@ -579,6 +637,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_filedialog_up_one_level` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_focus_mode` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_focus_next` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | @@ -587,6 +647,14 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_graph_duplicate` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_left` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_left.macos` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_right` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`input/ui_graph_follow_right.macos` | | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_home` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`input/ui_left` | | @@ -725,10 +793,14 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`input_devices/pen_tablet/driver.windows` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/disable_scroll_deadzone` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/android/enable_long_press_as_right_click` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/android/enable_pan_and_scale_gestures` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/override_volume_buttons` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`input_devices/pointing/android/rotary_input_scroll_axis` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | @@ -1762,43 +1834,45 @@ Methods .. table:: :widths: auto - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_property_info`\ (\ hint\: :ref:`Dictionary`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ name\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_global_class_list`\ (\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_order`\ (\ name\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting`\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_setting_with_override`\ (\ name\: :ref:`StringName`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`globalize_path`\ (\ path\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`has_setting`\ (\ name\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`load_resource_pack`\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`localize_path`\ (\ path\: :ref:`String`\ ) |const| | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save`\ (\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`save_custom`\ (\ file\: :ref:`String`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_as_basic`\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_as_internal`\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_initial_value`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_order`\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_restart_if_changed`\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_setting`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | - +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_property_info`\ (\ hint\: :ref:`Dictionary`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ name\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_global_class_list`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_order`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting`\ (\ name\: :ref:`String`, default_value\: :ref:`Variant` = null\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting_with_override`\ (\ name\: :ref:`StringName`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_setting_with_override_and_custom_features`\ (\ name\: :ref:`StringName`, features\: :ref:`PackedStringArray`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`globalize_path`\ (\ path\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_setting`\ (\ name\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`load_resource_pack`\ (\ pack\: :ref:`String`, replace_files\: :ref:`bool` = true, offset\: :ref:`int` = 0\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`localize_path`\ (\ path\: :ref:`String`\ ) |const| | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save`\ (\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`save_custom`\ (\ file\: :ref:`String`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_basic`\ (\ name\: :ref:`String`, basic\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_as_internal`\ (\ name\: :ref:`String`, internal\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_initial_value`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_order`\ (\ name\: :ref:`String`, position\: :ref:`int`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_restart_if_changed`\ (\ name\: :ref:`String`, restart\: :ref:`bool`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_setting`\ (\ name\: :ref:`String`, value\: :ref:`Variant`\ ) | + +------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -1826,6 +1900,38 @@ Emitted when any setting is changed, up to once per process frame. Property Descriptions --------------------- +.. _class_ProjectSettings_property_accessibility/general/accessibility_support: + +.. rst-class:: classref-property + +:ref:`int` **accessibility/general/accessibility_support** = ``0`` :ref:`🔗` + +Accessibility support mode: + +- **Auto** (``0``): accessibility support is enabled, but accessibility information updates are processed only if an assistive app (e.g. screen reader or Braille display) is active (default). + +- **Always Active** (``1``): accessibility support is enabled, and accessibility information updates are processed regardless of current assistive apps' status. + +- **Disabled** (``2``): accessibility support is fully disabled. + +\ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, macOS Accessibility Inspector, or AT-SPI Browser do not count as assistive apps. To test your app with these tools, use ``1``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_accessibility/general/updates_per_second: + +.. rst-class:: classref-property + +:ref:`int` **accessibility/general/updates_per_second** = ``60`` :ref:`🔗` + +The number of accessibility information updates per second. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_animation/warnings/check_angle_interpolation_type_conflicting: .. rst-class:: classref-property @@ -2440,7 +2546,7 @@ The default value of ``0.5`` is tuned for headphones. When using speakers, you m The base strength of the panning effect for all :ref:`AudioStreamPlayer3D` nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer3D.panning_strength`. A value of ``0.0`` disables stereo panning entirely, leaving only volume attenuation in place. A value of ``1.0`` completely mutes one of the channels if the sound is located exactly to the left (or right) of the listener. -The default value of ``0.5`` is tuned for headphones. When using speakers, you may find lower values to sound better as speakers have a lower stereo separation compared to headphones. +The default value of ``0.5`` is tuned for headphones which means that the opposite side channel goes no lower than 50% of the volume of the nearside channel. You may find that you can set this value higher for speakers to have the same effect since both ears can hear from each speaker. .. rst-class:: classref-item-separator @@ -2512,7 +2618,7 @@ Sets the `AVAudioSessionCategory ` **audio/general/text_to_speech** = ``false`` :ref:`🔗` -If ``true``, text-to-speech support is enabled, 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 first time TTS method is used, see :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. @@ -3546,11 +3652,11 @@ When set to ``true``, produces a warning when a varying is never used. ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/agents_radius_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/agents_radius_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` Color of the avoidance agents radius, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3558,11 +3664,11 @@ Color of the avoidance agents radius, visible when "Visible Avoidance" is enable ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/enable_agents_radius: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/enable_agents_radius: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_agents_radius** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/avoidance/2d/enable_agents_radius** = ``true`` :ref:`🔗` If enabled, displays avoidance agents radius when "Visible Avoidance" is enabled in the Debug menu. @@ -3570,11 +3676,11 @@ If enabled, displays avoidance agents radius when "Visible Avoidance" is enabled ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/enable_obstacles_radius: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/enable_obstacles_radius: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_obstacles_radius** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/avoidance/2d/enable_obstacles_radius** = ``true`` :ref:`🔗` If enabled, displays avoidance obstacles radius when "Visible Avoidance" is enabled in the Debug menu. @@ -3582,11 +3688,11 @@ If enabled, displays avoidance obstacles radius when "Visible Avoidance" is enab ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/enable_obstacles_static: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/enable_obstacles_static: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/avoidance/enable_obstacles_static** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/avoidance/2d/enable_obstacles_static** = ``true`` :ref:`🔗` If enabled, displays static avoidance obstacles when "Visible Avoidance" is enabled in the Debug menu. @@ -3594,11 +3700,11 @@ If enabled, displays static avoidance obstacles when "Visible Avoidance" is enab ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_radius_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_radius_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` Color of the avoidance obstacles radius, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3606,11 +3712,11 @@ Color of the avoidance obstacles radius, visible when "Visible Avoidance" is ena ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_edge_pushin_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_edge_pushin_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` Color of the static avoidance obstacles edges when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3618,11 +3724,11 @@ Color of the static avoidance obstacles edges when their vertices are winded in ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_edge_pushout_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_edge_pushout_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` Color of the static avoidance obstacles edges when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3630,11 +3736,11 @@ Color of the static avoidance obstacles edges when their vertices are winded in ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_face_pushin_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_face_pushin_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` Color of the static avoidance obstacles faces when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3642,11 +3748,119 @@ Color of the static avoidance obstacles faces when their vertices are winded in ---- -.. _class_ProjectSettings_property_debug/shapes/avoidance/obstacles_static_face_pushout_color: +.. _class_ProjectSettings_property_debug/shapes/avoidance/2d/obstacles_static_face_pushout_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/avoidance/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` +:ref:`Color` **debug/shapes/avoidance/2d/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` + +Color of the static avoidance obstacles faces when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/agents_radius_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/agents_radius_color** = ``Color(1, 1, 0, 0.25)`` :ref:`🔗` + +Color of the avoidance agents radius, visible when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/enable_agents_radius: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/avoidance/3d/enable_agents_radius** = ``true`` :ref:`🔗` + +If enabled, displays avoidance agents radius when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/enable_obstacles_radius: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/avoidance/3d/enable_obstacles_radius** = ``true`` :ref:`🔗` + +If enabled, displays avoidance obstacles radius when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/enable_obstacles_static: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/avoidance/3d/enable_obstacles_static** = ``true`` :ref:`🔗` + +If enabled, displays static avoidance obstacles when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_radius_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_radius_color** = ``Color(1, 0.5, 0, 0.25)`` :ref:`🔗` + +Color of the avoidance obstacles radius, visible when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_edge_pushin_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_edge_pushin_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` + +Color of the static avoidance obstacles edges when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_edge_pushout_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_edge_pushout_color** = ``Color(1, 1, 0, 1)`` :ref:`🔗` + +Color of the static avoidance obstacles edges when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_face_pushin_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_face_pushin_color** = ``Color(1, 0, 0, 0)`` :ref:`🔗` + +Color of the static avoidance obstacles faces when their vertices are winded in order to push agents in, visible when "Visible Avoidance" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/avoidance/3d/obstacles_static_face_pushout_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/avoidance/3d/obstacles_static_face_pushout_color** = ``Color(1, 1, 0, 0.5)`` :ref:`🔗` Color of the static avoidance obstacles faces when their vertices are winded in order to push agents out, visible when "Visible Avoidance" is enabled in the Debug menu. @@ -3702,11 +3916,11 @@ Color of the collision shapes, visible when "Visible Collision Shapes" is enable ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/agent_path_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/agent_path_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` Color to display enabled navigation agent paths when an agent has debug enabled. @@ -3714,11 +3928,11 @@ Color to display enabled navigation agent paths when an agent has debug enabled. ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/agent_path_point_size: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/agent_path_point_size: .. rst-class:: classref-property -:ref:`float` **debug/shapes/navigation/agent_path_point_size** = ``4.0`` :ref:`🔗` +:ref:`float` **debug/shapes/navigation/2d/agent_path_point_size** = ``4.0`` :ref:`🔗` Rasterized size (pixel) used to render navigation agent path points when an agent has debug enabled. @@ -3726,11 +3940,11 @@ Rasterized size (pixel) used to render navigation agent path points when an agen ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/edge_connection_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/edge_connection_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/2d/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` Color to display edge connections between navigation regions, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3738,11 +3952,11 @@ Color to display edge connections between navigation regions, visible when "Visi ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_agent_paths: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_agent_paths: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_agent_paths** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_agent_paths** = ``true`` :ref:`🔗` If enabled, displays navigation agent paths when an agent has debug enabled. @@ -3750,11 +3964,179 @@ If enabled, displays navigation agent paths when an agent has debug enabled. ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_agent_paths_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_edge_connections: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/2d/enable_edge_connections** = ``true`` :ref:`🔗` + +If enabled, displays edge connections between navigation regions when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_edge_lines: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_agent_paths_xray** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/2d/enable_edge_lines** = ``true`` :ref:`🔗` + +If enabled, displays navigation mesh polygon edges when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_geometry_face_random_color: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/2d/enable_geometry_face_random_color** = ``true`` :ref:`🔗` + +If enabled, colorizes each navigation mesh polygon face with a random color when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/enable_link_connections: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/2d/enable_link_connections** = ``true`` :ref:`🔗` + +If enabled, displays navigation link connections when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_edge_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/2d/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` + +Color to display enabled navigation mesh polygon edges, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_edge_disabled_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/2d/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` + +Color to display disabled navigation mesh polygon edges, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_face_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/2d/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` + +Color to display enabled navigation mesh polygon faces, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/geometry_face_disabled_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/2d/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` + +Color to display disabled navigation mesh polygon faces, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/link_connection_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/2d/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` + +Color to use to display navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/2d/link_connection_disabled_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/2d/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` + +Color to use to display disabled navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/agent_path_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/agent_path_color** = ``Color(1, 0, 0, 1)`` :ref:`🔗` + +Color to display enabled navigation agent paths when an agent has debug enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/agent_path_point_size: + +.. rst-class:: classref-property + +:ref:`float` **debug/shapes/navigation/3d/agent_path_point_size** = ``4.0`` :ref:`🔗` + +Rasterized size (pixel) used to render navigation agent path points when an agent has debug enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/edge_connection_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/shapes/navigation/3d/edge_connection_color** = ``Color(1, 0, 1, 1)`` :ref:`🔗` + +Color to display edge connections between navigation regions, visible when "Visible Navigation" is enabled in the Debug menu. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_agent_paths: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_agent_paths** = ``true`` :ref:`🔗` + +If enabled, displays navigation agent paths when an agent has debug enabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_agent_paths_xray: + +.. rst-class:: classref-property + +:ref:`bool` **debug/shapes/navigation/3d/enable_agent_paths_xray** = ``true`` :ref:`🔗` If enabled, displays navigation agent paths through geometry when an agent has debug enabled. @@ -3762,11 +4144,11 @@ If enabled, displays navigation agent paths through geometry when an agent has d ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_connections: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_connections: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_connections** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_connections** = ``true`` :ref:`🔗` If enabled, displays edge connections between navigation regions when "Visible Navigation" is enabled in the Debug menu. @@ -3774,11 +4156,11 @@ If enabled, displays edge connections between navigation regions when "Visible N ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_connections_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_connections_xray: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_connections_xray** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_connections_xray** = ``true`` :ref:`🔗` If enabled, displays edge connections between navigation regions through geometry when "Visible Navigation" is enabled in the Debug menu. @@ -3786,11 +4168,11 @@ If enabled, displays edge connections between navigation regions through geometr ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_lines: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_lines: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_lines** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_lines** = ``true`` :ref:`🔗` If enabled, displays navigation mesh polygon edges when "Visible Navigation" is enabled in the Debug menu. @@ -3798,11 +4180,11 @@ If enabled, displays navigation mesh polygon edges when "Visible Navigation" is ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_edge_lines_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_edge_lines_xray: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_edge_lines_xray** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_edge_lines_xray** = ``true`` :ref:`🔗` If enabled, displays navigation mesh polygon edges through geometry when "Visible Navigation" is enabled in the Debug menu. @@ -3810,11 +4192,11 @@ If enabled, displays navigation mesh polygon edges through geometry when "Visibl ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_geometry_face_random_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_geometry_face_random_color: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_geometry_face_random_color** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_geometry_face_random_color** = ``true`` :ref:`🔗` If enabled, colorizes each navigation mesh polygon face with a random color when "Visible Navigation" is enabled in the Debug menu. @@ -3822,11 +4204,11 @@ If enabled, colorizes each navigation mesh polygon face with a random color when ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_link_connections: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_link_connections: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_link_connections** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_link_connections** = ``true`` :ref:`🔗` If enabled, displays navigation link connections when "Visible Navigation" is enabled in the Debug menu. @@ -3834,11 +4216,11 @@ If enabled, displays navigation link connections when "Visible Navigation" is en ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/enable_link_connections_xray: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/enable_link_connections_xray: .. rst-class:: classref-property -:ref:`bool` **debug/shapes/navigation/enable_link_connections_xray** = ``true`` :ref:`🔗` +:ref:`bool` **debug/shapes/navigation/3d/enable_link_connections_xray** = ``true`` :ref:`🔗` If enabled, displays navigation link connections through geometry when "Visible Navigation" is enabled in the Debug menu. @@ -3846,11 +4228,11 @@ If enabled, displays navigation link connections through geometry when "Visible ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_edge_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_edge_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/3d/geometry_edge_color** = ``Color(0.5, 1, 1, 1)`` :ref:`🔗` Color to display enabled navigation mesh polygon edges, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3858,11 +4240,11 @@ Color to display enabled navigation mesh polygon edges, visible when "Visible Na ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_edge_disabled_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_edge_disabled_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/3d/geometry_edge_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` Color to display disabled navigation mesh polygon edges, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3870,11 +4252,11 @@ Color to display disabled navigation mesh polygon edges, visible when "Visible N ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_face_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_face_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/3d/geometry_face_color** = ``Color(0.5, 1, 1, 0.4)`` :ref:`🔗` Color to display enabled navigation mesh polygon faces, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3882,11 +4264,11 @@ Color to display enabled navigation mesh polygon faces, visible when "Visible Na ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_face_disabled_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/geometry_face_disabled_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/3d/geometry_face_disabled_color** = ``Color(0.5, 0.5, 0.5, 0.4)`` :ref:`🔗` Color to display disabled navigation mesh polygon faces, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3894,11 +4276,11 @@ Color to display disabled navigation mesh polygon faces, visible when "Visible N ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/link_connection_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/link_connection_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/3d/link_connection_color** = ``Color(1, 0.5, 1, 1)`` :ref:`🔗` Color to use to display navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. @@ -3906,11 +4288,11 @@ Color to use to display navigation link connections, visible when "Visible Navig ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/link_connection_disabled_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/3d/link_connection_disabled_color: .. rst-class:: classref-property -:ref:`Color` **debug/shapes/navigation/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` +:ref:`Color` **debug/shapes/navigation/3d/link_connection_disabled_color** = ``Color(0.5, 0.5, 0.5, 1)`` :ref:`🔗` Color to use to display disabled navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. @@ -4098,13 +4480,13 @@ Enable Swappy for stable frame pacing on Android. Highly recommended. Swappy mode to use. The options are: -- pipeline_forced_on: Try to honor :ref:`Engine.max_fps`. Pipelining is always on. This is the same behavior as Desktop PC. +- ``pipeline_forced_on``: Try to honor :ref:`Engine.max_fps`. Pipelining is always on. This is the same behavior as a desktop PC. -- auto_fps_pipeline_forced_on: Autocalculate max fps. Actual max_fps will be between 0 and :ref:`Engine.max_fps`. While this sounds convenient, beware that Swappy will often downgrade max fps until it finds something that can be met and sustained. That means if your game runs between 40fps and 60fps on a 60hz screen, after some time Swappy will downgrade max fps so that the game renders at perfect 30fps. +- ``auto_fps_pipeline_forced_on``: Calculate the max FPS automatically. The actual max FPS will be between ``0`` and :ref:`Engine.max_fps`. While this sounds convenient, beware that Swappy will often downgrade the max FPS until it finds a value that can be maintained. That means, if your game runs between 40fps and 60fps on a 60hz screen, after some time Swappy will downgrade the max FPS so that the game renders at a perfect 30fps. -- auto_fps_auto_pipeline: Same as auto_fps_pipeline_forced_on, but if Swappy detects that rendering is very fast (e.g. it takes < 8ms to render on a 60hz screen) Swappy will disable pipelining to minimize input latency. This is the default. +- ``auto_fps_auto_pipeline``: Same as ``auto_fps_pipeline_forced_on``, but if Swappy detects that rendering is very fast (for example it takes less than 8ms to render on a 60hz screen), Swappy will disable pipelining to minimize input latency. This is the default. -\ **Note:** If :ref:`Engine.max_fps` is 0, actual max_fps will considered as to be the screen's refresh rate (often 60hz, 90hz or 120hz depending on device model and OS settings). +\ **Note:** If :ref:`Engine.max_fps` is ``0``, the actual max FPS will be considered to be the screen's refresh rate (often 60hz, 90hz, or 120hz, depending on device model and OS settings). .. rst-class:: classref-item-separator @@ -4276,6 +4658,30 @@ Main window initial screen, this setting is used only if :ref:`display/window/si ---- +.. _class_ProjectSettings_property_display/window/size/maximize_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **display/window/size/maximize_disabled** = ``false`` :ref:`🔗` + +If ``true``, the main window's maximize button is disabled. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_display/window/size/minimize_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **display/window/size/minimize_disabled** = ``false`` :ref:`🔗` + +If ``true``, the main window's minimize button is disabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_display/window/size/mode: .. rst-class:: classref-property @@ -4836,7 +5242,7 @@ Search path for project-specific script templates. Godot will search for script If ``true``, Blender 3D scene files with the ``.blend`` extension will be imported by converting them to glTF 2.0. -This requires configuring a path to a Blender executable in the editor settings at ``filesystem/import/blender/blender_path``. Blender 3.0 or later is required. +This requires configuring a path to a Blender executable in the :ref:`EditorSettings.filesystem/import/blender/blender_path` setting. Blender 3.0 or later is required. .. rst-class:: classref-item-separator @@ -4932,9 +5338,15 @@ If ``true``, snaps :ref:`Control` node vertices to the nearest pi .. rst-class:: classref-property -:ref:`bool` **gui/common/swap_cancel_ok** :ref:`🔗` +: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. + +- **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. + +- **Cancel First** (``1``) forces the ordering Cancel/OK. -If ``true``, swaps **Cancel** and **OK** buttons in dialogs on Windows to follow interface conventions. :ref:`DisplayServer.get_swap_cancel_ok()` can be used to query whether buttons are swapped at run-time. +- **OK First** (``2``) forces the ordering OK/Cancel. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`DisplayServer.dialog_show()`. @@ -5166,6 +5578,20 @@ Default :ref:`InputEventAction` to confirm a focused but ---- +.. _class_ProjectSettings_property_input/ui_accessibility_drag_and_drop: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_accessibility_drag_and_drop** :ref:`🔗` + +Default :ref:`InputEventAction` to start or end a drag-and-drop operation without using mouse. + +\ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_cancel: .. rst-class:: classref-property @@ -5180,6 +5606,20 @@ Default :ref:`InputEventAction` to discard a modal or pe ---- +.. _class_ProjectSettings_property_input/ui_colorpicker_delete_preset: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_colorpicker_delete_preset** :ref:`🔗` + +Default :ref:`InputEventAction` to delete a color preset in a :ref:`ColorPicker`. + +\ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_copy: .. rst-class:: classref-property @@ -5278,6 +5718,20 @@ Default :ref:`InputEventAction` to go up one directory i ---- +.. _class_ProjectSettings_property_input/ui_focus_mode: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_focus_mode** :ref:`🔗` + +Default :ref:`InputEventAction` to switch :ref:`TextEdit` :ref:`input/ui_text_indent` between moving keyboard focus to the next :ref:`Control` in the scene and inputting a ``Tab`` character. + +\ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_focus_next: .. rst-class:: classref-property @@ -5334,6 +5788,58 @@ Default :ref:`InputEventAction` to duplicate a :ref:`Gra ---- +.. _class_ProjectSettings_property_input/ui_graph_follow_left: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_left** :ref:`🔗` + +Default :ref:`InputEventAction` to follow a :ref:`GraphNode` input port connection. + +\ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input/ui_graph_follow_left.macos: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_left.macos** :ref:`🔗` + +macOS specific override for the shortcut to follow a :ref:`GraphNode` input port connection. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input/ui_graph_follow_right: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_right** :ref:`🔗` + +Default :ref:`InputEventAction` to follow a :ref:`GraphNode` output port connection. + +\ **Note:** Default ``ui_*`` actions cannot be removed as they are necessary for the internal logic of several :ref:`Control`\ s. The events assigned to the action can however be modified. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input/ui_graph_follow_right.macos: + +.. rst-class:: classref-property + +:ref:`Dictionary` **input/ui_graph_follow_right.macos** :ref:`🔗` + +macOS specific override for the shortcut to follow a :ref:`GraphNode` output port connection. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input/ui_home: .. rst-class:: classref-property @@ -6290,6 +6796,18 @@ Override for :ref:`input_devices/pen_tablet/driver` **input_devices/pointing/android/disable_scroll_deadzone** = ``false`` :ref:`🔗` + +If ``true``, disables the scroll deadzone on Android, allowing even very small scroll movements to be registered. This may increase scroll sensitivity but can also lead to unintended scrolling from slight finger movements. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input_devices/pointing/android/enable_long_press_as_right_click: .. rst-class:: classref-property @@ -6314,6 +6832,18 @@ If ``true``, multi-touch pan and scale gestures are enabled on Android devices. ---- +.. _class_ProjectSettings_property_input_devices/pointing/android/override_volume_buttons: + +.. rst-class:: classref-property + +:ref:`bool` **input_devices/pointing/android/override_volume_buttons** = ``false`` :ref:`🔗` + +If ``true``, system volume changes are disabled when the buttons are used within the app. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input_devices/pointing/android/rotary_input_scroll_axis: .. rst-class:: classref-property @@ -9854,12 +10384,14 @@ Controls the maximum number of physics steps that can be simulated each rendered :ref:`bool` **physics/common/physics_interpolation** = ``false`` :ref:`🔗` -If ``true``, the renderer will interpolate the transforms of physics objects between the last two transforms, so that smooth motion is seen even when physics ticks do not coincide with rendered frames. See also :ref:`Node.physics_interpolation_mode` and :ref:`Node.reset_physics_interpolation()`. +If ``true``, the renderer will interpolate the transforms of objects (both physics and non-physics) between the last two transforms, so that smooth motion is seen even when physics ticks do not coincide with rendered frames. See also :ref:`Node.reset_physics_interpolation()`. -\ **Note:** If ``true``, the physics jitter fix should be disabled by setting :ref:`physics/common/physics_jitter_fix` to ``0.0``. +\ **Note:** Although this is a global setting, finer control of individual branches of the :ref:`SceneTree` is possible using :ref:`Node.physics_interpolation_mode`. \ **Note:** This property is only read when the project starts. To toggle physics interpolation at runtime, set :ref:`SceneTree.physics_interpolation` instead. +\ **Note:** Property :ref:`physics/common/physics_jitter_fix` is automatically disabled if :ref:`physics/common/physics_interpolation` is set to ``true``, as the two methods are incompatible. + .. rst-class:: classref-item-separator ---- @@ -9914,8 +10446,6 @@ Collisions against an inactive edge will have its normal overridden to instead b \ **Note:** This does not apply when enabling Jolt's enhanced internal edge removal, which supersedes this. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -9932,8 +10462,6 @@ The amount of collision margin to use for certain convex collision shapes, such \ **Note:** Setting this value too close to ``0.0`` may also negatively affect the accuracy of the collision detection with convex shapes. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10056,8 +10584,6 @@ Fraction of the total penetration to depenetrate per iteration during motion que \ **Note:** This affects methods :ref:`CharacterBody3D.move_and_slide()`, :ref:`PhysicsBody3D.move_and_collide()`, :ref:`PhysicsBody3D.test_move()` and :ref:`PhysicsServer3D.body_test_motion()`. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10072,8 +10598,6 @@ The number of iterations to run when depenetrating during motion queries. \ **Note:** This affects methods :ref:`CharacterBody3D.move_and_slide()`, :ref:`PhysicsBody3D.move_and_collide()`, :ref:`PhysicsBody3D.test_move()` and :ref:`PhysicsServer3D.body_test_motion()`. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10088,8 +10612,6 @@ If ``true``, enables Jolt's enhanced internal edge removal during motion queries \ **Note:** This affects methods :ref:`CharacterBody3D.move_and_slide()`, :ref:`PhysicsBody3D.move_and_collide()`, :ref:`PhysicsBody3D.test_move()` and :ref:`PhysicsServer3D.body_test_motion()`. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10104,8 +10626,6 @@ If ``true``, populates the ``face_index`` field in the results of :ref:`PhysicsD \ **Note:** Enabling this setting will increase Jolt's memory usage for :ref:`ConcavePolygonShape3D` by around 25%. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10122,8 +10642,6 @@ If ``true``, enables Jolt's enhanced internal edge removal during shape queries. \ **Note:** Enabling this setting can cause certain shapes to be culled from the results entirely, but you will get at least one intersection per body. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10216,8 +10734,6 @@ If ``true``, enables the body pair contact cache, which removes the need for pot The minimum velocity needed before a collision can be bouncy, in meters per second. -\ **Note:** This setting will only be read once during the lifetime of the application. - .. rst-class:: classref-item-separator ---- @@ -10696,6 +11212,8 @@ Default background clear color. Overridable per :ref:`Viewport` Sets how the glow effect is upscaled before being copied onto the screen. Linear is faster, but looks blocky. Bicubic is slower but looks smooth. +\ **Note:** :ref:`rendering/environment/glow/upscale_mode` is only effective when using the Forward+ or Mobile rendering methods, as Compatibility uses a different glow implementation. + .. rst-class:: classref-item-separator ---- @@ -11922,6 +12440,8 @@ Limits the number of layers to use in radiance maps when using importance sampli If ``true``, uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise and upscaling artifacts on reflections, but is significantly slower to compute and uses :ref:`rendering/reflections/sky_reflections/roughness_layers` times more memory. +\ **Note:** Texture array reflections are always disabled on macOS on Intel GPUs due to driver bugs. + .. rst-class:: classref-item-separator ---- @@ -12178,7 +12698,7 @@ If ``true``, the forward renderer will fall back to Direct3D 12 if Vulkan is not 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 only on Windows, Android, macOS, iOS, and Linux/X11. +\ **Note:** This setting is implemented on Windows, Android, macOS, iOS, and Linux/X11. .. rst-class:: classref-item-separator @@ -12192,7 +12712,7 @@ If ``true``, the forward renderer will fall back to OpenGL 3 if Direct3D 12, Met 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 only on Windows and macOS. +\ **Note:** This setting is implemented on Windows and macOS. .. rst-class:: classref-item-separator @@ -12787,7 +13307,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 no limit. +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()`). .. rst-class:: classref-item-separator @@ -12923,7 +13443,7 @@ If ``true``, the hand tracking extension is enabled if available. If ``true``, support for the controller inferred data source is requested. If supported, you will receive hand tracking data even if the user has a controller in hand, with finger positions automatically inferred from controller input and/or sensors. -\ **Node:** This requires the OpenXR data source extension and controller inferred handtracking to be supported by the XR runtime. If not supported this setting will be ignored. :ref:`xr/openxr/extensions/hand_tracking` must be enabled for this setting to be used. +\ **Note:** This requires the OpenXR data source extension and controller inferred handtracking to be supported by the XR runtime. If not supported this setting will be ignored. :ref:`xr/openxr/extensions/hand_tracking` must be enabled for this setting to be used. .. rst-class:: classref-item-separator @@ -12937,7 +13457,7 @@ If ``true``, support for the controller inferred data source is requested. If su If ``true``, support for the unobstructed data source is requested. If supported, you will receive hand tracking data based on the actual finger positions of the user often determined by optical tracking. -\ **Node:** This requires the OpenXR data source extension and unobstructed handtracking to be supported by the XR runtime. If not supported this setting will be ignored. :ref:`xr/openxr/extensions/hand_tracking` must be enabled for this setting to be used. +\ **Note:** This requires the OpenXR data source extension and unobstructed handtracking to be supported by the XR runtime. If not supported this setting will be ignored. :ref:`xr/openxr/extensions/hand_tracking` must be enabled for this setting to be used. .. rst-class:: classref-item-separator @@ -13198,6 +13718,18 @@ Similar to :ref:`get_setting()`, but a +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_method_get_setting_with_override_and_custom_features: + +.. rst-class:: classref-method + +:ref:`Variant` **get_setting_with_override_and_custom_features**\ (\ name\: :ref:`StringName`, features\: :ref:`PackedStringArray`\ ) |const| :ref:`🔗` + +Similar to :ref:`get_setting_with_override()`, but applies feature tag overrides instead of current OS features. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_rdtextureview.rst b/classes/class_rdtextureview.rst index 5e5f54c1639..05d088232ae 100644 --- a/classes/class_rdtextureview.rst +++ b/classes/class_rdtextureview.rst @@ -30,7 +30,7 @@ Properties :widths: auto +------------------------------------------------------------+----------------------------------------------------------------------+---------+ - | :ref:`DataFormat` | :ref:`format_override` | ``218`` | + | :ref:`DataFormat` | :ref:`format_override` | ``232`` | +------------------------------------------------------------+----------------------------------------------------------------------+---------+ | :ref:`TextureSwizzle` | :ref:`swizzle_a` | ``6`` | +------------------------------------------------------------+----------------------------------------------------------------------+---------+ @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`DataFormat` **format_override** = ``218`` :ref:`🔗` +:ref:`DataFormat` **format_override** = ``232`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_rdvertexattribute.rst b/classes/class_rdvertexattribute.rst index d8c35a411a9..b86c0ccc953 100644 --- a/classes/class_rdvertexattribute.rst +++ b/classes/class_rdvertexattribute.rst @@ -30,7 +30,7 @@ Properties :widths: auto +--------------------------------------------------------------+--------------------------------------------------------------+---------+ - | :ref:`DataFormat` | :ref:`format` | ``218`` | + | :ref:`DataFormat` | :ref:`format` | ``232`` | +--------------------------------------------------------------+--------------------------------------------------------------+---------+ | :ref:`VertexFrequency` | :ref:`frequency` | ``0`` | +--------------------------------------------------------------+--------------------------------------------------------------+---------+ @@ -54,7 +54,7 @@ Property Descriptions .. rst-class:: classref-property -:ref:`DataFormat` **format** = ``218`` :ref:`🔗` +:ref:`DataFormat` **format** = ``232`` :ref:`🔗` .. rst-class:: classref-property-setget diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 6ed715a9a18..fdda0c7dfd5 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 88e503e1460..6687c052f17 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -845,7 +845,7 @@ Alpha/red/green/blue channel data format with 1 bit of alpha, 5 bits of red, 6 b :ref:`DataFormat` **DATA_FORMAT_R8G8B8_SRGB** = ``28`` -8-bit-per-channel unsigned floating-point red/green/blue/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. +8-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UNORM: @@ -2359,11 +2359,179 @@ VRAM-compressed unsigned floating-point data format with normalized value and no 16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_4x4_SFLOAT_BLOCK** = ``218`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_5x4_SFLOAT_BLOCK** = ``219`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_5x5_SFLOAT_BLOCK** = ``220`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_6x5_SFLOAT_BLOCK** = ``221`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_6x6_SFLOAT_BLOCK** = ``222`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_8x5_SFLOAT_BLOCK** = ``223`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_8x6_SFLOAT_BLOCK** = ``224`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_8x8_SFLOAT_BLOCK** = ``225`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_10x5_SFLOAT_BLOCK** = ``226`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_10x6_SFLOAT_BLOCK** = ``227`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_10x8_SFLOAT_BLOCK** = ``228`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_10x10_SFLOAT_BLOCK** = ``229`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_12x10_SFLOAT_BLOCK** = ``230`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + +.. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK: + +.. rst-class:: classref-enumeration-constant + +:ref:`DataFormat` **DATA_FORMAT_ASTC_12x12_SFLOAT_BLOCK** = ``231`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + .. _class_RenderingDevice_constant_DATA_FORMAT_MAX: .. rst-class:: classref-enumeration-constant -:ref:`DataFormat` **DATA_FORMAT_MAX** = ``218`` +:ref:`DataFormat` **DATA_FORMAT_MAX** = ``232`` Represents the size of the :ref:`DataFormat` enum. @@ -4268,6 +4436,22 @@ Floating-point specialization constant. enum **Features**: :ref:`🔗` +.. _class_RenderingDevice_constant_SUPPORTS_METALFX_SPATIAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Features` **SUPPORTS_METALFX_SPATIAL** = ``3`` + +Support for MetalFX spatial upscaling. + +.. _class_RenderingDevice_constant_SUPPORTS_METALFX_TEMPORAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`Features` **SUPPORTS_METALFX_TEMPORAL** = ``4`` + +Support for MetalFX temporal upscaling. + .. _class_RenderingDevice_constant_SUPPORTS_BUFFER_DEVICE_ADDRESS: .. rst-class:: classref-enumeration-constant @@ -6102,7 +6286,7 @@ This is only used by Vulkan in debug builds. Godot must also be started with the :ref:`int` **get_tracked_object_type_count**\ (\ ) |const| :ref:`🔗` -Returns how many types of trackable objects are. +Returns how many types of trackable objects there are. This is only used by Vulkan in debug builds. Godot must also be started with the ``--extra-gpu-memory-tracking`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`. @@ -6741,7 +6925,7 @@ Creates a vertex array based on the specified buffers. Optionally, ``offsets`` ( :ref:`RID` **vertex_buffer_create**\ (\ size_bytes\: :ref:`int`, data\: :ref:`PackedByteArray` = PackedByteArray(), creation_bits\: |bitfield|\[:ref:`BufferCreationBits`\] = 0\ ) :ref:`🔗` -It can be accessed with the RID that is returned. +Creates a new vertex buffer. It can be accessed with the RID that is returned. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid()` method. diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index f444a44cd2a..f185ff893ca 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -363,6 +363,8 @@ Methods +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_fog`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`environment_set_fog_depth`\ (\ env\: :ref:`RID`, curve\: :ref:`float`, begin\: :ref:`float`, end\: :ref:`float`\ ) | + +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_glow`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sdfgi`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) | @@ -1720,7 +1722,7 @@ Flag used to mark that the array contains 2D vertices. :ref:`ArrayFormat` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864`` -Flag indices that the mesh data will use ``GL_DYNAMIC_DRAW`` on GLES. Unused on Vulkan. +Flag used to mark that the mesh data will use ``GL_DYNAMIC_DRAW`` on GLES. Unused on Vulkan. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS: @@ -2158,7 +2160,7 @@ Normal bias used to offset shadow lookup by object normal. Can be used to fix se :ref:`LightParam` **LIGHT_PARAM_SHADOW_BIAS** = ``15`` -Bias the shadow lookup to fix self-shadowing artifacts. +Bias for the shadow lookup to fix self-shadowing artifacts. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE: @@ -2994,7 +2996,7 @@ Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1`` -Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2: @@ -3002,7 +3004,7 @@ Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2`` -Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. +Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL: @@ -3010,7 +3012,7 @@ Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL** = ``3`` -Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. \ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS. @@ -3020,7 +3022,7 @@ Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scalin :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL** = ``4`` -Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution. +Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale`. Values less than ``1.0`` will result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution. \ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS. @@ -3544,6 +3546,8 @@ Objects are displayed without light information. Objects are displayed with only light information. +\ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW: .. rst-class:: classref-enumeration-constant @@ -3552,7 +3556,7 @@ Objects are displayed with only light information. Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw (represented by brighter colors) means you are wasting performance on drawing pixels that are being hidden behind others. -\ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore. +\ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME: @@ -3578,7 +3582,9 @@ Normal buffer is drawn instead of regular scene so you can see the per-pixel nor :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6`` -Objects are displayed with only the albedo value from :ref:`VoxelGI`\ s. +Objects are displayed with only the albedo value from :ref:`VoxelGI`\ s. Requires at least one visible :ref:`VoxelGI` node that has been baked to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING: @@ -3586,7 +3592,9 @@ Objects are displayed with only the albedo value from :ref:`VoxelGI` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7`` -Objects are displayed with only the lighting value from :ref:`VoxelGI`\ s. +Objects are displayed with only the lighting value from :ref:`VoxelGI`\ s. Requires at least one visible :ref:`VoxelGI` node that has been baked to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION: @@ -3594,7 +3602,9 @@ Objects are displayed with only the lighting value from :ref:`VoxelGI` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8`` -Objects are displayed with only the emission color from :ref:`VoxelGI`\ s. +Objects are displayed with only the emission color from :ref:`VoxelGI`\ s. Requires at least one visible :ref:`VoxelGI` node that has been baked to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS: @@ -3624,6 +3634,8 @@ The last cascade shows all frustum slices to illustrate the coverage of all slic Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure. +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO: .. rst-class:: classref-enumeration-constant @@ -3632,6 +3644,8 @@ Draws the estimated scene luminance. This is a 1×1 texture that is generated wh Draws the screen space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssao_enabled` set in your :ref:`WorldEnvironment`. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL: .. rst-class:: classref-enumeration-constant @@ -3640,13 +3654,19 @@ Draws the screen space ambient occlusion texture instead of the scene so that yo Draws the screen space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssil_enabled` set in your :ref:`WorldEnvironment`. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14`` -Colors each PSSM split for the :ref:`DirectionalLight3D`\ s in the scene a different color so you can see where the splits are. In order they will be colored red, green, blue, yellow. +Colors each PSSM split for the :ref:`DirectionalLight3D`\ s in the scene a different color so you can see where the splits are. In order (from closest to furthest from the camera), they are colored red, green, blue, and yellow. + +\ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode. + +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS: @@ -3656,6 +3676,8 @@ Colors each PSSM split for the :ref:`DirectionalLight3D`\ s. +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI: .. rst-class:: classref-enumeration-constant @@ -3664,6 +3686,8 @@ Draws the decal atlas that stores decal textures from :ref:`Decal`\ Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES: .. rst-class:: classref-enumeration-constant @@ -3672,13 +3696,17 @@ Draws SDFGI cascade data. This is the data structure that is used to bounce ligh Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18`` -Draws the global illumination buffer (:ref:`VoxelGI` or SDFGI). +Draws the global illumination buffer from :ref:`VoxelGI` or SDFGI. Requires :ref:`VoxelGI` (at least one visible baked VoxelGI node) or SDFGI (:ref:`Environment.sdfgi_enabled`) to be enabled to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD: @@ -3696,6 +3724,8 @@ Disable mesh LOD. All meshes are drawn with full detail, which can be used to co Draws the :ref:`OmniLight3D` cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS: .. rst-class:: classref-enumeration-constant @@ -3704,6 +3734,8 @@ Draws the :ref:`OmniLight3D` cluster. Clustering determines w Draws the :ref:`SpotLight3D` cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS: .. rst-class:: classref-enumeration-constant @@ -3712,6 +3744,8 @@ Draws the :ref:`SpotLight3D` cluster. Clustering determines w Draws the :ref:`Decal` cluster. Clustering determines where decals are positioned in screen-space, which allows the engine to only process these portions of the screen for decals. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES: .. rst-class:: classref-enumeration-constant @@ -3720,6 +3754,8 @@ Draws the :ref:`Decal` cluster. Clustering determines where decals Draws the :ref:`ReflectionProbe` cluster. Clustering determines where reflection probes are positioned in screen-space, which allows the engine to only process these portions of the screen for reflection probes. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS: .. rst-class:: classref-enumeration-constant @@ -3728,6 +3764,8 @@ Draws the :ref:`ReflectionProbe` cluster. Clustering dete Draws the occlusion culling buffer. This low-resolution occlusion culling buffer is rasterized on the CPU and is used to check whether instances are occluded by other objects. +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS: .. rst-class:: classref-enumeration-constant @@ -3736,6 +3774,8 @@ Draws the occlusion culling buffer. This low-resolution occlusion culling buffer Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER: .. rst-class:: classref-enumeration-constant @@ -3744,6 +3784,8 @@ Draws the motion vectors buffer. This is used by temporal antialiasing to correc Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects. +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. + .. rst-class:: classref-item-separator ---- @@ -7848,6 +7890,8 @@ Once finished with your RID, you will want to free the RID using the RenderingSe If ``enable`` is ``true``, enables bicubic upscaling for glow which improves quality at the cost of performance. Equivalent to :ref:`ProjectSettings.rendering/environment/glow/upscale_mode`. +\ **Note:** This setting is only effective when using the Forward+ or Mobile rendering methods, as Compatibility uses a different glow implementation. + .. rst-class:: classref-item-separator ---- @@ -7948,6 +7992,18 @@ Configures fog for the specified environment RID. See ``fog_*`` properties in :r ---- +.. _class_RenderingServer_method_environment_set_fog_depth: + +.. rst-class:: classref-method + +|void| **environment_set_fog_depth**\ (\ env\: :ref:`RID`, curve\: :ref:`float`, begin\: :ref:`float`, end\: :ref:`float`\ ) :ref:`🔗` + +Configures fog depth for the specified environment RID. Only has an effect when the fog mode of the environment is :ref:`ENV_FOG_MODE_DEPTH`. See ``fog_depth_*`` properties in :ref:`Environment` for more information. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_environment_set_glow: .. rst-class:: classref-method diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 7f923aac61d..15e6a499069 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -12,7 +12,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`ColorPalette`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRBindingModifier`, :ref:`OpenXRHapticBase`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`ColorPalette`, :ref:`Compositor`, :ref:`CompositorEffect`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`FoldableGroup`, :ref:`Font`, :ref:`GDExtension`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFPhysicsBody`, :ref:`GLTFPhysicsShape`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`GLTFTextureSampler`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`JSON`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NavigationMesh`, :ref:`NavigationMeshSourceGeometryData2D`, :ref:`NavigationMeshSourceGeometryData3D`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRBindingModifier`, :ref:`OpenXRHapticBase`, :ref:`OpenXRInteractionProfile`, :ref:`OpenXRIPBinding`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VideoStreamPlayback`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for serializable objects. diff --git a/classes/class_resourceimporterdynamicfont.rst b/classes/class_resourceimporterdynamicfont.rst index c92a37fd0cc..8cd595495e0 100644 --- a/classes/class_resourceimporterdynamicfont.rst +++ b/classes/class_resourceimporterdynamicfont.rst @@ -61,6 +61,8 @@ Properties +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`Dictionary` | :ref:`language_support` | ``{}`` | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ + | :ref:`bool` | :ref:`modulate_color_glyphs` | ``false`` | + +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`msdf_pixel_range` | ``8`` | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`msdf_size` | ``48`` | @@ -223,6 +225,18 @@ Override the list of languages supported by this font. If left empty, this is su ---- +.. _class_ResourceImporterDynamicFont_property_modulate_color_glyphs: + +.. rst-class:: classref-property + +:ref:`bool` **modulate_color_glyphs** = ``false`` :ref:`🔗` + +If set to ``true``, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only. + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceImporterDynamicFont_property_msdf_pixel_range: .. rst-class:: classref-property diff --git a/classes/class_resourceuid.rst b/classes/class_resourceuid.rst index d379bd72add..3317049ab92 100644 --- a/classes/class_resourceuid.rst +++ b/classes/class_resourceuid.rst @@ -36,6 +36,8 @@ Methods +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`create_id`\ (\ ) | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`create_id_for_path`\ (\ path\: :ref:`String`\ ) | + +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_id_path`\ (\ id\: :ref:`int`\ ) |const| | +-----------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_id`\ (\ id\: :ref:`int`\ ) |const| | @@ -105,6 +107,18 @@ In order for this UID to be registered, you must call :ref:`add_id()` **create_id_for_path**\ (\ path\: :ref:`String`\ ) :ref:`🔗` + +Like :ref:`create_id()`, but the UID is seeded with the provided ``path`` and project name. UIDs generated for that path will be always the same within the current project. + +.. rst-class:: classref-item-separator + +---- + .. _class_ResourceUID_method_get_id_path: .. rst-class:: classref-method diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index c461a1d68dc..ea63f3f16a0 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -53,6 +53,8 @@ Properties +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`AutowrapMode` | :ref:`autowrap_mode` | ``3`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | |bitfield|\[:ref:`LineBreakFlag`\] | :ref:`autowrap_trim_flags` | ``192`` | + +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`bbcode_enabled` | ``false`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | @@ -67,6 +69,8 @@ Properties +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`fit_content` | ``false`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`hint_underlined` | ``true`` | +-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`HorizontalAlignment` | :ref:`horizontal_alignment` | ``0`` | @@ -119,7 +123,7 @@ Methods :widths: auto +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_image`\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) | + | |void| | :ref:`add_image`\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false, alt_text\: :ref:`String` = ""\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_text`\ (\ text\: :ref:`String`\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -237,10 +241,12 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`push_strikethrough`\ (\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`push_table`\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) | + | |void| | :ref:`push_table`\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1, name\: :ref:`String` = ""\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`push_underline`\ (\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reload_effects`\ (\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`remove_paragraph`\ (\ paragraph\: :ref:`int`, no_invalidate\: :ref:`bool` = false\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`scroll_to_line`\ (\ line\: :ref:`int`\ ) | @@ -261,6 +267,8 @@ Methods +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_table_column_expand`\ (\ column\: :ref:`int`, expand\: :ref:`bool`, ratio\: :ref:`int` = 1, shrink\: :ref:`bool` = true\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_table_column_name`\ (\ column\: :ref:`int`, name\: :ref:`String`\ ) | + +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_image`\ (\ key\: :ref:`Variant`, mask\: |bitfield|\[:ref:`ImageUpdateMask`\], image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) | +-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -617,6 +625,23 @@ If set to something other than :ref:`TextServer.AUTOWRAP_OFF`\] **autowrap_trim_flags** = ``192`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_autowrap_trim_flags**\ (\ value\: |bitfield|\[:ref:`LineBreakFlag`\]\ ) +- |bitfield|\[:ref:`LineBreakFlag`\] **get_autowrap_trim_flags**\ (\ ) + +Autowrap space trimming flags. See :ref:`TextServer.BREAK_TRIM_START_EDGE_SPACES` and :ref:`TextServer.BREAK_TRIM_END_EDGE_SPACES` for more info. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_property_bbcode_enabled: .. rst-class:: classref-property @@ -1099,7 +1124,7 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false\ ) :ref:`🔗` +|void| **add_image**\ (\ image\: :ref:`Texture2D`, width\: :ref:`int` = 0, height\: :ref:`int` = 0, color\: :ref:`Color` = Color(1, 1, 1, 1), inline_align\: :ref:`InlineAlignment` = 5, region\: :ref:`Rect2` = Rect2(0, 0, 0, 0), key\: :ref:`Variant` = null, pad\: :ref:`bool` = false, tooltip\: :ref:`String` = "", size_in_percent\: :ref:`bool` = false, alt_text\: :ref:`String` = ""\ ) :ref:`🔗` Adds an image's opening and closing tags to the tag stack, optionally providing a ``width`` and ``height`` to resize the image, a ``color`` to tint the image and a ``region`` to only use parts of the image. @@ -1113,6 +1138,8 @@ If ``pad`` is set, and the image is smaller than the size specified by ``width`` If ``size_in_percent`` is set, ``width`` and ``height`` values are percentages of the control width instead of pixels. +\ ``alt_text`` is used as the image description for assistive apps. + .. rst-class:: classref-item-separator ---- @@ -1649,6 +1676,8 @@ Terminates tags opened after the last :ref:`push_context()` and :ref:`text_highlight_v_padding`. This can lead to overlapping highlights if background colors are placed on neighboring lines/columns, so consider setting those theme items to ``0`` if you want to avoid this. + .. rst-class:: classref-item-separator ---- @@ -1745,6 +1774,8 @@ Adds a ``[dropcap]`` tag to the tag stack. Drop cap (dropped capital) is a decor Adds a ``[fgcolor]`` tag to the tag stack. +\ **Note:** The foreground color has padding applied by default, which is controlled using :ref:`text_highlight_h_padding` and :ref:`text_highlight_v_padding`. This can lead to overlapping highlights if foreground colors are placed on neighboring lines/columns, so consider setting those theme items to ``0`` if you want to avoid this. + .. rst-class:: classref-item-separator ---- @@ -1927,9 +1958,9 @@ Adds a ``[s]`` tag to the tag stack. .. rst-class:: classref-method -|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1\ ) :ref:`🔗` +|void| **push_table**\ (\ columns\: :ref:`int`, inline_align\: :ref:`InlineAlignment` = 0, align_to_row\: :ref:`int` = -1, name\: :ref:`String` = ""\ ) :ref:`🔗` -Adds a ``[table=columns,inline_align]`` tag to the tag stack. Use :ref:`set_table_column_expand()` to set column expansion ratio. Use :ref:`push_cell()` to add cells. +Adds a ``[table=columns,inline_align]`` tag to the tag stack. Use :ref:`set_table_column_expand()` to set column expansion ratio. Use :ref:`push_cell()` to add cells. ``name`` is used as the table name for assistive apps. .. rst-class:: classref-item-separator @@ -1947,6 +1978,18 @@ Adds a ``[u]`` tag to the tag stack. ---- +.. _class_RichTextLabel_method_reload_effects: + +.. rst-class:: classref-method + +|void| **reload_effects**\ (\ ) :ref:`🔗` + +Reloads custom effects. Useful when :ref:`custom_effects` is modified manually. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_remove_paragraph: .. rst-class:: classref-method @@ -2077,6 +2120,18 @@ If ``expand`` is ``false``, the column will not contribute to the total ratio. ---- +.. _class_RichTextLabel_method_set_table_column_name: + +.. rst-class:: classref-method + +|void| **set_table_column_name**\ (\ column\: :ref:`int`, name\: :ref:`String`\ ) :ref:`🔗` + +Sets table column name for assistive apps. + +.. rst-class:: classref-item-separator + +---- + .. _class_RichTextLabel_method_update_image: .. rst-class:: classref-method @@ -2282,7 +2337,7 @@ The vertical separation of elements in a table. :ref:`int` **text_highlight_h_padding** = ``3`` :ref:`🔗` -The horizontal padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. +The horizontal padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. To avoid any risk of neighboring highlights overlapping each other, set this to ``0`` to disable padding. .. rst-class:: classref-item-separator @@ -2294,7 +2349,7 @@ The horizontal padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` :ref:`int` **text_highlight_v_padding** = ``3`` :ref:`🔗` -The vertical padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. +The vertical padding around boxes drawn by the ``[fgcolor]`` and ``[bgcolor]`` tags. This does not affect the appearance of text selection. To avoid any risk of neighboring highlights overlapping each other, set this to ``0`` to disable padding. .. rst-class:: classref-item-separator diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 28c604c3122..ba7d2ea3e61 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -31,6 +31,8 @@ Methods .. table:: :widths: auto + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`SceneState` | :ref:`get_base_scene_state`\ (\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_connection_binds`\ (\ idx\: :ref:`int`\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,6 +74,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_node_type`\ (\ idx\: :ref:`int`\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_path`\ (\ ) |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_node_instance_placeholder`\ (\ idx\: :ref:`int`\ ) |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -137,6 +141,18 @@ If passed to :ref:`PackedScene.instantiate()` **get_base_scene_state**\ (\ ) |const| :ref:`🔗` + +Returns the **SceneState** of the scene that this scene inherits from, or ``null`` if it doesn't inherit from any scene. + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneState_method_get_connection_binds: .. rst-class:: classref-method @@ -385,6 +401,18 @@ Returns the type of the node at ``idx``. ---- +.. _class_SceneState_method_get_path: + +.. rst-class:: classref-method + +:ref:`String` **get_path**\ (\ ) |const| :ref:`🔗` + +Returns the resource path to the represented :ref:`PackedScene`. + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneState_method_is_node_instance_placeholder: .. rst-class:: classref-method diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 2dc39b5bfd7..0f49afd9a96 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -103,6 +103,10 @@ Methods +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_group`\ (\ name\: :ref:`StringName`\ ) |const| | +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_accessibility_enabled`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_accessibility_supported`\ (\ ) |const| | + +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`notify_group`\ (\ group\: :ref:`StringName`, notification\: :ref:`int`\ ) | +--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`notify_group_flags`\ (\ call_flags\: :ref:`int`, group\: :ref:`StringName`, notification\: :ref:`int`\ ) | @@ -203,6 +207,25 @@ Emitted immediately before :ref:`Node._process()` + +Emitted after the new scene is added to scene tree and initialized. Can be used to reliably access :ref:`current_scene` when changing scenes. + +:: + + # This code should be inside an autoload. + get_tree().change_scene_to_file(other_scene_path) + await get_tree().scene_changed + print(get_tree().current_scene) # Prints the new scene. + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneTree_signal_tree_changed: .. rst-class:: classref-signal @@ -446,10 +469,12 @@ If ``true``, the scene tree is considered paused. This causes the following beha - |void| **set_physics_interpolation_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_physics_interpolation_enabled**\ (\ ) -If ``true``, the renderer will interpolate the transforms of physics objects between the last two transforms, so that smooth motion is seen even when physics ticks do not coincide with rendered frames. +If ``true``, the renderer will interpolate the transforms of objects (both physics and non-physics) between the last two transforms, so that smooth motion is seen even when physics ticks do not coincide with rendered frames. The default value of this property is controlled by :ref:`ProjectSettings.physics/common/physics_interpolation`. +\ **Note:** Although this is a global setting, finer control of individual branches of the **SceneTree** is possible using :ref:`Node.physics_interpolation_mode`. + .. rst-class:: classref-item-separator ---- @@ -567,6 +592,8 @@ Returns :ref:`@GlobalScope.OK` on success, :ref: This ensures that both scenes aren't running at the same time, while still freeing the previous scene in a safe way similar to :ref:`Node.queue_free()`. +If you want to reliably access the new scene, await the :ref:`scene_changed` signal. + .. rst-class:: classref-item-separator ---- @@ -724,6 +751,30 @@ Returns ``true`` if a node added to the given group ``name`` exists in the tree. ---- +.. _class_SceneTree_method_is_accessibility_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_accessibility_enabled**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if accessibility features are enabled, and accessibility information updates are actively processed. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SceneTree_method_is_accessibility_supported: + +.. rst-class:: classref-method + +:ref:`bool` **is_accessibility_supported**\ (\ ) |const| :ref:`🔗` + +Returns ``true`` if accessibility features are supported by the OS and enabled in project settings. + +.. rst-class:: classref-item-separator + +---- + .. _class_SceneTree_method_notify_group: .. rst-class:: classref-method diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index 89e83de30bd..34913bb2841 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -81,6 +81,18 @@ enum **ScriptNameCasing**: :ref:`🔗` +.. _class_ScriptLanguage_constant_SCRIPT_NAME_CASING_CAMEL_CASE: + +.. rst-class:: classref-enumeration-constant + +:ref:`ScriptNameCasing` **SCRIPT_NAME_CASING_CAMEL_CASE** = ``4`` + +.. container:: contribute + + There is currently no description for this enum. Please help us by :ref:`contributing one `! + + + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index 5de397d0be2..6d44eeb704c 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -31,11 +31,13 @@ Properties .. table:: :widths: auto - +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ - | :ref:`float` | :ref:`custom_step` | ``-1.0`` | - +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ - | :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | - +---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | :ref:`custom_step` | ``-1.0`` | + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`FocusMode` | focus_mode | ``3`` (overrides :ref:`Control`) | + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | + +------------------------------------------+----------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/class_signal.rst b/classes/class_signal.rst index 0f8493a4ec8..e37c4d9e0a2 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -44,6 +44,150 @@ In GDScript, signals can be declared with the ``signal`` keyword. In C#, you may +Connecting signals is one of the most common operations in Godot and the API gives many options to do so, which are described further down. The code block below shows the recommended approach. + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + var button = Button.new() + # `button_down` here is a Signal Variant type. We therefore call the Signal.connect() method, not Object.connect(). + # See discussion below for a more in-depth overview of the API. + button.button_down.connect(_on_button_down) + + # This assumes that a `Player` class exists, which defines a `hit` signal. + var player = Player.new() + # We use Signal.connect() again, and we also use the Callable.bind() method, + # which returns a new Callable with the parameter binds. + player.hit.connect(_on_player_hit.bind("sword", 100)) + + func _on_button_down(): + print("Button down!") + + func _on_player_hit(weapon_type, damage): + print("Hit with weapon %s for %d damage." % [weapon_type, damage]) + + .. code-tab:: csharp + + public override void _Ready() + { + var button = new Button(); + // C# supports passing signals as events, so we can use this idiomatic construct: + button.ButtonDown += OnButtonDown; + + // This assumes that a `Player` class exists, which defines a `Hit` signal. + var player = new Player(); + // We can use lambdas when we need to bind additional parameters. + player.Hit += () => OnPlayerHit("sword", 100); + } + + private void OnButtonDown() + { + GD.Print("Button down!"); + } + + private void OnPlayerHit(string weaponType, int damage) + { + GD.Print($"Hit with weapon {weaponType} for {damage} damage."); + } + + + +\ **\ ``Object.connect()`` or ``Signal.connect()``?**\ + +As seen above, the recommended method to connect signals is not :ref:`Object.connect()`. The code block below shows the four options for connecting signals, using either this legacy method or the recommended :ref:`connect()`, and using either an implicit :ref:`Callable` or a manually defined one. + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + var button = Button.new() + # Option 1: Object.connect() with an implicit Callable for the defined function. + button.connect("button_down", _on_button_down) + # Option 2: Object.connect() with a constructed Callable using a target object and method name. + button.connect("button_down", Callable(self, "_on_button_down")) + # Option 3: Signal.connect() with an implicit Callable for the defined function. + button.button_down.connect(_on_button_down) + # Option 4: Signal.connect() with a constructed Callable using a target object and method name. + button.button_down.connect(Callable(self, "_on_button_down")) + + func _on_button_down(): + print("Button down!") + + .. code-tab:: csharp + + public override void _Ready() + { + var button = new Button(); + // Option 1: In C#, we can use signals as events and connect with this idiomatic syntax: + button.ButtonDown += OnButtonDown; + // Option 2: GodotObject.Connect() with a constructed Callable from a method group. + button.Connect(Button.SignalName.ButtonDown, Callable.From(OnButtonDown)); + // Option 3: GodotObject.Connect() with a constructed Callable using a target object and method name. + button.Connect(Button.SignalName.ButtonDown, new Callable(this, MethodName.OnButtonDown)); + } + + private void OnButtonDown() + { + GD.Print("Button down!"); + } + + + +While all options have the same outcome (``button``'s :ref:`BaseButton.button_down` signal will be connected to ``_on_button_down``), **option 3** offers the best validation: it will print a compile-time error if either the ``button_down`` **Signal** or the ``_on_button_down`` :ref:`Callable` are not defined. On the other hand, **option 2** only relies on string names and will only be able to validate either names at runtime: it will generate an error at runtime if ``"button_down"`` is not a signal, or if ``"_on_button_down"`` is not a method in the object ``self``. The main reason for using options 1, 2, or 4 would be if you actually need to use strings (e.g. to connect signals programmatically based on strings read from a configuration file). Otherwise, option 3 is the recommended (and fastest) method. + +\ **Binding and passing parameters:**\ + +The syntax to bind parameters is through :ref:`Callable.bind()`, which returns a copy of the :ref:`Callable` with its parameters bound. + +When calling :ref:`emit()` or :ref:`Object.emit_signal()`, the signal parameters can be also passed. The examples below show the relationship between these signal parameters and bound parameters. + + +.. tabs:: + + .. code-tab:: gdscript + + func _ready(): + # This assumes that a `Player` class exists, which defines a `hit` signal. + var player = Player.new() + # Using Callable.bind(). + player.hit.connect(_on_player_hit.bind("sword", 100)) + + # Parameters added when emitting the signal are passed first. + player.hit.emit("Dark lord", 5) + + # We pass two arguments when emitting (`hit_by`, `level`), + # and bind two more arguments when connecting (`weapon_type`, `damage`). + func _on_player_hit(hit_by, level, weapon_type, damage): + print("Hit by %s (level %d) with weapon %s for %d damage." % [hit_by, level, weapon_type, damage]) + + .. code-tab:: csharp + + public override void _Ready() + { + // This assumes that a `Player` class exists, which defines a `Hit` signal. + var player = new Player(); + // Using lambda expressions that create a closure that captures the additional parameters. + // The lambda only receives the parameters defined by the signal's delegate. + player.Hit += (hitBy, level) => OnPlayerHit(hitBy, level, "sword", 100); + + // Parameters added when emitting the signal are passed first. + player.EmitSignal(SignalName.Hit, "Dark lord", 5); + } + + // We pass two arguments when emitting (`hit_by`, `level`), + // and bind two more arguments when connecting (`weapon_type`, `damage`). + private void OnPlayerHit(string hitBy, int level, string weaponType, int damage) + { + GD.Print($"Hit by {hitBy} (level {level}) with weapon {weaponType} for {damage} damage."); + } + + + .. note:: There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. @@ -171,7 +315,7 @@ Method Descriptions Connects this signal to the specified ``callable``. Optional ``flags`` can be also added to configure the connection's behavior (see :ref:`ConnectFlags` constants). You can provide additional arguments to the connected ``callable`` by using :ref:`Callable.bind()`. -A signal can only be connected once to the same :ref:`Callable`. If the signal is already connected, returns :ref:`@GlobalScope.ERR_INVALID_PARAMETER` and pushes an error message, unless the signal is connected with :ref:`Object.CONNECT_REFERENCE_COUNTED`. To prevent this, use :ref:`is_connected()` first to check for existing connections. +A signal can only be connected once to the same :ref:`Callable`. If the signal is already connected, this method returns :ref:`@GlobalScope.ERR_INVALID_PARAMETER` and generates an error, unless the signal is connected with :ref:`Object.CONNECT_REFERENCE_COUNTED`. To prevent this, use :ref:`is_connected()` first to check for existing connections. :: @@ -181,6 +325,8 @@ A signal can only be connected once to the same :ref:`Callable`. func _on_pressed(button): print(button.name, " was pressed") +\ **Note:** If the ``callable``'s object is freed, the connection will be lost. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 2656f07ecca..18d927f71d3 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -61,6 +61,8 @@ Methods +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`add_bone`\ (\ name\: :ref:`String`\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`advance`\ (\ delta\: :ref:`float`\ ) | + +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_bones`\ (\ ) | +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_bones_global_pose_override`\ (\ ) | @@ -268,6 +270,14 @@ Set a flag to process modification during physics frames (see :ref:`Node.NOTIFIC Set a flag to process modification during process frames (see :ref:`Node.NOTIFICATION_INTERNAL_PROCESS`). +.. _class_Skeleton3D_constant_MODIFIER_CALLBACK_MODE_PROCESS_MANUAL: + +.. rst-class:: classref-enumeration-constant + +:ref:`ModifierCallbackModeProcess` **MODIFIER_CALLBACK_MODE_PROCESS_MANUAL** = ``2`` + +Do not process modification. Use :ref:`advance()` to process the modification manually. + .. rst-class:: classref-section-separator ---- @@ -387,6 +397,20 @@ Adds a new bone with the given name. Returns the new bone's index, or ``-1`` if ---- +.. _class_Skeleton3D_method_advance: + +.. rst-class:: classref-method + +|void| **advance**\ (\ delta\: :ref:`float`\ ) :ref:`🔗` + +Manually advance the child :ref:`SkeletonModifier3D`\ s by the specified time (in seconds). + +\ **Note:** The ``delta`` is temporarily accumulated in the **Skeleton3D**, and the deferred process uses the accumulated value to process the modification. + +.. rst-class:: classref-item-separator + +---- + .. _class_Skeleton3D_method_clear_bones: .. rst-class:: classref-method @@ -549,7 +573,7 @@ Returns the global rest transform for ``bone_idx``. :ref:`Variant` **get_bone_meta**\ (\ bone_idx\: :ref:`int`, key\: :ref:`StringName`\ ) |const| :ref:`🔗` -Returns bone metadata for ``bone_idx`` with ``key``. +Returns the metadata for the bone at index ``bone_idx`` with ``key``. .. rst-class:: classref-item-separator @@ -561,7 +585,7 @@ Returns bone metadata for ``bone_idx`` with ``key``. :ref:`Array`\[:ref:`StringName`\] **get_bone_meta_list**\ (\ bone_idx\: :ref:`int`\ ) |const| :ref:`🔗` -Returns a list of all metadata keys for ``bone_idx``. +Returns the list of all metadata keys for the bone at index ``bone_idx``. .. rst-class:: classref-item-separator @@ -703,7 +727,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 whether there exists any bone metadata for ``bone_idx`` with key ``key``. +Returns ``true`` if the bone at index ``bone_idx`` has metadata with the key ``key``. .. rst-class:: classref-item-separator @@ -881,7 +905,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 bone metadata for ``bone_idx``, will set the ``key`` meta to ``value``. +Sets the metadata for the bone at index ``bone_idx``, setting the ``key`` meta to ``value``. .. rst-class:: classref-item-separator diff --git a/classes/class_skeletonmodifier3d.rst b/classes/class_skeletonmodifier3d.rst index abbf2c1f67f..3e9c54f48f7 100644 --- a/classes/class_skeletonmodifier3d.rst +++ b/classes/class_skeletonmodifier3d.rst @@ -14,7 +14,7 @@ SkeletonModifier3D **Inherited By:** :ref:`LookAtModifier3D`, :ref:`PhysicalBoneSimulator3D`, :ref:`RetargetModifier3D`, :ref:`SkeletonIK3D`, :ref:`SpringBoneSimulator3D`, :ref:`XRBodyModifier3D`, :ref:`XRHandModifier3D` -A node that may modify Skeleton3D's bone. +A node that may modify a Skeleton3D's bones. .. rst-class:: classref-introduction-group @@ -23,7 +23,7 @@ Description **SkeletonModifier3D** retrieves a target :ref:`Skeleton3D` by having a :ref:`Skeleton3D` parent. -If there is :ref:`AnimationMixer`, modification always performs after playback process of the :ref:`AnimationMixer`. +If there is an :ref:`AnimationMixer`, a modification always performs after playback process of the :ref:`AnimationMixer`. This node should be used to implement custom IK solvers, constraints, or skeleton physics. @@ -56,11 +56,13 @@ Methods .. table:: :widths: auto - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`_process_modification`\ (\ ) |virtual| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) |const| | - +-------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process_modification`\ (\ ) |virtual| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_process_modification_with_delta`\ (\ delta\: :ref:`float`\ ) |virtual| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Skeleton3D` | :ref:`get_skeleton`\ (\ ) |const| | + +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -200,6 +202,8 @@ Method Descriptions |void| **_process_modification**\ (\ ) |virtual| :ref:`🔗` +**Deprecated:** Use :ref:`_process_modification_with_delta()` instead. + Override this virtual method to implement a custom skeleton modifier. You should do things like get the :ref:`Skeleton3D`'s current pose and apply the pose here. \ :ref:`_process_modification()` must not apply :ref:`influence` to bone poses because the :ref:`Skeleton3D` automatically applies influence to all bone poses set by the modifier. @@ -208,6 +212,22 @@ Override this virtual method to implement a custom skeleton modifier. You should ---- +.. _class_SkeletonModifier3D_private_method__process_modification_with_delta: + +.. rst-class:: classref-method + +|void| **_process_modification_with_delta**\ (\ delta\: :ref:`float`\ ) |virtual| :ref:`🔗` + +Override this virtual method to implement a custom skeleton modifier. You should do things like get the :ref:`Skeleton3D`'s current pose and apply the pose here. + +\ :ref:`_process_modification_with_delta()` must not apply :ref:`influence` to bone poses because the :ref:`Skeleton3D` automatically applies influence to all bone poses set by the modifier. + +\ ``delta`` is passed from parent :ref:`Skeleton3D`. See also :ref:`Skeleton3D.advance()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_SkeletonModifier3D_method_get_skeleton: .. rst-class:: classref-method diff --git a/classes/class_springbonesimulator3d.rst b/classes/class_springbonesimulator3d.rst index 258acdb04fa..acdf05fd693 100644 --- a/classes/class_springbonesimulator3d.rst +++ b/classes/class_springbonesimulator3d.rst @@ -41,9 +41,11 @@ Properties .. table:: :widths: auto - +-----------------------+--------------------------------------------------------------------------+-------+ - | :ref:`int` | :ref:`setting_count` | ``0`` | - +-----------------------+--------------------------------------------------------------------------+-------+ + +-------------------------------+----------------------------------------------------------------------------+----------------------+ + | :ref:`Vector3` | :ref:`external_force` | ``Vector3(0, 0, 0)`` | + +-------------------------------+----------------------------------------------------------------------------+----------------------+ + | :ref:`int` | :ref:`setting_count` | ``0`` | + +-------------------------------+----------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group @@ -361,6 +363,25 @@ Enumerated value for the unconstrained rotation. Property Descriptions --------------------- +.. _class_SpringBoneSimulator3D_property_external_force: + +.. rst-class:: classref-property + +:ref:`Vector3` **external_force** = ``Vector3(0, 0, 0)`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_external_force**\ (\ value\: :ref:`Vector3`\ ) +- :ref:`Vector3` **get_external_force**\ (\ ) + +The constant force that always affected bones. It is equal to the result when the parent :ref:`Skeleton3D` moves at this speed in the opposite direction. + +This is useful for effects such as wind and anti-gravity. + +.. rst-class:: classref-item-separator + +---- + .. _class_SpringBoneSimulator3D_property_setting_count: .. rst-class:: classref-property @@ -389,7 +410,7 @@ Method Descriptions :ref:`bool` **are_all_child_collisions_enabled**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` -Returns ``true`` if the all child :ref:`SpringBoneCollision3D`\ s are contained in the collision list at ``index`` in the settings. +Returns ``true`` if all child :ref:`SpringBoneCollision3D`\ s are contained in the collision list at ``index`` in the settings. .. rst-class:: classref-item-separator @@ -975,9 +996,9 @@ Sets the drag force damping curve of the bone chain. |void| **set_enable_all_child_collisions**\ (\ index\: :ref:`int`, enabled\: :ref:`bool`\ ) :ref:`🔗` -If sets ``enabled`` to ``true``, the all child :ref:`SpringBoneCollision3D`\ s are collided and :ref:`set_exclude_collision_path()` is enabled as an exclusion list at ``index`` in the settings. +If ``enabled`` is ``true``, all child :ref:`SpringBoneCollision3D`\ s are colliding and :ref:`set_exclude_collision_path()` is enabled as an exclusion list at ``index`` in the settings. -If sets ``enabled`` to ``false``, you need to manually register all valid collisions with :ref:`set_collision_path()`. +If ``enabled`` is ``false``, you need to manually register all valid collisions with :ref:`set_collision_path()`. .. rst-class:: classref-item-separator diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index b3f7c82d322..b1794389880 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -371,7 +371,7 @@ If ``true``, texture can be seen from the back as well, if ``false``, it is invi - |void| **set_draw_flag**\ (\ flag\: :ref:`DrawFlags`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_draw_flag**\ (\ flag\: :ref:`DrawFlags`\ ) |const| -If ``true``, the label is rendered at the same size regardless of distance. +If ``true``, the texture is rendered at the same size regardless of distance. The texture's size on screen is the same as if the camera was ``1.0`` units away from the texture's origin, regardless of the actual distance from the camera. The :ref:`Camera3D`'s field of view (or :ref:`Camera3D.size` when in orthogonal/frustum mode) still affects the size the sprite is drawn at. .. rst-class:: classref-item-separator diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index f5911971822..a11518e5c43 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -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. 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. .. rst-class:: classref-item-separator diff --git a/classes/class_streampeergzip.rst b/classes/class_streampeergzip.rst index 8870bb807dc..92725c7de22 100644 --- a/classes/class_streampeergzip.rst +++ b/classes/class_streampeergzip.rst @@ -70,7 +70,9 @@ Clears this stream, resetting the internal state. :ref:`Error` **finish**\ (\ ) :ref:`🔗` -Finalizes the stream, compressing or decompressing any buffered chunk left. +Finalizes the stream, compressing any buffered chunk left. + +You must call it only when you are compressing. .. rst-class:: classref-item-separator diff --git a/classes/class_string.rst b/classes/class_string.rst index f34bc3b60be..376ad7c6e13 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -197,10 +197,18 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_char`\ (\ what\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_chars`\ (\ chars\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`repeat`\ (\ count\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replace`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_char`\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_chars`\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`reverse`\ (\ ) |const| | @@ -247,8 +255,12 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_kebab_case`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_lower`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_multibyte_char_buffer`\ (\ encoding\: :ref:`String` = ""\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_pascal_case`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_snake_case`\ (\ ) |const| | @@ -273,6 +285,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri_encode`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_file_decode`\ (\ ) |const| | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_filename`\ (\ ) |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_node_name`\ (\ ) |const| | @@ -492,7 +506,7 @@ Changes the appearance of the string: replaces underscores (``_``) with spaces, Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" and "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. -With different string lengths, returns ``1`` if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is *always* ``0``. +If the character comparison reaches the end of one string, but the other string contains more characters, then it will use length as the deciding factor: ``1`` will be returned if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is always ``0``. To get a :ref:`bool` result from a string comparison, use the ``==`` operator instead. See also :ref:`nocasecmp_to()`, :ref:`filecasecmp_to()`, and :ref:`naturalcasecmp_to()`. @@ -893,13 +907,13 @@ Decodes a hexadecimal string as a :ref:`PackedByteArray`. var text = "hello world" var encoded = text.to_utf8_buffer().hex_encode() # outputs "68656c6c6f20776f726c64" - print(buf.hex_decode().get_string_from_utf8()) + print(encoded.hex_decode().get_string_from_utf8()) .. code-tab:: csharp var text = "hello world"; var encoded = text.ToUtf8Buffer().HexEncode(); // outputs "68656c6c6f20776f726c64" - GD.Print(buf.HexDecode().GetStringFromUtf8()); + GD.Print(encoded.HexDecode().GetStringFromUtf8()); @@ -1368,7 +1382,7 @@ Performs a **case-sensitive**, *natural order* comparison to another string. Ret When used for sorting, natural order comparison orders sequences of numbers by the combined value of each digit as is often expected, instead of the single digit's value. A sorted sequence of numbered strings will be ``["1", "2", "3", ...]``, not ``["1", "10", "2", "3", ...]``. -With different string lengths, returns ``1`` if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is *always* ``0``. +If the character comparison reaches the end of one string, but the other string contains more characters, then it will use length as the deciding factor: ``1`` will be returned if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is always ``0``. To get a :ref:`bool` result from a string comparison, use the ``==`` operator instead. See also :ref:`naturalnocasecmp_to()`, :ref:`filecasecmp_to()`, and :ref:`nocasecmp_to()`. @@ -1386,7 +1400,7 @@ Performs a **case-insensitive**, *natural order* comparison to another string. R When used for sorting, natural order comparison orders sequences of numbers by the combined value of each digit as is often expected, instead of the single digit's value. A sorted sequence of numbered strings will be ``["1", "2", "3", ...]``, not ``["1", "10", "2", "3", ...]``. -With different string lengths, returns ``1`` if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is *always* ``0``. +If the character comparison reaches the end of one string, but the other string contains more characters, then it will use length as the deciding factor: ``1`` will be returned if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is always ``0``. To get a :ref:`bool` result from a string comparison, use the ``==`` operator instead. See also :ref:`naturalcasecmp_to()`, :ref:`filenocasecmp_to()`, and :ref:`casecmp_to()`. @@ -1402,7 +1416,7 @@ To get a :ref:`bool` result from a string comparison, use the ``==`` Performs a **case-insensitive** comparison to another string. Returns ``-1`` if less than, ``1`` if greater than, or ``0`` if equal. "Less than" or "greater than" are determined by the `Unicode code points `__ of each string, which roughly matches the alphabetical order. Internally, lowercase characters are converted to uppercase for the comparison. -With different string lengths, returns ``1`` if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is *always* ``0``. +If the character comparison reaches the end of one string, but the other string contains more characters, then it will use length as the deciding factor: ``1`` will be returned if this string is longer than the ``to`` string, or ``-1`` if shorter. Note that the length of empty strings is always ``0``. To get a :ref:`bool` result from a string comparison, use the ``==`` operator instead. See also :ref:`casecmp_to()`, :ref:`filenocasecmp_to()`, and :ref:`naturalnocasecmp_to()`. @@ -1483,7 +1497,7 @@ Converts the given ``number`` to a string representation, in scientific notation -\ **Note:** In C#, this method is not implemented. To achieve similar results, see C#'s `Standard numeric format strings `__ +\ **Note:** In C#, this method is not implemented. To achieve similar results, see C#'s `Standard numeric format strings `__. .. rst-class:: classref-item-separator @@ -1543,6 +1557,30 @@ Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if nec ---- +.. _class_String_method_remove_char: + +.. rst-class:: classref-method + +:ref:`String` **remove_char**\ (\ what\: :ref:`int`\ ) |const| :ref:`🔗` + +Removes all occurrences of the Unicode character with code ``what``. Faster version of :ref:`replace()` when the key is only one character long and the replacement is ``""``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_remove_chars: + +.. rst-class:: classref-method + +:ref:`String` **remove_chars**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` + +Removes any occurrence of the characters in ``chars``. See also :ref:`remove_char()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_repeat: .. rst-class:: classref-method @@ -1567,6 +1605,30 @@ Replaces all occurrences of ``what`` inside the string with the given ``forwhat` ---- +.. _class_String_method_replace_char: + +.. rst-class:: classref-method + +:ref:`String` **replace_char**\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +Replaces all occurrences of the Unicode character with code ``key`` with the Unicode character with code ``with``. Faster version of :ref:`replace()` when the key is only one character long. To get a single character use ``"X".unicode_at(0)`` (note that some strings, like compound letters and emoji, can be made up of multiple unicode codepoints, and will not work with this method, use :ref:`length()` to make sure). + +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_replace_chars: + +.. rst-class:: classref-method + +:ref:`String` **replace_chars**\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +Replaces any occurrence of the characters in ``keys`` with the Unicode character with code ``with``. See also :ref:`replace_char()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_replacen: .. rst-class:: classref-method @@ -1934,6 +1996,37 @@ Converts the string representing an integer number into an :ref:`int` var c = "-1.2.3".to_int() # c is -1 var d = "Hello!".to_int() # d is 0 +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_to_kebab_case: + +.. rst-class:: classref-method + +:ref:`String` **to_kebab_case**\ (\ ) |const| :ref:`🔗` + +Returns the string converted to ``kebab-case``. + +\ **Note:** Numbers followed by a *single* letter are not separated in the conversion to keep some words (such as "2D") together. + + +.. tabs:: + + .. code-tab:: gdscript + + "Node2D".to_kebab_case() # Returns "node-2d" + "2nd place".to_kebab_case() # Returns "2-nd-place" + "Texture3DAssetFolder".to_kebab_case() # Returns "texture-3d-asset-folder" + + .. code-tab:: csharp + + "Node2D".ToKebabCase(); // Returns "node-2d" + "2nd place".ToKebabCase(); // Returns "2-nd-place" + "Texture3DAssetFolder".ToKebabCase(); // Returns "texture-3d-asset-folder" + + + .. rst-class:: classref-item-separator ---- @@ -1950,6 +2043,24 @@ Returns the string converted to ``lowercase``. ---- +.. _class_String_method_to_multibyte_char_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_multibyte_char_buffer**\ (\ encoding\: :ref:`String` = ""\ ) |const| :ref:`🔗` + +Converts the string to system multibyte code page encoded :ref:`PackedByteArray`. If conversion fails, empty array is returned. + +The values permitted for ``encoding`` are system dependent. If ``encoding`` is empty string, system default encoding is used. + +- For Windows, see `Code Page Identifiers `__ .NET names. + +- For macOS and Linux/BSD, see ``libiconv`` library documentation and ``iconv --list`` for a list of supported encodings. + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_to_pascal_case: .. rst-class:: classref-method @@ -2112,6 +2223,8 @@ Decodes the string from its URL-encoded format. This method is meant to properly +\ **Note:** This method decodes ``+`` as space. + .. rst-class:: classref-item-separator ---- @@ -2143,6 +2256,18 @@ Encodes the string to URL-friendly format. This method is meant to properly enco +.. rst-class:: classref-item-separator + +---- + +.. _class_String_method_uri_file_decode: + +.. rst-class:: classref-method + +:ref:`String` **uri_file_decode**\ (\ ) |const| :ref:`🔗` + +Decodes the file path from its URL-encoded format. Unlike :ref:`uri_decode()` this method leaves ``+`` as is. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index ac06d1a1757..cb9d9b53ffe 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -180,10 +180,18 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`path_join`\ (\ file\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_char`\ (\ what\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`remove_chars`\ (\ chars\: :ref:`String`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`repeat`\ (\ count\: :ref:`int`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replace`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_char`\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`replace_chars`\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen`\ (\ what\: :ref:`String`, forwhat\: :ref:`String`\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`reverse`\ (\ ) |const| | @@ -230,8 +238,12 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`to_kebab_case`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_lower`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`to_multibyte_char_buffer`\ (\ encoding\: :ref:`String` = ""\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_pascal_case`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_snake_case`\ (\ ) |const| | @@ -256,6 +268,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri_encode`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`uri_file_decode`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_filename`\ (\ ) |const| | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_node_name`\ (\ ) |const| | @@ -847,13 +861,13 @@ Decodes a hexadecimal string as a :ref:`PackedByteArray`. var text = "hello world" var encoded = text.to_utf8_buffer().hex_encode() # outputs "68656c6c6f20776f726c64" - print(buf.hex_decode().get_string_from_utf8()) + print(encoded.hex_decode().get_string_from_utf8()) .. code-tab:: csharp var text = "hello world"; var encoded = text.ToUtf8Buffer().HexEncode(); // outputs "68656c6c6f20776f726c64" - GD.Print(buf.HexDecode().GetStringFromUtf8()); + GD.Print(encoded.HexDecode().GetStringFromUtf8()); @@ -1388,6 +1402,30 @@ Concatenates ``file`` at the end of the string as a subpath, adding ``/`` if nec ---- +.. _class_StringName_method_remove_char: + +.. rst-class:: classref-method + +:ref:`String` **remove_char**\ (\ what\: :ref:`int`\ ) |const| :ref:`🔗` + +Removes all occurrences of the Unicode character with code ``what``. Faster version of :ref:`replace()` when the key is only one character long and the replacement is ``""``. + +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_remove_chars: + +.. rst-class:: classref-method + +:ref:`String` **remove_chars**\ (\ chars\: :ref:`String`\ ) |const| :ref:`🔗` + +Removes any occurrence of the characters in ``chars``. See also :ref:`remove_char()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_repeat: .. rst-class:: classref-method @@ -1412,6 +1450,30 @@ Replaces all occurrences of ``what`` inside the string with the given ``forwhat` ---- +.. _class_StringName_method_replace_char: + +.. rst-class:: classref-method + +:ref:`String` **replace_char**\ (\ key\: :ref:`int`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +Replaces all occurrences of the Unicode character with code ``key`` with the Unicode character with code ``with``. Faster version of :ref:`replace()` when the key is only one character long. To get a single character use ``"X".unicode_at(0)`` (note that some strings, like compound letters and emoji, can be made up of multiple unicode codepoints, and will not work with this method, use :ref:`length()` to make sure). + +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_replace_chars: + +.. rst-class:: classref-method + +:ref:`String` **replace_chars**\ (\ keys\: :ref:`String`, with\: :ref:`int`\ ) |const| :ref:`🔗` + +Replaces any occurrence of the characters in ``keys`` with the Unicode character with code ``with``. See also :ref:`replace_char()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_replacen: .. rst-class:: classref-method @@ -1779,6 +1841,37 @@ Converts the string representing an integer number into an :ref:`int` var c = "-1.2.3".to_int() # c is -1 var d = "Hello!".to_int() # d is 0 +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_to_kebab_case: + +.. rst-class:: classref-method + +:ref:`String` **to_kebab_case**\ (\ ) |const| :ref:`🔗` + +Returns the string converted to ``kebab-case``. + +\ **Note:** Numbers followed by a *single* letter are not separated in the conversion to keep some words (such as "2D") together. + + +.. tabs:: + + .. code-tab:: gdscript + + "Node2D".to_kebab_case() # Returns "node-2d" + "2nd place".to_kebab_case() # Returns "2-nd-place" + "Texture3DAssetFolder".to_kebab_case() # Returns "texture-3d-asset-folder" + + .. code-tab:: csharp + + "Node2D".ToKebabCase(); // Returns "node-2d" + "2nd place".ToKebabCase(); // Returns "2-nd-place" + "Texture3DAssetFolder".ToKebabCase(); // Returns "texture-3d-asset-folder" + + + .. rst-class:: classref-item-separator ---- @@ -1795,6 +1888,24 @@ Returns the string converted to ``lowercase``. ---- +.. _class_StringName_method_to_multibyte_char_buffer: + +.. rst-class:: classref-method + +:ref:`PackedByteArray` **to_multibyte_char_buffer**\ (\ encoding\: :ref:`String` = ""\ ) |const| :ref:`🔗` + +Converts the string to system multibyte code page encoded :ref:`PackedByteArray`. If conversion fails, empty array is returned. + +The values permitted for ``encoding`` are system dependent. If ``encoding`` is empty string, system default encoding is used. + +- For Windows, see `Code Page Identifiers `__ .NET names. + +- For macOS and Linux/BSD, see ``libiconv`` library documentation and ``iconv --list`` for a list of supported encodings. + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_to_pascal_case: .. rst-class:: classref-method @@ -1957,6 +2068,8 @@ Decodes the string from its URL-encoded format. This method is meant to properly +\ **Note:** This method decodes ``+`` as space. + .. rst-class:: classref-item-separator ---- @@ -1988,6 +2101,18 @@ Encodes the string to URL-friendly format. This method is meant to properly enco +.. rst-class:: classref-item-separator + +---- + +.. _class_StringName_method_uri_file_decode: + +.. rst-class:: classref-method + +:ref:`String` **uri_file_decode**\ (\ ) |const| :ref:`🔗` + +Decodes the file path from its URL-encoded format. Unlike :ref:`uri_decode()` this method leaves ``+`` as is. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_systemfont.rst b/classes/class_systemfont.rst index 7fc78bc4a74..7fc17d15fe5 100644 --- a/classes/class_systemfont.rst +++ b/classes/class_systemfont.rst @@ -60,6 +60,8 @@ Properties +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`keep_rounding_remainders` | ``true`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`modulate_color_glyphs` | ``false`` | + +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`msdf_pixel_range` | ``16`` | +-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`msdf_size` | ``48`` | @@ -269,6 +271,23 @@ If set to ``true``, when aligning glyphs to the pixel boundaries rounding remain ---- +.. _class_SystemFont_property_modulate_color_glyphs: + +.. rst-class:: classref-property + +:ref:`bool` **modulate_color_glyphs** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_modulate_color_glyphs**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_modulate_color_glyphs**\ (\ ) + +If set to ``true``, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only. + +.. rst-class:: classref-item-separator + +---- + .. _class_SystemFont_property_msdf_pixel_range: .. rst-class:: classref-property diff --git a/classes/class_tabbar.rst b/classes/class_tabbar.rst index f3cb144d083..77f90f8597e 100644 --- a/classes/class_tabbar.rst +++ b/classes/class_tabbar.rst @@ -32,6 +32,8 @@ Properties +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`clip_tabs` | ``true`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | :ref:`bool` | :ref:`close_with_middle_mouse` | ``true`` | + +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`int` | :ref:`current_tab` | ``-1`` | +-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`deselect_enabled` | ``false`` | @@ -158,6 +160,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`tab_separation` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`font_size` | | @@ -252,7 +256,7 @@ 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. +Emitted when a tab's close button is pressed or when middle-clicking on a tab, if :ref:`close_with_middle_mouse` is enabled. \ **Note:** Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example: @@ -420,6 +424,23 @@ If ``true``, tabs overflowing this node's width will be hidden, displaying two n ---- +.. _class_TabBar_property_close_with_middle_mouse: + +.. rst-class:: classref-property + +:ref:`bool` **close_with_middle_mouse** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |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. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_property_current_tab: .. rst-class:: classref-property @@ -1115,6 +1136,18 @@ The size of the tab text outline. ---- +.. _class_TabBar_theme_constant_tab_separation: + +.. rst-class:: classref-themeproperty + +:ref:`int` **tab_separation** = ``0`` :ref:`🔗` + +The space between tabs in the tab bar. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabBar_theme_font_font: .. rst-class:: classref-themeproperty diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 00b64f33014..b08b13eb2b4 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -155,6 +155,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`side_margin` | ``8`` | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`int` | :ref:`tab_separation` | ``0`` | + +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`font_size` | | @@ -982,6 +984,18 @@ The margin is ignored with :ref:`TabBar.ALIGNMENT_RIGHT` **tab_separation** = ``0`` :ref:`🔗` + +The space between tabs in the tab bar. + +.. rst-class:: classref-item-separator + +---- + .. _class_TabContainer_theme_font_font: .. rst-class:: classref-themeproperty diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 1a5c0cbcbf5..42bf41688ea 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -26,6 +26,14 @@ Description A multiline text editor. It also has limited facilities for editing code, such as syntax highlighting support. For more advanced facilities for editing code, see :ref:`CodeEdit`. +While entering text, it is possible to insert special characters using Unicode, OEM or Windows alt codes: + +- To enter Unicode codepoints, hold :kbd:`Alt` and type the codepoint on the numpad. For example, to enter the character ``á`` (U+00E1), hold :kbd:`Alt` and type :kbd:`+E1` on the numpad (the leading zeroes can be omitted). + +- To enter OEM codepoints, hold :kbd:`Alt` and type the code on the numpad. For example, to enter the character ``á`` (OEM 160), hold :kbd:`Alt` and type ``160`` on the numpad. + +- To enter Windows codepoints, hold :kbd:`Alt` and type the code on the numpad. For example, to enter the character ``á`` (Windows 0225), hold :kbd:`Alt` and type :kbd:`0`, :kbd:`2`, :kbd:`2`, :kbd:`5` on the numpad. The leading zero here must **not** be omitted, as this is how Windows codepoints are distinguished from OEM codepoints. + \ **Note:** Most viewport, caret, and edit methods contain a ``caret_index`` argument for :ref:`caret_multiple` support. The argument should be one of the following: ``-1`` for all carets, ``0`` for the main caret, or greater than ``0`` for secondary carets in the order they were created. \ **Note:** When holding down :kbd:`Alt`, the vertical scroll wheel will scroll 5 times as fast as it would normally do. This also works in the Godot script editor. @@ -121,6 +129,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`SyntaxHighlighter` | :ref:`syntax_highlighter` | | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`tab_input_mode` | ``true`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`text` | ``""`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | @@ -1755,6 +1765,23 @@ The syntax highlighter to use. ---- +.. _class_TextEdit_property_tab_input_mode: + +.. rst-class:: classref-property + +:ref:`bool` **tab_input_mode** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_tab_input_mode**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **get_tab_input_mode**\ (\ ) + +If ``true``, :ref:`ProjectSettings.input/ui_text_indent` input ``Tab`` character, otherwise it moves keyboard focus to the next :ref:`Control` in the scene. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextEdit_property_text: .. rst-class:: classref-property diff --git a/classes/class_textline.rst b/classes/class_textline.rst index b3b5896fea1..0c2c5156594 100644 --- a/classes/class_textline.rst +++ b/classes/class_textline.rst @@ -57,43 +57,45 @@ Methods .. table:: :widths: auto - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_ascent`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_descent`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_position`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_width`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_object_rect`\ (\ key\: :ref:`Variant`\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_objects`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`float`\ ) |const| | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | - +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`get_inferred_direction`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_ascent`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_descent`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_position`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_width`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_object_rect`\ (\ key\: :ref:`Variant`\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_objects`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`float`\ ) |const| | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | + +---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -322,6 +324,18 @@ Draw text into a canvas item at a given position, with ``color``. ``pos`` specif ---- +.. _class_TextLine_method_get_inferred_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **get_inferred_direction**\ (\ ) |const| :ref:`🔗` + +Returns the text writing direction inferred by the BiDi algorithm. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextLine_method_get_line_ascent: .. rst-class:: classref-method diff --git a/classes/class_textparagraph.rst b/classes/class_textparagraph.rst index 1c26b167ea2..a0bd832635f 100644 --- a/classes/class_textparagraph.rst +++ b/classes/class_textparagraph.rst @@ -65,71 +65,75 @@ Methods .. table:: :widths: auto - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear`\ (\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_dropcap`\ (\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_dropcap`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_dropcap_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_line`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_line_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_dropcap_lines`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_dropcap_rid`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_dropcap_size`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_ascent`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_descent`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_line_object_rect`\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_line_objects`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_line_rid`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_line_size`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_position`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_non_wrapped_size`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`Vector2`\ ) |const| | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`set_dropcap`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | - +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`add_string`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, language\: :ref:`String` = "", meta\: :ref:`Variant` = null\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear`\ (\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_dropcap`\ (\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dropcap`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_dropcap_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_line_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, line\: :ref:`int`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`draw_outline`\ (\ canvas\: :ref:`RID`, pos\: :ref:`Vector2`, outline_size\: :ref:`int` = 1, color\: :ref:`Color` = Color(1, 1, 1, 1), dc_color\: :ref:`Color` = Color(1, 1, 1, 1)\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_dropcap_lines`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_dropcap_rid`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_dropcap_size`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`get_inferred_direction`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_ascent`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_line_count`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_descent`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_line_object_rect`\ (\ line\: :ref:`int`, key\: :ref:`Variant`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_line_objects`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_line_range`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_line_rid`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_line_size`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_position`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_underline_thickness`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_line_width`\ (\ line\: :ref:`int`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_non_wrapped_size`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`get_range`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`get_rid`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2` | :ref:`get_size`\ (\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`hit_test`\ (\ coords\: :ref:`Vector2`\ ) |const| | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`resize_object`\ (\ key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, baseline\: :ref:`float` = 0.0\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_bidi_override`\ (\ override\: :ref:`Array`\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`set_dropcap`\ (\ text\: :ref:`String`, font\: :ref:`Font`, font_size\: :ref:`int`, dropcap_margins\: :ref:`Rect2` = Rect2(0, 0, 0, 0), language\: :ref:`String` = ""\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`tab_align`\ (\ tab_stops\: :ref:`PackedFloat32Array`\ ) | + +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -522,6 +526,18 @@ Returns drop cap bounding box size. ---- +.. _class_TextParagraph_method_get_inferred_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **get_inferred_direction**\ (\ ) |const| :ref:`🔗` + +Returns the text writing direction inferred by the BiDi algorithm. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextParagraph_method_get_line_ascent: .. rst-class:: classref-method @@ -666,6 +682,18 @@ Returns the size of the bounding box of the paragraph, without line breaks. ---- +.. _class_TextParagraph_method_get_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **get_range**\ (\ ) |const| :ref:`🔗` + +Returns the character range of the paragraph. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextParagraph_method_get_rid: .. rst-class:: classref-method diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 1357efc5cc0..cabb0a4dd06 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -185,6 +185,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`font_is_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |const| | @@ -251,6 +253,8 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`font_set_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`, force_autohinter\: :ref:`bool`\ ) | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) | @@ -335,12 +339,34 @@ Methods +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`save_support_data`\ (\ filename\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_get_run_count`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`shaped_get_run_direction`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`shaped_get_run_font_rid`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_get_run_font_size`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_run_language`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_run_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`shaped_get_run_range`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_run_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`shaped_get_span_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_span_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`shaped_get_text`\ (\ shaped\: :ref:`RID`\ ) |const| | + +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary` = {}\ ) | +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment` = 5, length\: :ref:`int` = 1, baseline\: :ref:`float` = 0.0\ ) | @@ -525,7 +551,7 @@ Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps. Font glyphs are rasterized for LCD screens. -LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings. +LCD subpixel layout is determined by the value of the :ref:`ProjectSettings.gui/theme/lcd_subpixel_layout` setting. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D. @@ -837,6 +863,8 @@ Should be used only in conjunction with :ref:`BREAK_WORD_BOUND` **BREAK_TRIM_EDGE_SPACES** = ``16`` +**Deprecated:** Use ``BREAK_TRIM_START_EDGE_SPACES | BREAK_TRIM_END_EDGE_SPACES`` instead. + Remove edge spaces from the broken line segments. .. _class_TextServer_constant_BREAK_TRIM_INDENT: @@ -847,6 +875,26 @@ Remove edge spaces from the broken line segments. Subtract first line indentation width from all lines after the first one. +.. _class_TextServer_constant_BREAK_TRIM_START_EDGE_SPACES: + +.. rst-class:: classref-enumeration-constant + +:ref:`LineBreakFlag` **BREAK_TRIM_START_EDGE_SPACES** = ``64`` + +Remove spaces and line break characters from the start of broken line segments. + +E.g, after line breaking, the second segment of the following text ``test \n next``, is ``next`` if the flag is set, and `` next`` if it is not. + +.. _class_TextServer_constant_BREAK_TRIM_END_EDGE_SPACES: + +.. rst-class:: classref-enumeration-constant + +:ref:`LineBreakFlag` **BREAK_TRIM_END_EDGE_SPACES** = ``128`` + +Remove spaces and line break characters from the end of broken line segments. + +E.g, after line breaking, the first segment of the following text ``test \n next``, is ``test`` if the flag is set, and ``test \n`` if it is not. + .. rst-class:: classref-item-separator ---- @@ -939,7 +987,7 @@ Trims the text per word. :ref:`OverrunBehavior` **OVERRUN_TRIM_ELLIPSIS** = ``3`` -Trims the text per character and adds an ellipsis to indicate that parts are hidden. +Trims the text per character and adds an ellipsis to indicate that parts are hidden if trimmed text is 6 characters or longer. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS: @@ -947,7 +995,23 @@ Trims the text per character and adds an ellipsis to indicate that parts are hid :ref:`OverrunBehavior` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4`` -Trims the text per word and adds an ellipsis to indicate that parts are hidden. +Trims the text per word and adds an ellipsis to indicate that parts are hidden if trimmed text is 6 characters or longer. + +.. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS_FORCE: + +.. rst-class:: classref-enumeration-constant + +:ref:`OverrunBehavior` **OVERRUN_TRIM_ELLIPSIS_FORCE** = ``5`` + +Trims the text per character and adds an ellipsis to indicate that parts are hidden regardless of trimmed text length. + +.. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS_FORCE: + +.. rst-class:: classref-enumeration-constant + +:ref:`OverrunBehavior` **OVERRUN_TRIM_WORD_ELLIPSIS_FORCE** = ``6`` + +Trims the text per word and adds an ellipsis to indicate that parts are hidden regardless of trimmed text length. .. rst-class:: classref-item-separator @@ -2440,6 +2504,18 @@ 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. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_is_multichannel_signed_distance_field: .. rst-class:: classref-method @@ -2844,6 +2920,18 @@ Adds override for :ref:`font_is_language_supported()`, force_autohinter\: :ref:`bool`\ ) :ref:`🔗` + +If set to ``true``, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_set_msdf_pixel_range: .. rst-class:: classref-method @@ -3384,6 +3472,102 @@ Saves optional TextServer database (e.g. ICU break iterators and dictionaries) t ---- +.. _class_TextServer_method_shaped_get_run_count: + +.. rst-class:: classref-method + +:ref:`int` **shaped_get_run_count**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns the number of uniform text runs in the buffer. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **shaped_get_run_direction**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the direction of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_font_rid: + +.. rst-class:: classref-method + +:ref:`RID` **shaped_get_run_font_rid**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the font RID of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_font_size: + +.. rst-class:: classref-method + +:ref:`int` **shaped_get_run_font_size**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the font size of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_language: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_run_language**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the language of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_object: + +.. rst-class:: classref-method + +:ref:`Variant` **shaped_get_run_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the embedded object of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **shaped_get_run_range**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the source text range of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_run_text: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_run_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the source text of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_get_span_count: .. rst-class:: classref-method @@ -3420,6 +3604,42 @@ Returns text span metadata. ---- +.. _class_TextServer_method_shaped_get_span_object: + +.. rst-class:: classref-method + +:ref:`Variant` **shaped_get_span_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the text span embedded object key. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_span_text: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_span_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the text span source text. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServer_method_shaped_get_text: + +.. rst-class:: classref-method + +:ref:`String` **shaped_get_text**\ (\ shaped\: :ref:`RID`\ ) |const| :ref:`🔗` + +Returns the text buffer source text, including object replacement characters. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_set_span_update_font: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index d52a0cb4e1d..72bcc2159e6 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -170,6 +170,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_font_is_language_supported`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_font_is_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_font_is_multichannel_signed_distance_field`\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_font_is_script_supported`\ (\ font_rid\: :ref:`RID`, script\: :ref:`String`\ ) |virtual| |const| | @@ -238,6 +240,8 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_font_set_language_support_override`\ (\ font_rid\: :ref:`RID`, language\: :ref:`String`, supported\: :ref:`bool`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`_font_set_modulate_color_glyphs`\ (\ font_rid\: :ref:`RID`, modulate\: :ref:`bool`\ ) |virtual| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_font_set_msdf_pixel_range`\ (\ font_rid\: :ref:`RID`, msdf_pixel_range\: :ref:`int`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_font_set_msdf_size`\ (\ font_rid\: :ref:`RID`, msdf_size\: :ref:`int`\ ) |virtual| | @@ -322,12 +326,34 @@ Methods +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_save_support_data`\ (\ filename\: :ref:`String`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_get_run_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Direction` | :ref:`_shaped_get_run_direction`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`RID` | :ref:`_shaped_get_run_font_rid`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_get_run_font_size`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_run_language`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_run_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Vector2i` | :ref:`_shaped_get_run_range`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_run_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_shaped_get_span_count`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_shaped_get_span_embedded_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_shaped_get_span_meta`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`_shaped_get_span_object`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_span_text`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_shaped_get_text`\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_shaped_set_span_update_font`\ (\ shaped\: :ref:`RID`, index\: :ref:`int`, fonts\: :ref:`Array`\[:ref:`RID`\], size\: :ref:`int`, opentype_features\: :ref:`Dictionary`\ ) |virtual| | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_shaped_text_add_object`\ (\ shaped\: :ref:`RID`, key\: :ref:`Variant`, size\: :ref:`Vector2`, inline_align\: :ref:`InlineAlignment`, length\: :ref:`int`, baseline\: :ref:`float`\ ) |virtual| | @@ -1450,6 +1476,20 @@ Returns ``true``, if font supports given language (`ISO 639 ` **_font_is_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` + +**Optional.**\ + +Returns ``true``, if color modulation is applied when drawing colored glyphs. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__font_is_multichannel_signed_distance_field: .. rst-class:: classref-method @@ -1924,6 +1964,20 @@ Adds override for :ref:`_font_is_language_supported()`, modulate\: :ref:`bool`\ ) |virtual| :ref:`🔗` + +**Optional.**\ + +If set to ``true``, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__font_set_msdf_pixel_range: .. rst-class:: classref-method @@ -2512,6 +2566,118 @@ Saves optional TextServer database (e.g. ICU break iterators and dictionaries) t ---- +.. _class_TextServerExtension_private_method__shaped_get_run_count: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_get_run_count**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the number of uniform text runs in the buffer. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_direction: + +.. rst-class:: classref-method + +:ref:`Direction` **_shaped_get_run_direction**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the direction of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_font_rid: + +.. rst-class:: classref-method + +:ref:`RID` **_shaped_get_run_font_rid**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the font RID of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_font_size: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_get_run_font_size**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the font size of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_language: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_run_language**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the language of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_object: + +.. rst-class:: classref-method + +:ref:`Variant` **_shaped_get_run_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the embedded object of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_range: + +.. rst-class:: classref-method + +:ref:`Vector2i` **_shaped_get_run_range**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the source text range of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_run_text: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_run_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the source text of the ``index`` text run (in visual order). + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__shaped_get_span_count: .. rst-class:: classref-method @@ -2554,6 +2720,48 @@ Returns text span metadata. ---- +.. _class_TextServerExtension_private_method__shaped_get_span_object: + +.. rst-class:: classref-method + +:ref:`Variant` **_shaped_get_span_object**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the text span embedded object key. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_span_text: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_span_text**\ (\ shaped\: :ref:`RID`, index\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the text span source text. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TextServerExtension_private_method__shaped_get_text: + +.. rst-class:: classref-method + +:ref:`String` **_shaped_get_text**\ (\ shaped\: :ref:`RID`\ ) |virtual| |const| :ref:`🔗` + +**Required.**\ + +Returns the text buffer source text, including object replacement characters. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_private_method__shaped_set_span_update_font: .. rst-class:: classref-method diff --git a/classes/class_tiledata.rst b/classes/class_tiledata.rst index af4581a4d1b..59d0b87c3f8 100644 --- a/classes/class_tiledata.rst +++ b/classes/class_tiledata.rst @@ -19,7 +19,7 @@ Settings for a single tile in a :ref:`TileSet`. Description ----------- -**TileData** object represents a single tile in a :ref:`TileSet`. It is usually edited using the tileset editor, but it can be modified at runtime using :ref:`TileMap._tile_data_runtime_update()`. +**TileData** object represents a single tile in a :ref:`TileSet`. It is usually edited using the tileset editor, but it can be modified at runtime using :ref:`TileMapLayer._tile_data_runtime_update()`. .. rst-class:: classref-reftable-group @@ -334,7 +334,7 @@ Vertical point of the tile used for determining y-sorted order. - |void| **set_z_index**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_z_index**\ (\ ) -Ordering index of this tile, relative to :ref:`TileMap`. +Ordering index of this tile, relative to :ref:`TileMapLayer`. .. rst-class:: classref-section-separator diff --git a/classes/class_tilemaplayer.rst b/classes/class_tilemaplayer.rst index 250f405a3c0..f974307bcb6 100644 --- a/classes/class_tilemaplayer.rst +++ b/classes/class_tilemaplayer.rst @@ -69,6 +69,8 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`occlusion_enabled` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`int` | :ref:`physics_quadrant_size` | ``16`` | + +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`rendering_quadrant_size` | ``16`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`tile_map_data` | ``PackedByteArray()`` | @@ -325,6 +327,27 @@ Enable or disable light occlusion. ---- +.. _class_TileMapLayer_property_physics_quadrant_size: + +.. rst-class:: classref-property + +:ref:`int` **physics_quadrant_size** = ``16`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_physics_quadrant_size**\ (\ value\: :ref:`int`\ ) +- :ref:`int` **get_physics_quadrant_size**\ (\ ) + +The **TileMapLayer**'s physics quadrant size. Within a physics quadrant, cells with similar physics properties are grouped together and their collision shapes get merged. :ref:`physics_quadrant_size` defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quadrant size groups together ``16 * 16 = 256`` tiles. + +\ **Note:** As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the **TileMapLayer**'s local coordinate system. + +\ **Note:** This impacts the value returned by :ref:`get_coords_for_body_rid()`. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileMapLayer_property_rendering_quadrant_size: .. rst-class:: classref-property @@ -336,7 +359,7 @@ Enable or disable light occlusion. - |void| **set_rendering_quadrant_size**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_rendering_quadrant_size**\ (\ ) -The **TileMapLayer**'s quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. :ref:`rendering_quadrant_size` defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quadrant size groups together ``16 * 16 = 256`` tiles. +The **TileMapLayer**'s rendering quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. :ref:`rendering_quadrant_size` defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quadrant size groups together ``16 * 16 = 256`` tiles. The quadrant size does not apply on a Y-sorted **TileMapLayer**, as tiles are grouped by Y position instead in that case. @@ -598,7 +621,7 @@ Returns the :ref:`TileData` object associated with the given cel :ref:`Vector2i` **get_coords_for_body_rid**\ (\ body\: :ref:`RID`\ ) |const| :ref:`🔗` -Returns the coordinates of the tile for given physics body :ref:`RID`. Such an :ref:`RID` can be retrieved from :ref:`KinematicCollision2D.get_collider_rid()`, when colliding with a tile. +Returns the coordinates of the physics quadrant (see :ref:`physics_quadrant_size`) for given physics body :ref:`RID`. Such an :ref:`RID` can be retrieved from :ref:`KinematicCollision2D.get_collider_rid()`, when colliding with a tile. .. rst-class:: classref-item-separator diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 326066cb17f..37e62be444b 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -269,7 +269,7 @@ Rectangular tile shape. Diamond tile shape (for isometric look). -\ **Note:** Isometric **TileSet** works best if :ref:`TileMap` and all its layers have Y-sort enabled. +\ **Note:** Isometric **TileSet** works best if all sibling :ref:`TileMapLayer`\ s and their parent inheriting from :ref:`Node2D` have Y-sort enabled. .. _class_TileSet_constant_TILE_SHAPE_HALF_OFFSET_SQUARE: @@ -563,7 +563,7 @@ Property Descriptions - |void| **set_tile_layout**\ (\ value\: :ref:`TileLayout`\ ) - :ref:`TileLayout` **get_tile_layout**\ (\ ) -For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the TileMap grid. +For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the :ref:`TileMapLayer` grid. .. rst-class:: classref-item-separator @@ -1416,9 +1416,7 @@ Removes the terrain set at index ``terrain_set``. Also updates the atlas tiles a Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. -This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. - -Proxied tiles can be automatically replaced in TileMap nodes using the editor. +Proxied tiles can be automatically replaced in TileMapLayer nodes using the editor. .. rst-class:: classref-item-separator @@ -1432,9 +1430,7 @@ Proxied tiles can be automatically replaced in TileMap nodes using the editor. Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. -This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. - -Proxied tiles can be automatically replaced in TileMap nodes using the editor. +Proxied tiles can be automatically replaced in TileMapLayer nodes using the editor. .. rst-class:: classref-item-separator @@ -1580,9 +1576,7 @@ Changes a source's ID. Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies. -This can be used to replace a source in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target source when one is available. - -Proxied tiles can be automatically replaced in TileMap nodes using the editor. +Proxied tiles can be automatically replaced in TileMapLayer nodes using the editor. .. rst-class:: classref-item-separator diff --git a/classes/class_tilesetatlassource.rst b/classes/class_tilesetatlassource.rst index 341a29e7d3b..781fb4762a9 100644 --- a/classes/class_tilesetatlassource.rst +++ b/classes/class_tilesetatlassource.rst @@ -175,14 +175,14 @@ Constants **TRANSFORM_FLIP_H** = ``4096`` :ref:`🔗` -Represents cell's horizontal flip flag. Should be used directly with :ref:`TileMap` to flip placed tiles by altering their alternative IDs. +Represents cell's horizontal flip flag. Should be used directly with :ref:`TileMapLayer` to flip placed tiles by altering their alternative IDs. :: - var alternate_id = $TileMap.get_cell_alternative_tile(0, Vector2i(2, 2)) + var alternate_id = $TileMapLayer.get_cell_alternative_tile(Vector2i(2, 2)) if not alternate_id & TileSetAtlasSource.TRANSFORM_FLIP_H: # If tile is not already flipped, flip it. - $TileMap.set_cell(0, Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) + $TileMapLayer.set_cell(Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) \ **Note:** These transformations can be combined to do the equivalent of 0, 90, 180, and 270 degree rotations, as shown below: diff --git a/classes/class_tilesetscenescollectionsource.rst b/classes/class_tilesetscenescollectionsource.rst index 2da3058924c..4a509577b41 100644 --- a/classes/class_tilesetscenescollectionsource.rst +++ b/classes/class_tilesetscenescollectionsource.rst @@ -19,9 +19,9 @@ Exposes a set of scenes as tiles for a :ref:`TileSet` resource. Description ----------- -When placed on a :ref:`TileMap`, tiles from **TileSetScenesCollectionSource** will automatically instantiate an associated scene at the cell's position in the TileMap. +When placed on a :ref:`TileMapLayer`, tiles from **TileSetScenesCollectionSource** will automatically instantiate an associated scene at the cell's position in the TileMapLayer. -Scenes are instantiated as children of the :ref:`TileMap` when it enters the tree. If you add/remove a scene tile in the :ref:`TileMap` that is already inside the tree, the :ref:`TileMap` will automatically instantiate/free the scene accordingly. +Scenes are instantiated as children of the :ref:`TileMapLayer` when it enters the tree. If you add/remove a scene tile in the :ref:`TileMapLayer` that is already inside the tree, the :ref:`TileMapLayer` will automatically instantiate/free the scene accordingly. \ **Note:** Scene tiles all occupy one tile slot and instead use alternate tile ID to identify scene index. :ref:`TileSetSource.get_tiles_count()` will always return ``1``. Use :ref:`get_scene_tiles_count()` to get a number of scenes in a **TileSetScenesCollectionSource**. @@ -225,7 +225,7 @@ Changes a scene tile's ID from ``id`` to ``new_id``. This will fail if there is |void| **set_scene_tile_scene**\ (\ id\: :ref:`int`, packed_scene\: :ref:`PackedScene`\ ) :ref:`🔗` -Assigns a :ref:`PackedScene` resource to the scene tile with ``id``. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the TileMap. +Assigns a :ref:`PackedScene` resource to the scene tile with ``id``. This will fail if the scene does not extend :ref:`CanvasItem`, as positioning properties are needed to place the scene on the :ref:`TileMapLayer`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 2ebe1f2f5c9..6e9a26f98d3 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -203,6 +203,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_hovered_dimmed_color` | ``Color(0.875, 0.875, 0.875, 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)`` | @@ -313,6 +315,10 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`hovered_dimmed` | | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hovered_selected` | | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ + | :ref:`StyleBox` | :ref:`hovered_selected_focus` | | + +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`StyleBox` | :ref:`selected` | | @@ -1399,7 +1405,7 @@ Text :ref:`Color` for a :ref:`TreeItem.CELL_MODE_CHECK` **font_hovered_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗` -Text :ref:`Color` used when the item is hovered. +Text :ref:`Color` used when the item is hovered and not selected yet. .. rst-class:: classref-item-separator @@ -1417,6 +1423,18 @@ Text :ref:`Color` used when the item is hovered, while a button of ---- +.. _class_Tree_theme_color_font_hovered_selected_color: + +.. rst-class:: classref-themeproperty + +:ref:`Color` **font_hovered_selected_color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` + +Text :ref:`Color` used when the item is hovered and selected. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_color_font_outline_color: .. rst-class:: classref-themeproperty @@ -2061,7 +2079,7 @@ The focused style for the **Tree**, drawn on top of everything. :ref:`StyleBox` **hovered** :ref:`🔗` -:ref:`StyleBox` for the item being hovered. +:ref:`StyleBox` for the item being hovered, but not selected. .. rst-class:: classref-item-separator @@ -2079,6 +2097,30 @@ The focused style for the **Tree**, drawn on top of everything. ---- +.. _class_Tree_theme_style_hovered_selected: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hovered_selected** :ref:`🔗` + +:ref:`StyleBox` for the hovered and selected items, used when the **Tree** is not being focused. + +.. rst-class:: classref-item-separator + +---- + +.. _class_Tree_theme_style_hovered_selected_focus: + +.. rst-class:: classref-themeproperty + +:ref:`StyleBox` **hovered_selected_focus** :ref:`🔗` + +:ref:`StyleBox` for the hovered and selected items, used when the **Tree** is being focused. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_style_panel: .. rst-class:: classref-themeproperty diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 27611d641aa..c1403a41440 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -51,223 +51,229 @@ Methods .. table:: :widths: auto - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_button`\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`add_child`\ (\ child\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`call_recursive`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_buttons`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_custom_bg_color`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`clear_custom_color`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`create_child`\ (\ index\: :ref:`int` = -1\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`deselect`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AutoTranslateMode` | :ref:`get_auto_translate_mode`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_by_id`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_button_color`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_count`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_button_id`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeCellMode` | :ref:`get_cell_mode`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_child`\ (\ index\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_child_count`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array`\[:ref:`TreeItem`\] | :ref:`get_children`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_custom_bg_color`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_custom_color`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Callable` | :ref:`get_custom_draw_callback`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Font` | :ref:`get_custom_font`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_custom_font_size`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`get_expand_right`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_first_child`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_icon`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_icon_max_width`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_icon_overlay`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_index`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_language`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_metadata`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_next_visible`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_parent`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TreeItem` | :ref:`get_prev_visible`\ (\ wrap\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`float` | :ref:`get_range`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_range_config`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Array` | :ref:`get_structured_text_bidi_override_options`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_suffix`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_text`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`HorizontalAlignment` | :ref:`get_text_alignment`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_text_direction`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_tooltip_text`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Tree` | :ref:`get_tree`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_any_collapsed`\ (\ only_visible\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_checked`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_custom_set_as_button`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_edit_multiline`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_editable`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_indeterminate`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selectable`\ (\ column\: :ref:`int`\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_selected`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`move_after`\ (\ item\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`move_before`\ (\ item\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`propagate_check`\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`remove_child`\ (\ child\: :ref:`TreeItem`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_auto_translate_mode`\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button_color`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_cell_mode`\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_checked`\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_collapsed_recursive`\ (\ enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_as_button`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_bg_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_draw`\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_draw_callback`\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_font`\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_custom_font_size`\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_edit_multiline`\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_editable`\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_expand_right`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_max_width`\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_overlay`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_metadata`\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_range`\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_range_config`\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_selectable`\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_structured_text_bidi_override`\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_structured_text_bidi_override_options`\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_suffix`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text_alignment`\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_text_overrun_behavior`\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tooltip_text`\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`uncollapse_tree`\ (\ ) | - +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_button`\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = "", alt_text\: :ref:`String` = ""\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`add_child`\ (\ child\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`call_recursive`\ (\ method\: :ref:`StringName`, ...\ ) |vararg| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_buttons`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_custom_bg_color`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`clear_custom_color`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`create_child`\ (\ index\: :ref:`int` = -1\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`deselect`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`erase_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_alt_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutoTranslateMode` | :ref:`get_auto_translate_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AutowrapMode` | :ref:`get_autowrap_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_by_id`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_button_color`\ (\ column\: :ref:`int`, id\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_count`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_button_id`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeCellMode` | :ref:`get_cell_mode`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_child`\ (\ index\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_child_count`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array`\[:ref:`TreeItem`\] | :ref:`get_children`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_custom_bg_color`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_custom_color`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Callable` | :ref:`get_custom_draw_callback`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Font` | :ref:`get_custom_font`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_custom_font_size`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`get_expand_right`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_first_child`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_icon_max_width`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_icon_modulate`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_icon_overlay`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Rect2` | :ref:`get_icon_region`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_index`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_language`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_metadata`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_next_visible`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_parent`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev_in_tree`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TreeItem` | :ref:`get_prev_visible`\ (\ wrap\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`get_range`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`get_range_config`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`StructuredTextParser` | :ref:`get_structured_text_bidi_override`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Array` | :ref:`get_structured_text_bidi_override_options`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_suffix`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`HorizontalAlignment` | :ref:`get_text_alignment`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_text_direction`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`OverrunBehavior` | :ref:`get_text_overrun_behavior`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_tooltip_text`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Tree` | :ref:`get_tree`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_any_collapsed`\ (\ only_visible\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_checked`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_custom_set_as_button`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_edit_multiline`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_editable`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_indeterminate`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selectable`\ (\ column\: :ref:`int`\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_selected`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_visible_in_tree`\ (\ ) |const| | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_after`\ (\ item\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`move_before`\ (\ item\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`propagate_check`\ (\ column\: :ref:`int`, emit_signal\: :ref:`bool` = true\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`remove_child`\ (\ child\: :ref:`TreeItem`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`select`\ (\ column\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_alt_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_auto_translate_mode`\ (\ column\: :ref:`int`, mode\: :ref:`AutoTranslateMode`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_autowrap_mode`\ (\ column\: :ref:`int`, autowrap_mode\: :ref:`AutowrapMode`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, button\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_alt_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, alt_text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_color`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_disabled`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, disabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_button_tooltip_text`\ (\ column\: :ref:`int`, button_index\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_cell_mode`\ (\ column\: :ref:`int`, mode\: :ref:`TreeCellMode`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_checked`\ (\ column\: :ref:`int`, checked\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_collapsed_recursive`\ (\ enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_as_button`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_bg_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`, just_outline\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_color`\ (\ column\: :ref:`int`, color\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_draw`\ (\ column\: :ref:`int`, object\: :ref:`Object`, callback\: :ref:`StringName`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_draw_callback`\ (\ column\: :ref:`int`, callback\: :ref:`Callable`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_font`\ (\ column\: :ref:`int`, font\: :ref:`Font`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_custom_font_size`\ (\ column\: :ref:`int`, font_size\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_edit_multiline`\ (\ column\: :ref:`int`, multiline\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_editable`\ (\ column\: :ref:`int`, enabled\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_expand_right`\ (\ column\: :ref:`int`, enable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_max_width`\ (\ column\: :ref:`int`, width\: :ref:`int`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_modulate`\ (\ column\: :ref:`int`, modulate\: :ref:`Color`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_overlay`\ (\ column\: :ref:`int`, texture\: :ref:`Texture2D`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_icon_region`\ (\ column\: :ref:`int`, region\: :ref:`Rect2`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_indeterminate`\ (\ column\: :ref:`int`, indeterminate\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_language`\ (\ column\: :ref:`int`, language\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_metadata`\ (\ column\: :ref:`int`, meta\: :ref:`Variant`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_range`\ (\ column\: :ref:`int`, value\: :ref:`float`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_range_config`\ (\ column\: :ref:`int`, min\: :ref:`float`, max\: :ref:`float`, step\: :ref:`float`, expr\: :ref:`bool` = false\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_selectable`\ (\ column\: :ref:`int`, selectable\: :ref:`bool`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_structured_text_bidi_override`\ (\ column\: :ref:`int`, parser\: :ref:`StructuredTextParser`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_structured_text_bidi_override_options`\ (\ column\: :ref:`int`, args\: :ref:`Array`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_suffix`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text`\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_alignment`\ (\ column\: :ref:`int`, text_alignment\: :ref:`HorizontalAlignment`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_direction`\ (\ column\: :ref:`int`, direction\: :ref:`TextDirection`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_text_overrun_behavior`\ (\ column\: :ref:`int`, overrun_behavior\: :ref:`OverrunBehavior`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tooltip_text`\ (\ column\: :ref:`int`, tooltip\: :ref:`String`\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`uncollapse_tree`\ (\ ) | + +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -416,9 +422,9 @@ Method Descriptions .. rst-class:: classref-method -|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = ""\ ) :ref:`🔗` +|void| **add_button**\ (\ column\: :ref:`int`, button\: :ref:`Texture2D`, id\: :ref:`int` = -1, disabled\: :ref:`bool` = false, tooltip_text\: :ref:`String` = "", alt_text\: :ref:`String` = ""\ ) :ref:`🔗` -Adds a button with :ref:`Texture2D` ``button`` to the end of the cell at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count()` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. +Adds a button with :ref:`Texture2D` ``button`` to the end of the cell at column ``column``. The ``id`` is used to identify the button in the according :ref:`Tree.button_clicked` signal and can be different from the buttons index. If not specified, the next available index is used, which may be retrieved by calling :ref:`get_button_count()` immediately before this method. Optionally, the button can be ``disabled`` and have a ``tooltip_text``. ``alt_text`` is used as the button description for assistive apps. .. rst-class:: classref-item-separator @@ -522,6 +528,18 @@ Removes the button at index ``button_index`` in column ``column``. ---- +.. _class_TreeItem_method_get_alt_text: + +.. rst-class:: classref-method + +:ref:`String` **get_alt_text**\ (\ column\: :ref:`int`\ ) |const| :ref:`🔗` + +Returns the given column's alternative text. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_get_auto_translate_mode: .. rst-class:: classref-method @@ -1260,6 +1278,18 @@ Selects the given ``column``. ---- +.. _class_TreeItem_method_set_alt_text: + +.. rst-class:: classref-method + +|void| **set_alt_text**\ (\ column\: :ref:`int`, text\: :ref:`String`\ ) :ref:`🔗` + +Sets the given column's alternative (description) text for assistive apps. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_auto_translate_mode: .. rst-class:: classref-method @@ -1298,6 +1328,18 @@ Sets the given column's button :ref:`Texture2D` at index ``butt ---- +.. _class_TreeItem_method_set_button_alt_text: + +.. rst-class:: classref-method + +|void| **set_button_alt_text**\ (\ column\: :ref:`int`, button_index\: :ref:`int`, alt_text\: :ref:`String`\ ) :ref:`🔗` + +Sets the given column's button alternative text (description) at index ``button_index`` for assistive apps. + +.. rst-class:: classref-item-separator + +---- + .. _class_TreeItem_method_set_button_color: .. rst-class:: classref-method diff --git a/classes/class_trianglemesh.rst b/classes/class_trianglemesh.rst index 3b6844f6399..4685bf3965e 100644 --- a/classes/class_trianglemesh.rst +++ b/classes/class_trianglemesh.rst @@ -12,14 +12,117 @@ TriangleMesh **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -Internal mesh type. +Triangle geometry for efficient, physicsless intersection queries. .. rst-class:: classref-introduction-group Description ----------- -Mesh type used internally for collision calculations. +Creates a bounding volume hierarchy (BVH) tree structure around triangle geometry. + +The triangle BVH tree can be used for efficient intersection queries without involving a physics engine. + +For example, this can be used in editor tools to select objects with complex shapes based on the mouse cursor position. + +\ **Performance:** Creating the BVH tree for complex geometry is a slow process and best done in a background thread. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`create_from_faces`\ (\ faces\: :ref:`PackedVector3Array`\ ) | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`get_faces`\ (\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_ray`\ (\ begin\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Dictionary` | :ref:`intersect_segment`\ (\ begin\: :ref:`Vector3`, end\: :ref:`Vector3`\ ) |const| | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_TriangleMesh_method_create_from_faces: + +.. rst-class:: classref-method + +:ref:`bool` **create_from_faces**\ (\ faces\: :ref:`PackedVector3Array`\ ) :ref:`🔗` + +Creates the BVH tree from an array of faces. Each 3 vertices of the input ``faces`` array represent one triangle (face). + +Returns ``true`` if the tree is successfully built, ``false`` otherwise. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TriangleMesh_method_get_faces: + +.. rst-class:: classref-method + +:ref:`PackedVector3Array` **get_faces**\ (\ ) |const| :ref:`🔗` + +Returns a copy of the geometry faces. Each 3 vertices of the array represent one triangle (face). + +.. rst-class:: classref-item-separator + +---- + +.. _class_TriangleMesh_method_intersect_ray: + +.. rst-class:: classref-method + +:ref:`Dictionary` **intersect_ray**\ (\ begin\: :ref:`Vector3`, dir\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +Tests for intersection with a ray starting at ``begin`` and facing ``dir`` and extending toward infinity. + +If an intersection with a triangle happens, returns a :ref:`Dictionary` with the following fields: + +\ ``position``: The position on the intersected triangle. + +\ ``normal``: The normal of the intersected triangle. + +\ ``face_index``: The index of the intersected triangle. + +Returns an empty :ref:`Dictionary` if no intersection happens. + +See also :ref:`intersect_segment()`, which is similar but uses a finite-length segment. + +.. rst-class:: classref-item-separator + +---- + +.. _class_TriangleMesh_method_intersect_segment: + +.. rst-class:: classref-method + +:ref:`Dictionary` **intersect_segment**\ (\ begin\: :ref:`Vector3`, end\: :ref:`Vector3`\ ) |const| :ref:`🔗` + +Tests for intersection with a segment going from ``begin`` to ``end``. + +If an intersection with a triangle happens returns a :ref:`Dictionary` with the following fields: + +\ ``position``: The position on the intersected triangle. + +\ ``normal``: The normal of the intersected triangle. + +\ ``face_index``: The index of the intersected triangle. + +Returns an empty :ref:`Dictionary` if no intersection happens. + +See also :ref:`intersect_ray()`, which is similar but uses an infinite-length ray. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 421cde8915f..6455e4d00f6 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -33,8 +33,8 @@ A tween animation is created by adding :ref:`Tweener`\ s to the * .. code-tab:: gdscript var tween = get_tree().create_tween() - tween.tween_property($Sprite, "modulate", Color.RED, 1) - tween.tween_property($Sprite, "scale", Vector2(), 1) + tween.tween_property($Sprite, "modulate", Color.RED, 1.0) + tween.tween_property($Sprite, "scale", Vector2(), 1.0) tween.tween_callback($Sprite.queue_free) .. code-tab:: csharp @@ -56,8 +56,8 @@ When a :ref:`Tweener` is created with one of the ``tween_*`` meth .. code-tab:: gdscript var tween = get_tree().create_tween() - tween.tween_property($Sprite, "modulate", Color.RED, 1).set_trans(Tween.TRANS_SINE) - tween.tween_property($Sprite, "scale", Vector2(), 1).set_trans(Tween.TRANS_BOUNCE) + tween.tween_property($Sprite, "modulate", Color.RED, 1.0).set_trans(Tween.TRANS_SINE) + tween.tween_property($Sprite, "scale", Vector2(), 1.0).set_trans(Tween.TRANS_BOUNCE) tween.tween_callback($Sprite.queue_free) .. code-tab:: csharp @@ -77,8 +77,8 @@ Most of the **Tween** methods can be chained this way too. In the following exam .. code-tab:: gdscript var tween = get_tree().create_tween().bind_node(self).set_trans(Tween.TRANS_ELASTIC) - tween.tween_property($Sprite, "modulate", Color.RED, 1) - tween.tween_property($Sprite, "scale", Vector2(), 1) + tween.tween_property($Sprite, "modulate", Color.RED, 1.0) + tween.tween_property($Sprite, "scale", Vector2(), 1.0) tween.tween_callback($Sprite.queue_free) .. code-tab:: csharp @@ -99,7 +99,7 @@ Another interesting use for **Tween**\ s is animating arbitrary sets of objects: var tween = create_tween() for sprite in get_children(): - tween.tween_property(sprite, "position", Vector2(0, 0), 1) + tween.tween_property(sprite, "position", Vector2(0, 0), 1.0) .. code-tab:: csharp @@ -852,7 +852,7 @@ Creates and appends a :ref:`CallbackTweener`. This method .. code-tab:: gdscript var tween = get_tree().create_tween().set_loops() - tween.tween_callback(shoot).set_delay(1) + tween.tween_callback(shoot).set_delay(1.0) .. code-tab:: csharp @@ -920,10 +920,10 @@ Creates and appends an :ref:`IntervalTweener`. This metho .. code-tab:: gdscript var tween = create_tween().set_loops() - tween.tween_property($Sprite, "position:x", 200.0, 1).as_relative() + tween.tween_property($Sprite, "position:x", 200.0, 1.0).as_relative() tween.tween_callback(jump) tween.tween_interval(2) - tween.tween_property($Sprite, "position:x", -200.0, 1).as_relative() + tween.tween_property($Sprite, "position:x", -200.0, 1.0).as_relative() tween.tween_callback(jump) tween.tween_interval(2) @@ -959,7 +959,7 @@ Creates and appends a :ref:`MethodTweener`. This method is .. code-tab:: gdscript var tween = create_tween() - tween.tween_method(look_at.bind(Vector3.UP), Vector3(-1, 0, -1), Vector3(1, 0, -1), 1) # The look_at() method takes up vector as second argument. + tween.tween_method(look_at.bind(Vector3.UP), Vector3(-1, 0, -1), Vector3(1, 0, -1), 1.0) # The look_at() method takes up vector as second argument. .. code-tab:: csharp @@ -977,7 +977,7 @@ Creates and appends a :ref:`MethodTweener`. This method is func _ready(): var tween = create_tween() - tween.tween_method(set_label_text, 0, 10, 1).set_delay(1) + tween.tween_method(set_label_text, 0, 10, 1.0).set_delay(1.0) func set_label_text(value: int): $Label.text = "Counting " + str(value) @@ -1017,8 +1017,8 @@ Creates and appends a :ref:`PropertyTweener`. This method .. code-tab:: gdscript var tween = create_tween() - tween.tween_property($Sprite, "position", Vector2(100, 200), 1) - tween.tween_property($Sprite, "position", Vector2(200, 300), 1) + tween.tween_property($Sprite, "position", Vector2(100, 200), 1.0) + tween.tween_property($Sprite, "position", Vector2(200, 300), 1.0) .. code-tab:: csharp @@ -1040,8 +1040,8 @@ will move the sprite to position (100, 200) and then to (200, 300). If you use : .. code-tab:: gdscript var tween = create_tween() - tween.tween_property($Sprite, "position", Vector2.RIGHT * 300, 1).as_relative().set_trans(Tween.TRANS_SINE) - tween.tween_property($Sprite, "position", Vector2.RIGHT * 300, 1).as_relative().from_current().set_trans(Tween.TRANS_EXPO) + tween.tween_property($Sprite, "position", Vector2.RIGHT * 300, 1.0).as_relative().set_trans(Tween.TRANS_SINE) + tween.tween_property($Sprite, "position", Vector2.RIGHT * 300, 1.0).as_relative().from_current().set_trans(Tween.TRANS_EXPO) .. code-tab:: csharp diff --git a/classes/class_udpserver.rst b/classes/class_udpserver.rst index 73f297eb4d9..31636827591 100644 --- a/classes/class_udpserver.rst +++ b/classes/class_udpserver.rst @@ -270,7 +270,7 @@ Starts the server by opening a UDP socket listening on the given ``port``. You c :ref:`Error` **poll**\ (\ ) :ref:`🔗` -Call this method at regular intervals (e.g. inside :ref:`Node._process()`) to process new packets. And packet from known address/port pair will be delivered to the appropriate :ref:`PacketPeerUDP`, any packet received from an unknown address/port pair will be added as a pending connection (see :ref:`is_connection_available()`, :ref:`take_connection()`). The maximum number of pending connection is defined via :ref:`max_pending_connections`. +Call this method at regular intervals (e.g. inside :ref:`Node._process()`) to process new packets. Any packet from a known address/port pair will be delivered to the appropriate :ref:`PacketPeerUDP`, while any packet received from an unknown address/port pair will be added as a pending connection (see :ref:`is_connection_available()` and :ref:`take_connection()`). The maximum number of pending connections is defined via :ref:`max_pending_connections`. .. rst-class:: classref-item-separator diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 27081e5bc39..1949e010ba9 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -205,6 +205,8 @@ Methods +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`gui_get_drag_data`\ (\ ) |const| | +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`gui_get_drag_description`\ (\ ) |const| | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`gui_get_focus_owner`\ (\ ) |const| | +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`gui_get_hovered_control`\ (\ ) |const| | @@ -215,6 +217,8 @@ Methods +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`gui_release_focus`\ (\ ) | +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`gui_set_drag_description`\ (\ description\: :ref:`String`\ ) | + +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_input_handled`\ (\ ) |const| | +-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`notify_mouse_entered`\ (\ ) | @@ -372,7 +376,7 @@ Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be :ref:`Scaling3DMode` **SCALING_3D_MODE_FSR** = ``1`` -Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. .. _class_Viewport_constant_SCALING_3D_MODE_FSR2: @@ -380,7 +384,7 @@ Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. :ref:`Scaling3DMode` **SCALING_3D_MODE_FSR2** = ``2`` -Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. +Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`scaling_3d_scale`. Values less than ``1.0`` will result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution. .. _class_Viewport_constant_SCALING_3D_MODE_METALFX_SPATIAL: @@ -392,7 +396,7 @@ Use the `MetalFX spatial upscaler `. -Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. +Values less than ``1.0`` will result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling. More information: `MetalFX `__. @@ -408,7 +412,7 @@ Use the `MetalFX temporal upscaler `. To determine the minimum input scale, use the :ref:`RenderingDevice.limit_get()` method with :ref:`RenderingDevice.LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE`. -Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution. +Values less than ``1.0`` will result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution. More information: `MetalFX `__. @@ -682,6 +686,8 @@ Objects are displayed without light information. Objects are displayed without textures and only with lighting information. +\ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode. + .. _class_Viewport_constant_DEBUG_DRAW_OVERDRAW: .. rst-class:: classref-enumeration-constant @@ -690,6 +696,8 @@ Objects are displayed without textures and only with lighting information. Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw means you are wasting performance on drawing pixels that are being hidden behind others. +\ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode. + .. _class_Viewport_constant_DEBUG_DRAW_WIREFRAME: .. rst-class:: classref-enumeration-constant @@ -708,13 +716,17 @@ Objects are displayed as wireframe models. Objects are displayed without lighting information and their textures replaced by normal mapping. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_VOXEL_GI_ALBEDO: .. rst-class:: classref-enumeration-constant :ref:`DebugDraw` **DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6`` -Objects are displayed with only the albedo value from :ref:`VoxelGI`\ s. +Objects are displayed with only the albedo value from :ref:`VoxelGI`\ s. Requires at least one visible :ref:`VoxelGI` node that has been baked to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_Viewport_constant_DEBUG_DRAW_VOXEL_GI_LIGHTING: @@ -722,7 +734,9 @@ Objects are displayed with only the albedo value from :ref:`VoxelGI` **DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7`` -Objects are displayed with only the lighting value from :ref:`VoxelGI`\ s. +Objects are displayed with only the lighting value from :ref:`VoxelGI`\ s. Requires at least one visible :ref:`VoxelGI` node that has been baked to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_Viewport_constant_DEBUG_DRAW_VOXEL_GI_EMISSION: @@ -730,7 +744,9 @@ Objects are displayed with only the lighting value from :ref:`VoxelGI` **DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8`` -Objects are displayed with only the emission color from :ref:`VoxelGI`\ s. +Objects are displayed with only the emission color from :ref:`VoxelGI`\ s. Requires at least one visible :ref:`VoxelGI` node that has been baked to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_Viewport_constant_DEBUG_DRAW_SHADOW_ATLAS: @@ -756,6 +772,8 @@ Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D` set in your :ref:`WorldEnvironment`. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_SSIL: .. rst-class:: classref-enumeration-constant @@ -772,13 +792,19 @@ Draws the screen-space ambient occlusion texture instead of the scene so that yo Draws the screen-space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssil_enabled` set in your :ref:`WorldEnvironment`. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_PSSM_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`DebugDraw` **DEBUG_DRAW_PSSM_SPLITS** = ``14`` -Colors each PSSM split for the :ref:`DirectionalLight3D`\ s in the scene a different color so you can see where the splits are. In order, they will be colored red, green, blue, and yellow. +Colors each PSSM split for the :ref:`DirectionalLight3D`\ s in the scene a different color so you can see where the splits are. In order (from closest to furthest from the camera), they are colored red, green, blue, and yellow. + +\ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode. + +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. .. _class_Viewport_constant_DEBUG_DRAW_DECAL_ATLAS: @@ -788,6 +814,8 @@ Colors each PSSM split for the :ref:`DirectionalLight3D`\ s and light projector textures in the upper left quadrant of the **Viewport**. +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. + .. _class_Viewport_constant_DEBUG_DRAW_SDFGI: .. rst-class:: classref-enumeration-constant @@ -796,7 +824,9 @@ Draws the decal atlas used by :ref:`Decal`\ s and light projector t Draws the cascades used to render signed distance field global illumination (SDFGI). -Does nothing if the current environment's :ref:`Environment.sdfgi_enabled` is ``false`` or SDFGI is not supported on the platform. +Does nothing if the current environment's :ref:`Environment.sdfgi_enabled` is ``false``. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_Viewport_constant_DEBUG_DRAW_SDFGI_PROBES: @@ -806,7 +836,9 @@ Does nothing if the current environment's :ref:`Environment.sdfgi_enabled` is ``false`` or SDFGI is not supported on the platform. +Does nothing if the current environment's :ref:`Environment.sdfgi_enabled` is ``false``. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_Viewport_constant_DEBUG_DRAW_GI_BUFFER: @@ -814,7 +846,9 @@ Does nothing if the current environment's :ref:`Environment.sdfgi_enabled` **DEBUG_DRAW_GI_BUFFER** = ``18`` -Draws the buffer used for global illumination (GI). +Draws the buffer used for global illumination from :ref:`VoxelGI` or SDFGI. Requires :ref:`VoxelGI` (at least one visible baked VoxelGI node) or SDFGI (:ref:`Environment.sdfgi_enabled`) to be enabled to have a visible effect. + +\ **Note:** Only supported when using the Forward+ rendering method. .. _class_Viewport_constant_DEBUG_DRAW_DISABLE_LOD: @@ -822,7 +856,7 @@ Draws the buffer used for global illumination (GI). :ref:`DebugDraw` **DEBUG_DRAW_DISABLE_LOD** = ``19`` -Draws all of the objects at their highest polycount, without low level of detail (LOD). +Draws all of the objects at their highest polycount regardless of their distance from the camera. No low level of detail (LOD) is applied. .. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS: @@ -832,6 +866,8 @@ Draws all of the objects at their highest polycount, without low level of detail Draws the cluster used by :ref:`OmniLight3D` nodes to optimize light rendering. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS: .. rst-class:: classref-enumeration-constant @@ -840,6 +876,8 @@ Draws the cluster used by :ref:`OmniLight3D` nodes to optimiz Draws the cluster used by :ref:`SpotLight3D` nodes to optimize light rendering. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_DECALS: .. rst-class:: classref-enumeration-constant @@ -848,6 +886,8 @@ Draws the cluster used by :ref:`SpotLight3D` nodes to optimiz Draws the cluster used by :ref:`Decal` nodes to optimize decal rendering. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES: .. rst-class:: classref-enumeration-constant @@ -856,6 +896,8 @@ Draws the cluster used by :ref:`Decal` nodes to optimize decal rend Draws the cluster used by :ref:`ReflectionProbe` nodes to optimize decal rendering. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_OCCLUDERS: .. rst-class:: classref-enumeration-constant @@ -864,6 +906,8 @@ Draws the cluster used by :ref:`ReflectionProbe` nodes to Draws the buffer used for occlusion culling. +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. + .. _class_Viewport_constant_DEBUG_DRAW_MOTION_VECTORS: .. rst-class:: classref-enumeration-constant @@ -872,13 +916,17 @@ Draws the buffer used for occlusion culling. Draws vector lines over the viewport to indicate the movement of pixels between frames. +\ **Note:** Only supported when using the Forward+ rendering method. + .. _class_Viewport_constant_DEBUG_DRAW_INTERNAL_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`DebugDraw` **DEBUG_DRAW_INTERNAL_BUFFER** = ``26`` -Draws the internal resolution buffer of the scene before post-processing is applied. +Draws the internal resolution buffer of the scene in linear colorspace before tonemapping or post-processing is applied. + +\ **Note:** Only supported when using the Forward+ or Mobile rendering methods. .. rst-class:: classref-item-separator @@ -2284,6 +2332,18 @@ Returns the drag data from the GUI, that was previously returned by :ref:`Contro ---- +.. _class_Viewport_method_gui_get_drag_description: + +.. rst-class:: classref-method + +:ref:`String` **gui_get_drag_description**\ (\ ) |const| :ref:`🔗` + +Returns the drag data human-readable description. + +.. rst-class:: classref-item-separator + +---- + .. _class_Viewport_method_gui_get_focus_owner: .. rst-class:: classref-method @@ -2348,6 +2408,18 @@ Removes the focus from the currently focused :ref:`Control` withi ---- +.. _class_Viewport_method_gui_set_drag_description: + +.. rst-class:: classref-method + +|void| **gui_set_drag_description**\ (\ description\: :ref:`String`\ ) :ref:`🔗` + +Sets the drag data human-readable description. + +.. rst-class:: classref-item-separator + +---- + .. _class_Viewport_method_is_input_handled: .. rst-class:: classref-method diff --git a/classes/class_visibleonscreennotifier2d.rst b/classes/class_visibleonscreennotifier2d.rst index b789caf2362..9feb747b061 100644 --- a/classes/class_visibleonscreennotifier2d.rst +++ b/classes/class_visibleonscreennotifier2d.rst @@ -42,9 +42,11 @@ Properties .. table:: :widths: auto - +---------------------------+------------------------------------------------------------+-----------------------------+ - | :ref:`Rect2` | :ref:`rect` | ``Rect2(-10, -10, 20, 20)`` | - +---------------------------+------------------------------------------------------------+-----------------------------+ + +---------------------------+----------------------------------------------------------------------+-----------------------------+ + | :ref:`Rect2` | :ref:`rect` | ``Rect2(-10, -10, 20, 20)`` | + +---------------------------+----------------------------------------------------------------------+-----------------------------+ + | :ref:`bool` | :ref:`show_rect` | ``true`` | + +---------------------------+----------------------------------------------------------------------+-----------------------------+ .. rst-class:: classref-reftable-group @@ -109,6 +111,23 @@ Property Descriptions The VisibleOnScreenNotifier2D's bounding rectangle. +.. rst-class:: classref-item-separator + +---- + +.. _class_VisibleOnScreenNotifier2D_property_show_rect: + +.. rst-class:: classref-property + +:ref:`bool` **show_rect** = ``true`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_show_rect**\ (\ value\: :ref:`bool`\ ) +- :ref:`bool` **is_showing_rect**\ (\ ) + +If ``true``, shows the rectangle area of :ref:`rect` in the editor with a translucent magenta fill. Unlike changing the visibility of the VisibleOnScreenNotifier2D, this does not affect the screen culling detection. + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_window.rst b/classes/class_window.rst index 79a44792a18..fd5b508c6b4 100644 --- a/classes/class_window.rst +++ b/classes/class_window.rst @@ -66,8 +66,12 @@ Properties +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Vector2i` | :ref:`max_size` | ``Vector2i(0, 0)`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`maximize_disabled` | ``false`` | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Vector2i` | :ref:`min_size` | ``Vector2i(0, 0)`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`minimize_disabled` | ``false`` | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Mode` | :ref:`mode` | ``0`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`mouse_passthrough` | ``false`` | @@ -76,6 +80,8 @@ Properties +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`popup_window` | ``false`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ + | :ref:`bool` | :ref:`popup_wm_hint` | ``false`` | + +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`Vector2i` | :ref:`position` | ``Vector2i(0, 0)`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`sharp_corners` | ``false`` | @@ -138,6 +144,8 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag`\ (\ flag\: :ref:`Flags`\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Window` | :ref:`get_focused_window`\ (\ ) |static| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`LayoutDirection` | :ref:`get_layout_direction`\ (\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`get_position_with_decorations`\ (\ ) |const| | @@ -340,7 +348,7 @@ This signal can be used to handle window closing, e.g. by connecting it to :ref: Emitted when the **Window**'s DPI changes as a result of OS-level changes (e.g. moving the window from a Retina display to a lower resolution one). -\ **Note:** Only implemented on macOS. +\ **Note:** Only implemented on macOS and Linux (Wayland). .. rst-class:: classref-item-separator @@ -669,11 +677,39 @@ Windows is excluded from screenshots taken by :ref:`DisplayServer.screen_get_ima \ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image, it should not be used as a security measure. +.. _class_Window_constant_FLAG_POPUP_WM_HINT: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_POPUP_WM_HINT** = ``10`` + +Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window). + +.. _class_Window_constant_FLAG_MINIMIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_MINIMIZE_DISABLED** = ``11`` + +Window minimize button is disabled. + +\ **Note:** This flag is implemented on macOS and Windows. + +.. _class_Window_constant_FLAG_MAXIMIZE_DISABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`Flags` **FLAG_MAXIMIZE_DISABLED** = ``12`` + +Window maximize button is disabled. + +\ **Note:** This flag is implemented on macOS and Windows. + .. _class_Window_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Flags` **FLAG_MAX** = ``10`` +:ref:`Flags` **FLAG_MAX** = ``13`` Max value of the :ref:`Flags`. @@ -1121,7 +1157,11 @@ The screen the window is currently on. - |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| -Windows is excluded from screenshots taken by :ref:`DisplayServer.screen_get_image()`, :ref:`DisplayServer.screen_get_image_rect()`, and :ref:`DisplayServer.screen_get_pixel()`. +If ``true``, the **Window** is excluded from screenshots taken by :ref:`DisplayServer.screen_get_image()`, :ref:`DisplayServer.screen_get_image_rect()`, and :ref:`DisplayServer.screen_get_pixel()`. + +\ **Note:** This property is implemented on macOS and Windows. + +\ **Note:** Enabling this setting does **NOT** prevent other apps from capturing an image. It should not be used as a security measure. .. rst-class:: classref-item-separator @@ -1237,6 +1277,27 @@ If non-zero, the **Window** can't be resized to be bigger than this size. ---- +.. _class_Window_property_maximize_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **maximize_disabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +If ``true``, the **Window**'s maximize button is disabled. + +\ **Note:** If both minimize and maximize buttons are disabled, buttons are fully hidden, and only close button is visible. + +\ **Note:** This property is implemented only on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_Window_property_min_size: .. rst-class:: classref-property @@ -1256,6 +1317,27 @@ If non-zero, the **Window** can't be resized to be smaller than this size. ---- +.. _class_Window_property_minimize_disabled: + +.. rst-class:: classref-property + +:ref:`bool` **minimize_disabled** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +If ``true``, the **Window**'s minimize button is disabled. + +\ **Note:** If both minimize and maximize buttons are disabled, buttons are fully hidden, and only close button is visible. + +\ **Note:** This property is implemented only on macOS and Windows. + +.. rst-class:: classref-item-separator + +---- + .. _class_Window_property_mode: .. rst-class:: classref-property @@ -1369,6 +1451,23 @@ If ``true``, the **Window** will be considered a popup. Popups are sub-windows t ---- +.. _class_Window_property_popup_wm_hint: + +.. rst-class:: classref-property + +:ref:`bool` **popup_wm_hint** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) +- :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| + +If ``true``, the **Window** will signal to the window manager that it is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window). + +.. rst-class:: classref-item-separator + +---- + .. _class_Window_property_position: .. rst-class:: classref-property @@ -1566,7 +1665,7 @@ If ``true``, the **Window** can't be focused nor interacted with. It can still b - |void| **set_flag**\ (\ flag\: :ref:`Flags`, enabled\: :ref:`bool`\ ) - :ref:`bool` **get_flag**\ (\ flag\: :ref:`Flags`\ ) |const| -If ``true``, the window can't be resized. Minimize and maximize buttons are disabled. +If ``true``, the window can't be resized. .. rst-class:: classref-item-separator @@ -1783,6 +1882,18 @@ Returns ``true`` if the ``flag`` is set. ---- +.. _class_Window_method_get_focused_window: + +.. rst-class:: classref-method + +:ref:`Window` **get_focused_window**\ (\ ) |static| :ref:`🔗` + +Returns the focused window. + +.. rst-class:: classref-item-separator + +---- + .. _class_Window_method_get_layout_direction: .. rst-class:: classref-method @@ -2183,7 +2294,7 @@ Returns ``true`` if the window is currently embedded in another window. :ref:`bool` **is_layout_rtl**\ (\ ) |const| :ref:`🔗` -Returns ``true`` if layout is right-to-left. +Returns ``true`` if the layout is right-to-left. .. rst-class:: classref-item-separator diff --git a/classes/class_xrcamera3d.rst b/classes/class_xrcamera3d.rst index 89a9f5bcaa8..2aa71ecbabc 100644 --- a/classes/class_xrcamera3d.rst +++ b/classes/class_xrcamera3d.rst @@ -30,6 +30,18 @@ Tutorials - :doc:`XR documentation index <../tutorials/xr/index>` +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +---------------------------------------------------------------------+----------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+----------------------------+-------------------------------------------------------------------------------+ + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_xrcontroller3d.rst b/classes/class_xrcontroller3d.rst index da32ece6baa..c9b23308fb7 100644 --- a/classes/class_xrcontroller3d.rst +++ b/classes/class_xrcontroller3d.rst @@ -25,7 +25,7 @@ Controllers are linked by their ID. You can create controller nodes before the c The position of the controller node is automatically updated by the :ref:`XRServer`. This makes this node ideal to add child nodes to visualize the controller. -As many XR runtimes now use a configurable action map all inputs are named. +The current :ref:`XRInterface` defines the names of inputs. In the case of OpenXR, these are the names of actions in the current action set from the OpenXR action map. .. rst-class:: classref-introduction-group @@ -136,6 +136,8 @@ Method Descriptions Returns a numeric value for the input with the given ``name``. This is used for triggers and grip sensors. +\ **Note:** The current :ref:`XRInterface` defines the ``name`` for each input. In the case of OpenXR, these are the names of actions in the current action set. + .. rst-class:: classref-item-separator ---- @@ -148,6 +150,8 @@ Returns a numeric value for the input with the given ``name``. This is used for Returns a :ref:`Variant` for the input with the given ``name``. This works for any input type, the variant will be typed according to the actions configuration. +\ **Note:** The current :ref:`XRInterface` defines the ``name`` for each input. In the case of OpenXR, these are the names of actions in the current action set. + .. rst-class:: classref-item-separator ---- @@ -172,6 +176,8 @@ Returns the hand holding this controller, if known. See :ref:`TrackerHand` for the input with the given ``name``. This is used for thumbsticks and thumbpads found on many controllers. +\ **Note:** The current :ref:`XRInterface` defines the ``name`` for each input. In the case of OpenXR, these are the names of actions in the current action set. + .. rst-class:: classref-item-separator ---- @@ -184,6 +190,8 @@ Returns a :ref:`Vector2` for the input with the given ``name``. T Returns ``true`` if the button with the given ``name`` is pressed. +\ **Note:** The current :ref:`XRInterface` defines the ``name`` for each input. In the case of OpenXR, these are the names of actions in the current action set. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_xrinterface.rst b/classes/class_xrinterface.rst index faad8b998d4..4a2d1ca4c71 100644 --- a/classes/class_xrinterface.rst +++ b/classes/class_xrinterface.rst @@ -292,6 +292,14 @@ Player is free to move around, full positional tracking. Same as :ref:`XR_PLAY_AREA_ROOMSCALE` but origin point is fixed to the center of the physical space. In this mode, system-level recentering may be disabled, requiring the use of :ref:`XRServer.center_on_hmd()`. +.. _class_XRInterface_constant_XR_PLAY_AREA_CUSTOM: + +.. rst-class:: classref-enumeration-constant + +:ref:`PlayAreaMode` **XR_PLAY_AREA_CUSTOM** = ``2147483647`` + +Custom play area set by a GDExtension. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_xrnode3d.rst b/classes/class_xrnode3d.rst index 5a18d706d7b..6cd7f27b106 100644 --- a/classes/class_xrnode3d.rst +++ b/classes/class_xrnode3d.rst @@ -38,13 +38,15 @@ Properties .. table:: :widths: auto - +-------------------------------------+---------------------------------------------------------------------+----------------+ - | :ref:`StringName` | :ref:`pose` | ``&"default"`` | - +-------------------------------------+---------------------------------------------------------------------+----------------+ - | :ref:`bool` | :ref:`show_when_tracked` | ``false`` | - +-------------------------------------+---------------------------------------------------------------------+----------------+ - | :ref:`StringName` | :ref:`tracker` | ``&""`` | - +-------------------------------------+---------------------------------------------------------------------+----------------+ + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`PhysicsInterpolationMode` | physics_interpolation_mode | ``2`` (overrides :ref:`Node`) | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`pose` | ``&"default"`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`show_when_tracked` | ``false`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + | :ref:`StringName` | :ref:`tracker` | ``&""`` | + +---------------------------------------------------------------------+---------------------------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group diff --git a/classes/index.rst b/classes/index.rst index aa4e6f42147..76dae223123 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -105,6 +105,7 @@ Nodes class_filesystemdock class_flowcontainer class_fogvolume + class_foldablecontainer class_generic6dofjoint3d class_geometryinstance3d class_gpuparticles2d @@ -417,6 +418,7 @@ Resources class_fbxdocument class_fbxstate class_fogmaterial + class_foldablegroup class_font class_fontfile class_fontvariation @@ -842,7 +844,10 @@ Other objects class_offlinemultiplayerpeer class_oggpacketsequenceplayback class_openxrapiextension + class_openxrextensionwrapper class_openxrextensionwrapperextension + class_openxrfutureextension + class_openxrfutureresult class_openxrinteractionprofilemetadata class_openxrinterface class_os