From 8028db9f2e6fe849ae8d0644aec921556a060c3c Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 19 Aug 2023 03:18:29 +0000 Subject: [PATCH] classref: Sync with current master branch (b51ee8b) --- classes/class_audioserver.rst | 4 +- classes/class_audiostreamrandomizer.rst | 8 +- classes/class_backbuffercopy.rst | 4 +- classes/class_basematerial3d.rst | 6 +- classes/class_callable.rst | 2 +- classes/class_compressedcubemap.rst | 2 +- classes/class_compressedcubemaparray.rst | 2 +- classes/class_cpuparticles2d.rst | 2 +- classes/class_cpuparticles3d.rst | 2 +- classes/class_csgmesh3d.rst | 4 +- classes/class_cubemap.rst | 2 +- classes/class_cubemaparray.rst | 10 +- classes/class_curve.rst | 4 +- classes/class_curvetexture.rst | 4 +- classes/class_curvexyztexture.rst | 4 +- classes/class_displayserver.rst | 6 +- classes/class_editorexportplatformandroid.rst | 16 ++ classes/class_editorsettings.rst | 64 +++++ classes/class_fastnoiselite.rst | 6 +- classes/class_fogmaterial.rst | 2 +- classes/class_fogvolume.rst | 2 +- classes/class_geometry3d.rst | 14 + classes/class_gltfphysicsbody.rst | 21 +- classes/class_gpuparticles2d.rst | 4 +- classes/class_gpuparticles3d.rst | 2 +- classes/class_gpuparticlesattractor3d.rst | 4 +- classes/class_gpuparticlesattractorbox3d.rst | 6 +- .../class_gpuparticlesattractorsphere3d.rst | 6 +- ...ass_gpuparticlesattractorvectorfield3d.rst | 6 +- classes/class_gpuparticlescollision3d.rst | 4 +- classes/class_gpuparticlescollisionbox3d.rst | 6 +- ...ass_gpuparticlescollisionheightfield3d.rst | 6 +- classes/class_gpuparticlescollisionsdf3d.rst | 4 +- .../class_gpuparticlescollisionsphere3d.rst | 6 +- classes/class_gradient.rst | 8 +- classes/class_gradienttexture1d.rst | 6 +- classes/class_gradienttexture2d.rst | 4 +- classes/class_inputeventwithmodifiers.rst | 4 +- classes/class_int.rst | 2 +- classes/class_lineedit.rst | 4 +- classes/class_material.rst | 4 +- classes/class_navigationserver3d.rst | 14 + classes/class_node.rst | 8 +- classes/class_node3d.rst | 19 ++ classes/class_noise.rst | 2 +- classes/class_noisetexture2d.rst | 4 +- classes/class_noisetexture3d.rst | 4 +- classes/class_optionbutton.rst | 14 + classes/class_ormmaterial3d.rst | 2 +- classes/class_os.rst | 2 +- classes/class_panoramaskymaterial.rst | 4 +- classes/class_particleprocessmaterial.rst | 8 +- classes/class_physicalskymaterial.rst | 2 +- classes/class_placeholdercubemap.rst | 10 +- classes/class_placeholdercubemaparray.rst | 10 +- classes/class_popupmenu.rst | 258 +++++++++--------- classes/class_proceduralskymaterial.rst | 8 +- classes/class_projectsettings.rst | 36 ++- classes/class_renderingserver.rst | 2 + classes/class_scenetree.rst | 2 + classes/class_shaderglobalsoverride.rst | 9 +- classes/class_shadermaterial.rst | 8 +- classes/class_sky.rst | 4 +- classes/class_standardmaterial3d.rst | 2 +- classes/class_string.rst | 14 + classes/class_stringname.rst | 14 + classes/class_textedit.rst | 4 +- classes/class_textserver.rst | 79 +++++- classes/class_textserverextension.rst | 80 ++++++ classes/class_tree.rst | 14 + classes/class_viewport.rst | 16 ++ classes/class_visualshader.rst | 9 +- classes/class_visualshadernode.rst | 6 +- classes/class_visualshadernodeif.rst | 4 +- classes/class_xmlparser.rst | 2 +- classes/class_zipreader.rst | 34 ++- 76 files changed, 721 insertions(+), 264 deletions(-) diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index d363bb6cef5..c794da4b515 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -488,7 +488,9 @@ Returns the names of all audio output devices detected on the system. :ref:`float` **get_output_latency** **(** **)** |const| -Returns the audio driver's output latency. This can be expensive, it is not recommended to call this every frame. +Returns the audio driver's effective output latency. This is based on :ref:`ProjectSettings.audio/driver/output_latency`, but the exact returned value will differ depending on the operating system and audio driver. + +\ **Note:** This can be expensive; it is not recommended to call :ref:`get_output_latency` every frame. .. rst-class:: classref-item-separator diff --git a/classes/class_audiostreamrandomizer.rst b/classes/class_audiostreamrandomizer.rst index 7b6df38cf6b..ce7fd5717df 100644 --- a/classes/class_audiostreamrandomizer.rst +++ b/classes/class_audiostreamrandomizer.rst @@ -32,9 +32,9 @@ Properties +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ | :ref:`PlaybackMode` | :ref:`playback_mode` | ``0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`random_pitch` | ``1.1`` | + | :ref:`float` | :ref:`random_pitch` | ``1.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ - | :ref:`float` | :ref:`random_volume_offset_db` | ``5.0`` | + | :ref:`float` | :ref:`random_volume_offset_db` | ``0.0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ | :ref:`int` | :ref:`streams_count` | ``0`` | +--------------------------------------------------------------+----------------------------------------------------------------------------------------------+---------+ @@ -132,7 +132,7 @@ Controls how this AudioStreamRandomizer picks which AudioStream to play next. .. rst-class:: classref-property -:ref:`float` **random_pitch** = ``1.1`` +:ref:`float` **random_pitch** = ``1.0`` .. rst-class:: classref-property-setget @@ -149,7 +149,7 @@ The intensity of random pitch variation. A value of 1 means no variation. .. rst-class:: classref-property -:ref:`float` **random_volume_offset_db** = ``5.0`` +:ref:`float` **random_volume_offset_db** = ``0.0`` .. rst-class:: classref-property-setget diff --git a/classes/class_backbuffercopy.rst b/classes/class_backbuffercopy.rst index 0869c24e121..f16b2ff9fc8 100644 --- a/classes/class_backbuffercopy.rst +++ b/classes/class_backbuffercopy.rst @@ -12,14 +12,14 @@ BackBufferCopy **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -Copies a region of the screen (or the whole screen) to a buffer so it can be accessed in your shader scripts using the screen texture (i.e. a uniform sampler with ``hint_screen_texture``). +A node that copies a region of the screen to a buffer for access in shader code. .. rst-class:: classref-introduction-group Description ----------- -Node for back-buffering the currently-displayed screen. The region defined in the **BackBufferCopy** node is buffered with the content of the screen it covers, or the entire screen according to the copy mode set. Use the screen texture in your shader scripts to access the buffer. +Node for back-buffering the currently-displayed screen. The region defined in the **BackBufferCopy** node is buffered with the content of the screen it covers, or the entire screen according to the :ref:`copy_mode`. It can be accessed in shader scripts using the screen texture (i.e. a uniform sampler with ``hint_screen_texture``). \ **Note:** Since this node inherits from :ref:`Node2D` (and not :ref:`Control`), anchors and margins won't apply to child :ref:`Control`-derived nodes. This can be problematic when resizing the window. To avoid this, add :ref:`Control`-derived nodes as *siblings* to the **BackBufferCopy** node instead of adding them as children. diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index eac456d8490..65637bef9af 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -14,21 +14,21 @@ BaseMaterial3D **Inherited By:** :ref:`ORMMaterial3D`, :ref:`StandardMaterial3D` -Default 3D rendering material. +Abstract base class for defining the 3D rendering properties of meshes. .. rst-class:: classref-introduction-group Description ----------- -This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details. +This class serves as a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details. .. rst-class:: classref-introduction-group Tutorials --------- -- :doc:`Standard Material 3D <../tutorials/3d/standard_material_3d>` +- :doc:`Standard Material 3D and ORM Material 3D <../tutorials/3d/standard_material_3d>` .. rst-class:: classref-reftable-group diff --git a/classes/class_callable.rst b/classes/class_callable.rst index 7be19b5c9c3..2014cbe6e9d 100644 --- a/classes/class_callable.rst +++ b/classes/class_callable.rst @@ -308,7 +308,7 @@ Returns the total amount of arguments bound (or unbound) via successive :ref:`bi :ref:`StringName` **get_method** **(** **)** |const| -Returns the name of the method represented by this **Callable**. If the callable is a lambda function, returns the function's name. +Returns the name of the method represented by this **Callable**. If the callable is a GDScript lambda function, returns the function's name or ``""``. .. rst-class:: classref-item-separator diff --git a/classes/class_compressedcubemap.rst b/classes/class_compressedcubemap.rst index 601cb66e8fc..4a26c7050a0 100644 --- a/classes/class_compressedcubemap.rst +++ b/classes/class_compressedcubemap.rst @@ -12,7 +12,7 @@ CompressedCubemap **Inherits:** :ref:`CompressedTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -6-sided texture typically used in 3D rendering, optionally compressed. +An optionally compressed :ref:`Cubemap`. .. rst-class:: classref-introduction-group diff --git a/classes/class_compressedcubemaparray.rst b/classes/class_compressedcubemaparray.rst index bcc46bb9ed8..4a286e4ea13 100644 --- a/classes/class_compressedcubemaparray.rst +++ b/classes/class_compressedcubemaparray.rst @@ -12,7 +12,7 @@ CompressedCubemapArray **Inherits:** :ref:`CompressedTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Array of 6-sided textures typically used in 3D rendering, optionally compressed. +An optionally compressed :ref:`CubemapArray`. .. rst-class:: classref-introduction-group diff --git a/classes/class_cpuparticles2d.rst b/classes/class_cpuparticles2d.rst index 8617468a2c9..3dc97523b6c 100644 --- a/classes/class_cpuparticles2d.rst +++ b/classes/class_cpuparticles2d.rst @@ -12,7 +12,7 @@ CPUParticles2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -CPU-based 2D particle emitter. +A CPU-based 2D particle emitter. .. rst-class:: classref-introduction-group diff --git a/classes/class_cpuparticles3d.rst b/classes/class_cpuparticles3d.rst index 225b28e148c..e8febcbd4fb 100644 --- a/classes/class_cpuparticles3d.rst +++ b/classes/class_cpuparticles3d.rst @@ -12,7 +12,7 @@ CPUParticles3D **Inherits:** :ref:`GeometryInstance3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -CPU-based 3D particle emitter. +A CPU-based 3D particle emitter. .. rst-class:: classref-introduction-group diff --git a/classes/class_csgmesh3d.rst b/classes/class_csgmesh3d.rst index fe5eb86b0a6..b44bf5c4f8c 100644 --- a/classes/class_csgmesh3d.rst +++ b/classes/class_csgmesh3d.rst @@ -83,7 +83,9 @@ The :ref:`Material` used in drawing the CSG shape. The :ref:`Mesh` resource to use as a CSG shape. -\ **Note:** When using an :ref:`ArrayMesh`, avoid meshes with vertex normals unless a flat shader is required. By default, CSGMesh will ignore the mesh's vertex normals and use a smooth shader calculated using the faces' normals. If a flat shader is required, ensure that all faces' vertex normals are parallel. +\ **Note:** When using an :ref:`ArrayMesh`, all vertex attributes except :ref:`Mesh.ARRAY_VERTEX`, :ref:`Mesh.ARRAY_NORMAL` and :ref:`Mesh.ARRAY_TEX_UV` are left unused. Only :ref:`Mesh.ARRAY_VERTEX` and :ref:`Mesh.ARRAY_TEX_UV` will be passed to the GPU. + +\ :ref:`Mesh.ARRAY_NORMAL` is only used to determine which faces require the use of flat shading. By default, CSGMesh will ignore the mesh's vertex normals, recalculate them for each vertex and use a smooth shader. If a flat shader is required for a face, ensure that all vertex normals of the face are approximately equal. .. |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_cubemap.rst b/classes/class_cubemap.rst index bd2d494bff6..3aea299aa86 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -12,7 +12,7 @@ Cubemap **Inherits:** :ref:`ImageTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -6-sided texture typically used in 3D rendering. +Six square textures representing the faces of a cube. Commonly used as a skybox. .. rst-class:: classref-introduction-group diff --git a/classes/class_cubemaparray.rst b/classes/class_cubemaparray.rst index a830f88800a..e9b4976c99c 100644 --- a/classes/class_cubemaparray.rst +++ b/classes/class_cubemaparray.rst @@ -12,20 +12,20 @@ CubemapArray **Inherits:** :ref:`ImageTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A single composite texture resource which consists of multiple :ref:`Cubemap`\ s. +An array of :ref:`Cubemap`\ s, stored together and with a single reference. .. rst-class:: classref-introduction-group Description ----------- -**CubemapArray**\ s are made of an array of :ref:`Cubemap`\ s. Accordingly, like :ref:`Cubemap`\ s they are made of multiple textures the amount of which must be divisible by 6 (one image for each face of the cube). The primary benefit of **CubemapArray**\ s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple :ref:`Cubemap`\ s into a shader using a single **CubemapArray**. +**CubemapArray**\ s are made of an array of :ref:`Cubemap`\ s. Like :ref:`Cubemap`\ s, they are made of multiple textures, the amount of which must be divisible by 6 (one for each face of the cube). The primary benefit of **CubemapArray**\ s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple :ref:`Cubemap`\ s into a shader using a single **CubemapArray**. -Generally, **CubemapArray**\ s provide a more efficient way for storing multiple :ref:`Cubemap`\ s compared to storing multiple :ref:`Cubemap`\ s themselves in an array. +Moreover, :ref:`Cubemap`\ s are allocated in adjacent cache regions on the GPU. This makes **CubemapArray**\ s the most efficient way to store multiple :ref:`Cubemap`\ s. -Internally, Godot uses **CubemapArray**\ s for many effects including the :ref:`Sky`, if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections` to ``true``. +Internally, Godot uses **CubemapArray**\ s for many effects, including the :ref:`Sky` if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections` to ``true``. -To create such a texture file yourself, reimport your image files using the Godot Editor import presets. +To create such a texture file yourself, reimport your image files using the import presets of the File System dock. \ **Note:** **CubemapArray** is not supported in the OpenGL 3 rendering backend. diff --git a/classes/class_curve.rst b/classes/class_curve.rst index 871ecf2b71c..093e0056cae 100644 --- a/classes/class_curve.rst +++ b/classes/class_curve.rst @@ -12,14 +12,14 @@ Curve **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A mathematic curve. +A mathematical curve. .. rst-class:: classref-introduction-group Description ----------- -A curve that can be saved and re-used for other objects. By default, it ranges between ``0`` and ``1`` on the Y axis and positions points relative to the ``0.5`` Y position. +This resource describes a mathematical curve by defining a set of points and tangents at each point. By default, it ranges between ``0`` and ``1`` on the Y axis and positions points relative to the ``0.5`` Y position. See also :ref:`Gradient` which is designed for color interpolation. See also :ref:`Curve2D` and :ref:`Curve3D`. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 860c3beddd9..26c7b161189 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -12,14 +12,14 @@ CurveTexture **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A texture that shows a curve. +A 1D texture where pixel brightness corresponds to points on a curve. .. rst-class:: classref-introduction-group Description ----------- -Renders a given :ref:`Curve` provided to it. Simplifies the task of drawing curves and/or saving them as image files. +A 1D texture where pixel brightness corresponds to points on a :ref:`Curve` resource, either in grayscale or in red. This visual representation simplifies the task of saving curves as image files. If you need to store up to 3 curves within a single texture, use :ref:`CurveXYZTexture` instead. See also :ref:`GradientTexture1D` and :ref:`GradientTexture2D`. diff --git a/classes/class_curvexyztexture.rst b/classes/class_curvexyztexture.rst index 87dd7252009..7f10d55d6f6 100644 --- a/classes/class_curvexyztexture.rst +++ b/classes/class_curvexyztexture.rst @@ -12,14 +12,14 @@ CurveXYZTexture **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A texture that shows 3 different curves (stored on the red, green and blue color channels). +A 1D texture where the red, green, and blue color channels correspond to points on 3 curves. .. rst-class:: classref-introduction-group Description ----------- -Renders 3 given :ref:`Curve`\ s provided to it, on the red, green and blue channels respectively. Compared to using separate :ref:`CurveTexture`\ s, this further simplifies the task of drawing curves and/or saving them as image files. +A 1D texture where the red, green, and blue color channels correspond to points on 3 :ref:`Curve` resources. Compared to using separate :ref:`CurveTexture`\ s, this further simplifies the task of saving curves as image files. If you only need to store one curve within a single texture, use :ref:`CurveTexture` instead. See also :ref:`GradientTexture1D` and :ref:`GradientTexture2D`. diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index c80602114f8..506f7e13318 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -1576,7 +1576,11 @@ Callbacks have the following arguments: ``bool status, PackedStringArray selecte \ **Note:** This method is implemented if the display server has the ``FEATURE_NATIVE_DIALOG`` feature. -\ **Note:** This method is implemented on Windows and macOS. +\ **Note:** This method is implemented on Linux, Windows and macOS. + +\ **Note:** ``current_directory`` might be ignored. + +\ **Note:** On Linux, ``show_hidden`` is ignored. \ **Note:** On macOS, native file dialogs have no title. diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index f9cefe664a1..43466fc9b6e 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -92,6 +92,8 @@ Properties +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`package/show_in_android_tv` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`package/show_in_app_library` | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`package/signed` | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`package/unique_name` | @@ -798,6 +800,20 @@ If ``true``, this app will show in Android TV launcher UI. ---- +.. _class_EditorExportPlatformAndroid_property_package/show_in_app_library: + +.. rst-class:: classref-property + +:ref:`bool` **package/show_in_app_library** + +If ``true``, this app will show in the device's app library. + +\ **Note:** This is ``true`` by default. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlatformAndroid_property_package/signed: .. rst-class:: classref-property diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 9359b43a0d7..6ad4960b064 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -239,6 +239,14 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`filesystem/file_dialog/thumbnail_size` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/import/blender/blender3_path` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`filesystem/import/blender/rpc_port` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`filesystem/import/blender/rpc_server_uptime` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/import/fbx/fbx2gltf_path` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/on_save/compress_binary_resources` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | @@ -1771,6 +1779,62 @@ The thumbnail size to use in the editor's file dialogs (in pixels). See also :re ---- +.. _class_EditorSettings_property_filesystem/import/blender/blender3_path: + +.. rst-class:: classref-property + +:ref:`String` **filesystem/import/blender/blender3_path** + +The path to the directory containing the Blender executable used for converting the Blender 3D scene files ``.blend`` to glTF 2.0 format during import. Blender 3.0 or later is required. + +To enable this feature for your specific project, use :ref:`ProjectSettings.filesystem/import/blender/enabled`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_filesystem/import/blender/rpc_port: + +.. rst-class:: classref-property + +:ref:`int` **filesystem/import/blender/rpc_port** + +The port number used for Remote Procedure Call (RPC) communication with Godot's created process of the blender executable. + +Setting this to 0 effectively disables communication with Godot and the blender process, making performance slower. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_filesystem/import/blender/rpc_server_uptime: + +.. rst-class:: classref-property + +:ref:`float` **filesystem/import/blender/rpc_server_uptime** + +The maximum idle uptime (in seconds) of the Blender process. + +This prevents Godot from having to create a new process for each import within the given seconds. + +.. rst-class:: classref-item-separator + +---- + +.. _class_EditorSettings_property_filesystem/import/fbx/fbx2gltf_path: + +.. rst-class:: classref-property + +:ref:`String` **filesystem/import/fbx/fbx2gltf_path** + +The path to the FBX2glTF executable used for converting Autodesk FBX 3D scene files ``.fbx`` to glTF 2.0 format during import. + +To enable this feature for your specific project, use :ref:`ProjectSettings.filesystem/import/fbx/enabled`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_filesystem/on_save/compress_binary_resources: .. rst-class:: classref-property diff --git a/classes/class_fastnoiselite.rst b/classes/class_fastnoiselite.rst index 90416f42aa7..6a85375f3fe 100644 --- a/classes/class_fastnoiselite.rst +++ b/classes/class_fastnoiselite.rst @@ -21,7 +21,7 @@ Description This class generates noise using the FastNoiseLite library, which is a collection of several noise algorithms including Cellular, Perlin, Value, and more. -Most generated noise values are in the range of ``[-1,1]``, however not always. Some of the cellular noise algorithms return results above ``1``. +Most generated noise values are in the range of ``[-1, 1]``, but not always. Some of the cellular noise algorithms return results above ``1``. .. rst-class:: classref-reftable-group @@ -34,7 +34,7 @@ Properties +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`CellularDistanceFunction` | :ref:`cellular_distance_function` | ``0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ - | :ref:`float` | :ref:`cellular_jitter` | ``0.45`` | + | :ref:`float` | :ref:`cellular_jitter` | ``1.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`CellularReturnType` | :ref:`cellular_return_type` | ``1`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ @@ -388,7 +388,7 @@ Determines how the distance to the nearest/second-nearest point is computed. See .. rst-class:: classref-property -:ref:`float` **cellular_jitter** = ``0.45`` +:ref:`float` **cellular_jitter** = ``1.0`` .. rst-class:: classref-property-setget diff --git a/classes/class_fogmaterial.rst b/classes/class_fogmaterial.rst index cc31a781e83..973c1840f91 100644 --- a/classes/class_fogmaterial.rst +++ b/classes/class_fogmaterial.rst @@ -12,7 +12,7 @@ FogMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -:ref:`Material` used with a :ref:`FogVolume` to draw things with the volumetric fog effect. +A material that controls how volumetric fog is rendered, to be assigned to a :ref:`FogVolume`. .. rst-class:: classref-introduction-group diff --git a/classes/class_fogvolume.rst b/classes/class_fogvolume.rst index 768fd3e637e..2c520bb3050 100644 --- a/classes/class_fogvolume.rst +++ b/classes/class_fogvolume.rst @@ -12,7 +12,7 @@ FogVolume **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -A node used to add local fog with the volumetric fog effect. +A region that contributes to the default volumetric fog from the world environment. .. rst-class:: classref-introduction-group diff --git a/classes/class_geometry3d.rst b/classes/class_geometry3d.rst index 35bf6bb3676..9c9e3442758 100644 --- a/classes/class_geometry3d.rst +++ b/classes/class_geometry3d.rst @@ -38,6 +38,8 @@ Methods +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`clip_polygon` **(** :ref:`PackedVector3Array` points, :ref:`Plane` plane **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedVector3Array` | :ref:`compute_convex_mesh_points` **(** :ref:`Plane[]` planes **)** | + +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_closest_point_to_segment` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_closest_point_to_segment_uncapped` **(** :ref:`Vector3` point, :ref:`Vector3` s1, :ref:`Vector3` s2 **)** | @@ -114,6 +116,18 @@ Clips the polygon defined by the points in ``points`` against the ``plane`` and ---- +.. _class_Geometry3D_method_compute_convex_mesh_points: + +.. rst-class:: classref-method + +:ref:`PackedVector3Array` **compute_convex_mesh_points** **(** :ref:`Plane[]` planes **)** + +Calculates and returns all the vertex points of a convex shape defined by an array of ``planes``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Geometry3D_method_get_closest_point_to_segment: .. rst-class:: classref-method diff --git a/classes/class_gltfphysicsbody.rst b/classes/class_gltfphysicsbody.rst index 750467d00a3..51d8937dd8a 100644 --- a/classes/class_gltfphysicsbody.rst +++ b/classes/class_gltfphysicsbody.rst @@ -41,6 +41,8 @@ Properties +-------------------------------+--------------------------------------------------------------------------+--------------------------------------+ | :ref:`String` | :ref:`body_type` | ``"static"`` | +-------------------------------+--------------------------------------------------------------------------+--------------------------------------+ + | :ref:`Vector3` | :ref:`center_of_mass` | ``Vector3(0, 0, 0)`` | + +-------------------------------+--------------------------------------------------------------------------+--------------------------------------+ | :ref:`Basis` | :ref:`inertia_tensor` | ``Basis(0, 0, 0, 0, 0, 0, 0, 0, 0)`` | +-------------------------------+--------------------------------------------------------------------------+--------------------------------------+ | :ref:`Vector3` | :ref:`linear_velocity` | ``Vector3(0, 0, 0)`` | @@ -103,7 +105,24 @@ The angular velocity of the physics body, in radians per second. This is only us - void **set_body_type** **(** :ref:`String` value **)** - :ref:`String` **get_body_type** **(** **)** -The type of the body. Valid values are "static", "kinematic", "character", "rigid", "vehicle", and "trigger". +The type of the body. When importing, this controls what type of :ref:`CollisionObject3D` node Godot should generate. Valid values are "static", "kinematic", "character", "rigid", "vehicle", and "trigger". + +.. rst-class:: classref-item-separator + +---- + +.. _class_GLTFPhysicsBody_property_center_of_mass: + +.. rst-class:: classref-property + +:ref:`Vector3` **center_of_mass** = ``Vector3(0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_center_of_mass** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_center_of_mass** **(** **)** + +The center of mass of the body, in meters. This is in local space relative to the body. By default, the center of the mass is the body's origin. .. rst-class:: classref-item-separator diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index c3228076e0f..e9cb36c87a3 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -12,7 +12,7 @@ GPUParticles2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -2D particle emitter. +A 2D particle emitter. .. rst-class:: classref-introduction-group @@ -23,7 +23,7 @@ Description Use the :ref:`process_material` property to add a :ref:`ParticleProcessMaterial` to configure particle appearance and behavior. Alternatively, you can add a :ref:`ShaderMaterial` which will be applied to all particles. -2D particles can optionally collide with :ref:`LightOccluder2D` nodes (note: they don't collide with :ref:`PhysicsBody2D` nodes). +2D particles can optionally collide with :ref:`LightOccluder2D`, but they don't collide with :ref:`PhysicsBody2D` nodes. .. rst-class:: classref-introduction-group diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index af0f09cd16b..365870c2e5d 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -12,7 +12,7 @@ GPUParticles3D **Inherits:** :ref:`GeometryInstance3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -3D particle emitter. +A 3D particle emitter. .. rst-class:: classref-introduction-group diff --git a/classes/class_gpuparticlesattractor3d.rst b/classes/class_gpuparticlesattractor3d.rst index ac82e9798d2..9a71165c7d4 100644 --- a/classes/class_gpuparticlesattractor3d.rst +++ b/classes/class_gpuparticlesattractor3d.rst @@ -14,7 +14,7 @@ GPUParticlesAttractor3D **Inherited By:** :ref:`GPUParticlesAttractorBox3D`, :ref:`GPUParticlesAttractorSphere3D`, :ref:`GPUParticlesAttractorVectorField3D` -Abstract class for 3D particle attractors affecting :ref:`GPUParticles3D` nodes. +Abstract base class for 3D particle attractors. .. rst-class:: classref-introduction-group @@ -124,7 +124,7 @@ Adjusts how directional the attractor is. At ``0.0``, the attractor is not direc - void **set_strength** **(** :ref:`float` value **)** - :ref:`float` **get_strength** **(** **)** -If :ref:`strength` is negative, particles will be pushed in the reverse direction. Particles will be pushed *away* from the attractor's origin if :ref:`directionality` is ``0.0``, or towards local +Z if :ref:`directionality` is greater than ``0.0``. +Adjusts the strength of the attractor. If :ref:`strength` is negative, particles will be pushed in the opposite direction. Particles will be pushed *away* from the attractor's origin if :ref:`directionality` is ``0.0``, or towards local +Z if :ref:`directionality` is greater than ``0.0``. .. |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_gpuparticlesattractorbox3d.rst b/classes/class_gpuparticlesattractorbox3d.rst index 4529f82f8ae..4aa9e1464ae 100644 --- a/classes/class_gpuparticlesattractorbox3d.rst +++ b/classes/class_gpuparticlesattractorbox3d.rst @@ -12,14 +12,16 @@ GPUParticlesAttractorBox3D **Inherits:** :ref:`GPUParticlesAttractor3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Box-shaped 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A box-shaped attractor that influences particles from :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Box-shaped 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A box-shaped attractor that influences particles from :ref:`GPUParticles3D` nodes. Can be used to attract particles towards its origin, or to push them away from its origin. + +Particle attractors work in real-time and can be moved, rotated and scaled during gameplay. Unlike collision shapes, non-uniform scaling of attractors is also supported. \ **Note:** Particle attractors only affect :ref:`GPUParticles3D`, not :ref:`CPUParticles3D`. diff --git a/classes/class_gpuparticlesattractorsphere3d.rst b/classes/class_gpuparticlesattractorsphere3d.rst index e9a8371e17d..23f73482502 100644 --- a/classes/class_gpuparticlesattractorsphere3d.rst +++ b/classes/class_gpuparticlesattractorsphere3d.rst @@ -12,14 +12,16 @@ GPUParticlesAttractorSphere3D **Inherits:** :ref:`GPUParticlesAttractor3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Ellipse-shaped 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A spheroid-shaped attractor that influences particles from :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Ellipse-shaped 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A spheroid-shaped attractor that influences particles from :ref:`GPUParticles3D` nodes. Can be used to attract particles towards its origin, or to push them away from its origin. + +Particle attractors work in real-time and can be moved, rotated and scaled during gameplay. Unlike collision shapes, non-uniform scaling of attractors is also supported. \ **Note:** Particle attractors only affect :ref:`GPUParticles3D`, not :ref:`CPUParticles3D`. diff --git a/classes/class_gpuparticlesattractorvectorfield3d.rst b/classes/class_gpuparticlesattractorvectorfield3d.rst index 139881f005f..09e9ac4772d 100644 --- a/classes/class_gpuparticlesattractorvectorfield3d.rst +++ b/classes/class_gpuparticlesattractorvectorfield3d.rst @@ -12,17 +12,19 @@ GPUParticlesAttractorVectorField3D **Inherits:** :ref:`GPUParticlesAttractor3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Box-shaped 3D particle attractor with strength varying within the box, affecting :ref:`GPUParticles3D` nodes. +A box-shaped attractor with varying directions and strengths defined in it that influences particles from :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Box-shaped 3D particle attractor with strength varying within the box, affecting :ref:`GPUParticles3D` nodes. +A box-shaped attractor with varying directions and strengths defined in it that influences particles from :ref:`GPUParticles3D` nodes. Unlike :ref:`GPUParticlesAttractorBox3D`, **GPUParticlesAttractorVectorField3D** uses a :ref:`texture` to affect attraction strength within the box. This can be used to create complex attraction scenarios where particles travel in different directions depending on their location. This can be useful for weather effects such as sandstorms. +Particle attractors work in real-time and can be moved, rotated and scaled during gameplay. Unlike collision shapes, non-uniform scaling of attractors is also supported. + \ **Note:** Particle attractors only affect :ref:`GPUParticles3D`, not :ref:`CPUParticles3D`. .. rst-class:: classref-reftable-group diff --git a/classes/class_gpuparticlescollision3d.rst b/classes/class_gpuparticlescollision3d.rst index 557c015955c..10336abf6c2 100644 --- a/classes/class_gpuparticlescollision3d.rst +++ b/classes/class_gpuparticlescollision3d.rst @@ -14,7 +14,7 @@ GPUParticlesCollision3D **Inherited By:** :ref:`GPUParticlesCollisionBox3D`, :ref:`GPUParticlesCollisionHeightField3D`, :ref:`GPUParticlesCollisionSDF3D`, :ref:`GPUParticlesCollisionSphere3D` -Abstract class for 3D particle collision shapes affecting :ref:`GPUParticles3D` nodes. +Abstract base class for 3D particle collision shapes affecting :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group @@ -23,7 +23,7 @@ Description Particle collision shapes can be used to make particles stop or bounce against them. -Particle collision shapes in real-time and can be moved, rotated and scaled during gameplay. Unlike attractors, non-uniform scaling of collision shapes is *not* supported. +Particle collision shapes work in real-time and can be moved, rotated and scaled during gameplay. Unlike attractors, non-uniform scaling of collision shapes is *not* supported. Particle collision shapes can be temporarily disabled by hiding them. diff --git a/classes/class_gpuparticlescollisionbox3d.rst b/classes/class_gpuparticlescollisionbox3d.rst index c0624ea0887..f9edbd50f2d 100644 --- a/classes/class_gpuparticlescollisionbox3d.rst +++ b/classes/class_gpuparticlescollisionbox3d.rst @@ -12,14 +12,16 @@ GPUParticlesCollisionBox3D **Inherits:** :ref:`GPUParticlesCollision3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. +A box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. +A box-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. + +Particle collision shapes work in real-time and can be moved, rotated and scaled during gameplay. Unlike attractors, non-uniform scaling of collision shapes is *not* supported. \ **Note:** :ref:`ParticleProcessMaterial.collision_mode` must be :ref:`ParticleProcessMaterial.COLLISION_RIGID` or :ref:`ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT` on the :ref:`GPUParticles3D`'s process material for collision to work. diff --git a/classes/class_gpuparticlescollisionheightfield3d.rst b/classes/class_gpuparticlescollisionheightfield3d.rst index 8722f06c541..6ad59791f6a 100644 --- a/classes/class_gpuparticlescollisionheightfield3d.rst +++ b/classes/class_gpuparticlescollisionheightfield3d.rst @@ -12,18 +12,18 @@ GPUParticlesCollisionHeightField3D **Inherits:** :ref:`GPUParticlesCollision3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Real-time heightmap-shaped 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A real-time heightmap-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Real-time heightmap-shaped 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A real-time heightmap-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. Heightmap shapes allow for efficiently representing collisions for convex and concave objects with a single "floor" (such as terrain). This is less flexible than :ref:`GPUParticlesCollisionSDF3D`, but it doesn't require a baking step. -\ **GPUParticlesCollisionHeightField3D** can also be regenerated in real-time when it is moved, when the camera moves, or even continuously. This makes **GPUParticlesCollisionHeightField3D** a good choice for weather effects such as rain and snow and games with highly dynamic geometry. However, since heightmaps cannot represent overhangs, **GPUParticlesCollisionHeightField3D** is not suited for indoor particle collision. +\ **GPUParticlesCollisionHeightField3D** can also be regenerated in real-time when it is moved, when the camera moves, or even continuously. This makes **GPUParticlesCollisionHeightField3D** a good choice for weather effects such as rain and snow and games with highly dynamic geometry. However, this class is limited since heightmaps cannot represent overhangs (e.g. indoors or caves). \ **Note:** :ref:`ParticleProcessMaterial.collision_mode` must be ``true`` on the :ref:`GPUParticles3D`'s process material for collision to work. diff --git a/classes/class_gpuparticlescollisionsdf3d.rst b/classes/class_gpuparticlescollisionsdf3d.rst index 8f3ca73d272..e02af0bdbfa 100644 --- a/classes/class_gpuparticlescollisionsdf3d.rst +++ b/classes/class_gpuparticlescollisionsdf3d.rst @@ -12,14 +12,14 @@ GPUParticlesCollisionSDF3D **Inherits:** :ref:`GPUParticlesCollision3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Baked signed distance field 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A baked signed distance field 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Baked signed distance field 3D particle attractor affecting :ref:`GPUParticles3D` nodes. +A baked signed distance field 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. Signed distance fields (SDF) allow for efficiently representing approximate collision shapes for convex and concave objects of any shape. This is more flexible than :ref:`GPUParticlesCollisionHeightField3D`, but it requires a baking step. diff --git a/classes/class_gpuparticlescollisionsphere3d.rst b/classes/class_gpuparticlescollisionsphere3d.rst index b0a1a446152..d45e0a5e99c 100644 --- a/classes/class_gpuparticlescollisionsphere3d.rst +++ b/classes/class_gpuparticlescollisionsphere3d.rst @@ -12,14 +12,16 @@ GPUParticlesCollisionSphere3D **Inherits:** :ref:`GPUParticlesCollision3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` -Sphere-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. +A sphere-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -Sphere-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. +A sphere-shaped 3D particle collision shape affecting :ref:`GPUParticles3D` nodes. + +Particle collision shapes work in real-time and can be moved, rotated and scaled during gameplay. Unlike attractors, non-uniform scaling of collision shapes is *not* supported. \ **Note:** :ref:`ParticleProcessMaterial.collision_mode` must be :ref:`ParticleProcessMaterial.COLLISION_RIGID` or :ref:`ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT` on the :ref:`GPUParticles3D`'s process material for collision to work. diff --git a/classes/class_gradient.rst b/classes/class_gradient.rst index 13ce4017a48..4d2c1255243 100644 --- a/classes/class_gradient.rst +++ b/classes/class_gradient.rst @@ -12,14 +12,14 @@ Gradient **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A color interpolator resource which can be used to generate colors between user-defined color points. +A color transition. .. rst-class:: classref-introduction-group Description ----------- -Given a set of colors, this resource will interpolate them in order. This means that if you have color 1, color 2 and color 3, the gradient will interpolate from color 1 to color 2 and from color 2 to color 3. The gradient will initially have 2 colors (black and white), one (black) at gradient lower offset 0 and the other (white) at the gradient higher offset 1. +This resource describes a color transition by defining a set of colored points and how to interpolate between them. See also :ref:`Curve` which supports more complex easing methods, but does not support colors. @@ -236,7 +236,7 @@ Method Descriptions void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** -Adds the specified color to the end of the gradient, with the specified offset. +Adds the specified color to the gradient, with the specified offset. .. rst-class:: classref-item-separator @@ -284,7 +284,7 @@ Returns the number of colors in the gradient. void **remove_point** **(** :ref:`int` point **)** -Removes the color at the index ``point``. +Removes the color at index ``point``. .. rst-class:: classref-item-separator diff --git a/classes/class_gradienttexture1d.rst b/classes/class_gradienttexture1d.rst index f8656b09aca..a3de6fa7816 100644 --- a/classes/class_gradienttexture1d.rst +++ b/classes/class_gradienttexture1d.rst @@ -12,14 +12,14 @@ GradientTexture1D **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Gradient-filled texture. +A 1D texture that uses colors obtained from a :ref:`Gradient`. .. rst-class:: classref-introduction-group Description ----------- -GradientTexture1D uses a :ref:`Gradient` to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width`). See also :ref:`GradientTexture2D`, :ref:`CurveTexture` and :ref:`CurveXYZTexture`. +A 1D texture that obtains colors from a :ref:`Gradient` to fill the texture data. The texture is filled by sampling the gradient for each pixel. Therefore, the texture does not necessarily represent an exact copy of the gradient, as it may miss some colors if there are not enough pixels. See also :ref:`GradientTexture2D`, :ref:`CurveTexture` and :ref:`CurveXYZTexture`. .. rst-class:: classref-reftable-group @@ -59,7 +59,7 @@ Property Descriptions - void **set_gradient** **(** :ref:`Gradient` value **)** - :ref:`Gradient` **get_gradient** **(** **)** -The :ref:`Gradient` that will be used to fill the texture. +The :ref:`Gradient` used to fill the texture. .. rst-class:: classref-item-separator diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst index cab7f6fec6d..69898a04e68 100644 --- a/classes/class_gradienttexture2d.rst +++ b/classes/class_gradienttexture2d.rst @@ -12,14 +12,14 @@ GradientTexture2D **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Gradient-filled 2D texture. +A 2D texture that creates a pattern with colors obtained from a :ref:`Gradient`. .. rst-class:: classref-introduction-group Description ----------- -The texture uses a :ref:`Gradient` to fill the texture data in 2D space. The gradient is filled according to the specified :ref:`fill` and :ref:`repeat` types using colors obtained from the gradient. The texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see :ref:`width` and :ref:`height`). See also :ref:`GradientTexture1D`, :ref:`CurveTexture` and :ref:`CurveXYZTexture`. +A 2D texture that obtains colors from a :ref:`Gradient` to fill the texture data. This texture is able to transform a color transition into different patterns such as a linear or a radial gradient. The gradient is sampled individually for each pixel so it does not necessarily represent an exact copy of the gradient(see :ref:`width` and :ref:`height`). See also :ref:`GradientTexture1D`, :ref:`CurveTexture` and :ref:`CurveXYZTexture`. .. rst-class:: classref-reftable-group diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index d01dcda82e6..d5f2c8e5dbd 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -101,7 +101,7 @@ State of the :kbd:`Alt` modifier. - void **set_command_or_control_autoremap** **(** :ref:`bool` value **)** - :ref:`bool` **is_command_or_control_autoremap** **(** **)** -Automatically use :kbd:`Meta` (:kbd:`Command`) on macOS and :kbd:`Ctrl` on other platforms. If ``true``, :ref:`ctrl_pressed` and :ref:`meta_pressed` cannot be set. +Automatically use :kbd:`Meta` (:kbd:`Cmd`) on macOS and :kbd:`Ctrl` on other platforms. If ``true``, :ref:`ctrl_pressed` and :ref:`meta_pressed` cannot be set. .. rst-class:: classref-item-separator @@ -181,7 +181,7 @@ Returns the keycode combination of modifier keys. :ref:`bool` **is_command_or_control_pressed** **(** **)** |const| -On macOS, returns ``true`` if :kbd:`Meta` (:kbd:`Command`) is pressed. +On macOS, returns ``true`` if :kbd:`Meta` (:kbd:`Cmd`) is pressed. On other platforms, returns ``true`` if :kbd:`Ctrl` is pressed. diff --git a/classes/class_int.rst b/classes/class_int.rst index 481eae5575e..f605703e331 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -758,7 +758,7 @@ This is useful for storing binary flags in a variable. :ref:`int` **operator ~** **(** **)** -Performs the bitwise ``NOT`` operation on the **int**. Due to `2's complement `__, it's effectively equal to ``-(int + 1)``. +Performs the bitwise ``NOT`` operation on the **int**. Due to `2's complement `__, it's effectively equal to ``-(int + 1)``. :: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 05c889b226a..69fe804fa3c 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -82,7 +82,7 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_force_displayed` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_mid_grapheme` | ``true`` | + | :ref:`bool` | :ref:`caret_mid_grapheme` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`clear_button_enabled` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -703,7 +703,7 @@ If ``true``, the **LineEdit** will always show the caret, even if focus is lost. .. rst-class:: classref-property -:ref:`bool` **caret_mid_grapheme** = ``true`` +:ref:`bool` **caret_mid_grapheme** = ``false`` .. rst-class:: classref-property-setget diff --git a/classes/class_material.rst b/classes/class_material.rst index 51fdf106f12..d95b5a12331 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -14,14 +14,14 @@ Material **Inherited By:** :ref:`BaseMaterial3D`, :ref:`CanvasItemMaterial`, :ref:`FogMaterial`, :ref:`PanoramaSkyMaterial`, :ref:`ParticleProcessMaterial`, :ref:`PhysicalSkyMaterial`, :ref:`PlaceholderMaterial`, :ref:`ProceduralSkyMaterial`, :ref:`ShaderMaterial` -Abstract base :ref:`Resource` for coloring and shading geometry. +Abstract base class for applying visual properties to an object, such as color and roughness. .. rst-class:: classref-introduction-group Description ----------- -Material is a base :ref:`Resource` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance3D` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. +**Material** is a base resource used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance3D` derived nodes carry a **Material**. A few flags and parameters are shared between all material types and are configured here. .. rst-class:: classref-introduction-group diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index fdbb7cab2c2..6f1338dff4f 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -103,6 +103,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`bake_from_source_geometry_data` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`bake_from_source_geometry_data_async` **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** | + +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_debug_enabled` **(** **)** |const| | @@ -727,6 +729,18 @@ Bakes the provided ``navigation_mesh`` with the data from the provided ``source_ ---- +.. _class_NavigationServer3D_method_bake_from_source_geometry_data_async: + +.. rst-class:: classref-method + +void **bake_from_source_geometry_data_async** **(** :ref:`NavigationMesh` navigation_mesh, :ref:`NavigationMeshSourceGeometryData3D` source_geometry_data, :ref:`Callable` callback=Callable() **)** + +Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called. + +.. rst-class:: classref-item-separator + +---- + .. _class_NavigationServer3D_method_free_rid: .. rst-class:: classref-method diff --git a/classes/class_node.rst b/classes/class_node.rst index 7ed02d63fe4..8a58e4da059 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -813,9 +813,9 @@ Notification received right after the scene with the node is saved in the editor **NOTIFICATION_WM_MOUSE_ENTER** = ``1002`` -Notification received from the OS when the mouse enters the game window. +Notification received when the mouse enters the window. -Implemented on desktop and web platforms. +Implemented for embedded windows and on desktop and web platforms. .. _class_Node_constant_NOTIFICATION_WM_MOUSE_EXIT: @@ -823,9 +823,9 @@ Implemented on desktop and web platforms. **NOTIFICATION_WM_MOUSE_EXIT** = ``1003`` -Notification received from the OS when the mouse leaves the game window. +Notification received when the mouse leaves the window. -Implemented on desktop and web platforms. +Implemented for embedded windows and on desktop and web platforms. .. _class_Node_constant_NOTIFICATION_WM_WINDOW_FOCUS_IN: diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index ed543d4c3a8..3a9086ff4e5 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -49,6 +49,8 @@ Properties +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Basis` | :ref:`basis` | | +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+ + | :ref:`Basis` | :ref:`global_basis` | | + +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector3` | :ref:`global_position` | | +-------------------------------------------------------+-------------------------------------------------------------------------------+-----------------------------------------------------+ | :ref:`Vector3` | :ref:`global_rotation` | | @@ -297,6 +299,23 @@ Direct access to the 3x3 basis of the :ref:`transform` **global_basis** + +.. rst-class:: classref-property-setget + +- void **set_global_basis** **(** :ref:`Basis` value **)** +- :ref:`Basis` **get_global_basis** **(** **)** + +Global basis of this node. This is equivalent to ``global_transform.basis``. + +.. rst-class:: classref-item-separator + +---- + .. _class_Node3D_property_global_position: .. rst-class:: classref-property diff --git a/classes/class_noise.rst b/classes/class_noise.rst index 6db9c05109b..b1b093270aa 100644 --- a/classes/class_noise.rst +++ b/classes/class_noise.rst @@ -23,7 +23,7 @@ Description This class defines the interface for noise generation libraries to inherit from. -A default get_seamless_noise() implementation is provided for libraries that do not provide seamless noise. This function requests a larger image from get_image(), reverses the quadrants of the image, then uses the strips of extra width to blend over the seams. +A default :ref:`get_seamless_image` implementation is provided for libraries that do not provide seamless noise. This function requests a larger image from the :ref:`get_image` method, reverses the quadrants of the image, then uses the strips of extra width to blend over the seams. Inheriting noise classes can optionally override this function to provide a more optimal algorithm. diff --git a/classes/class_noisetexture2d.rst b/classes/class_noisetexture2d.rst index b0770284533..9c43eb5cb2b 100644 --- a/classes/class_noisetexture2d.rst +++ b/classes/class_noisetexture2d.rst @@ -12,14 +12,14 @@ NoiseTexture2D **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A texture filled with noise generated by a :ref:`Noise` object. +A 2D texture filled with noise generated by a :ref:`Noise` object. .. rst-class:: classref-introduction-group Description ----------- -Uses :ref:`FastNoiseLite` or other libraries to fill the texture data of your desired size. **NoiseTexture2D** can also generate normal map textures. +Uses the :ref:`FastNoiseLite` library or other noise generators to fill the texture data of your desired size. **NoiseTexture2D** can also generate normal map textures. The class uses :ref:`Thread`\ s to generate the texture data internally, so :ref:`Texture2D.get_image` may return ``null`` if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the image and the generated byte data: diff --git a/classes/class_noisetexture3d.rst b/classes/class_noisetexture3d.rst index 69cffc5873f..e0d128333eb 100644 --- a/classes/class_noisetexture3d.rst +++ b/classes/class_noisetexture3d.rst @@ -12,14 +12,14 @@ NoiseTexture3D **Inherits:** :ref:`Texture3D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A texture filled with noise generated by a :ref:`Noise` object. +A 3D texture filled with noise generated by a :ref:`Noise` object. .. rst-class:: classref-introduction-group Description ----------- -Uses :ref:`FastNoiseLite` or other libraries to fill the texture data of your desired size. +Uses the :ref:`FastNoiseLite` library or other noise generators to fill the texture data of your desired size. The class uses :ref:`Thread`\ s to generate the texture data internally, so :ref:`Texture3D.get_data` may return ``null`` if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the image: diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index c683ec3f3d5..4a2c147df56 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -102,6 +102,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`select` **(** :ref:`int` idx **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_disable_shortcuts` **(** :ref:`bool` disabled **)** | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_disabled` **(** :ref:`int` idx, :ref:`bool` disabled **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_icon` **(** :ref:`int` idx, :ref:`Texture2D` texture **)** | @@ -521,6 +523,18 @@ Passing ``-1`` as the index deselects any currently selected item. ---- +.. _class_OptionButton_method_set_disable_shortcuts: + +.. rst-class:: classref-method + +void **set_disable_shortcuts** **(** :ref:`bool` disabled **)** + +If ``true``, shortcuts are disabled and cannot be used to trigger the button. + +.. rst-class:: classref-item-separator + +---- + .. _class_OptionButton_method_set_item_disabled: .. rst-class:: classref-method diff --git a/classes/class_ormmaterial3d.rst b/classes/class_ormmaterial3d.rst index 87e804705d5..d4d90b5ba9e 100644 --- a/classes/class_ormmaterial3d.rst +++ b/classes/class_ormmaterial3d.rst @@ -12,7 +12,7 @@ ORMMaterial3D **Inherits:** :ref:`BaseMaterial3D` **<** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Physically based rendering (PBR) material that can be applied to 3D objects, can use an ORM texture. +A PBR (Physically Based Rendering) material to be used on 3D objects. Uses an ORM texture. .. rst-class:: classref-introduction-group diff --git a/classes/class_os.rst b/classes/class_os.rst index f2ec22095e6..95705101d0b 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -1258,7 +1258,7 @@ Returns ``true`` if the project will automatically restart when it exits for any Returns ``true`` if application is running in the sandbox. -\ **Note:** This method is implemented on macOS. +\ **Note:** This method is implemented on macOS and Linux. .. rst-class:: classref-item-separator diff --git a/classes/class_panoramaskymaterial.rst b/classes/class_panoramaskymaterial.rst index b0c7d8769ca..d1208073531 100644 --- a/classes/class_panoramaskymaterial.rst +++ b/classes/class_panoramaskymaterial.rst @@ -12,14 +12,14 @@ PanoramaSkyMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Material` used with :ref:`Sky` to draw a background texture. +A material that provides a special texture to a :ref:`Sky`, usually an HDR panorama. .. rst-class:: classref-introduction-group Description ----------- -A resource referenced in a :ref:`Sky` that is used to draw a background. The Panorama sky material functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a cubemap. +A resource referenced in a :ref:`Sky` that is used to draw a background. **PanoramaSkyMaterial** functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a :ref:`Cubemap`. Using an HDR panorama is strongly recommended for accurate, high-quality reflections. Godot supports the Radiance HDR (``.hdr``) and OpenEXR (``.exr``) image formats for this purpose. diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index f418956244b..92a374dd699 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -12,18 +12,14 @@ ParticleProcessMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Particle properties for :ref:`GPUParticles3D` and :ref:`GPUParticles2D` nodes. +Holds a particle configuration for :ref:`GPUParticles2D` or :ref:`GPUParticles3D` nodes. .. rst-class:: classref-introduction-group Description ----------- -ParticleProcessMaterial defines particle properties and behavior. It is used in the ``process_material`` of :ref:`GPUParticles3D` and :ref:`GPUParticles2D` emitter nodes. - -Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture` applied to vary values over the lifetime of the particle. - -Particle animation is available only in :ref:`GPUParticles2D`. To use it, attach a :ref:`CanvasItemMaterial`, with :ref:`CanvasItemMaterial.particles_animation` enabled, to the particles node. +**ParticleProcessMaterial** defines particle properties and behavior. It is used in the ``process_material`` of the :ref:`GPUParticles2D` and :ref:`GPUParticles3D` nodes. Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture` or a :ref:`GradientTexture1D` applied to vary numerical or color values over the lifetime of the particle. .. rst-class:: classref-reftable-group diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index 81dceddafb2..ca537a470cc 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -12,7 +12,7 @@ PhysicalSkyMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -:ref:`Sky` :ref:`Material` used for a physically based sky. +A material that defines a sky for a :ref:`Sky` resource by a set of physical properties. .. rst-class:: classref-introduction-group diff --git a/classes/class_placeholdercubemap.rst b/classes/class_placeholdercubemap.rst index 676ca21d6cd..416c9c1633a 100644 --- a/classes/class_placeholdercubemap.rst +++ b/classes/class_placeholdercubemap.rst @@ -12,20 +12,20 @@ PlaceholderCubemap **Inherits:** :ref:`PlaceholderTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Placeholder class for a cubemap texture. +A :ref:`Cubemap` without image data. .. rst-class:: classref-introduction-group Description ----------- -This class is used when loading a project that uses a :ref:`Cubemap` subclass in 2 conditions: +This class replaces a :ref:`Cubemap` or a :ref:`Cubemap`-derived class in 2 conditions: -- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. +- In dedicated server mode, where the image data shouldn't affect game logic. This allows reducing the exported PCK's size significantly. -- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). +- When the :ref:`Cubemap`-derived class is missing, for example when using a different engine version. -\ **Note:** This is not intended to be used as an actual texture for rendering. It is not guaranteed to work like one in shaders or materials (for example when calculating UV). +\ **Note:** This class is not intended for rendering or for use in shaders. Operations like calculating UV are not guaranteed to work. .. |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_placeholdercubemaparray.rst b/classes/class_placeholdercubemaparray.rst index ff480e9b3b5..1b19ec51d73 100644 --- a/classes/class_placeholdercubemaparray.rst +++ b/classes/class_placeholdercubemaparray.rst @@ -12,20 +12,20 @@ PlaceholderCubemapArray **Inherits:** :ref:`PlaceholderTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Placeholder class for a cubemap texture array. +A :ref:`CubemapArray` without image data. .. rst-class:: classref-introduction-group Description ----------- -This class is used when loading a project that uses a :ref:`CubemapArray` subclass in 2 conditions: +This class replaces a :ref:`CubemapArray` or a :ref:`CubemapArray`-derived class in 2 conditions: -- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. +- In dedicated server mode, where the image data shouldn't affect game logic. This allows reducing the exported PCK's size significantly. -- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). +- When the :ref:`CubemapArray`-derived class is missing, for example when using a different engine version. -\ **Note:** This is not intended to be used as an actual texture for rendering. It is not guaranteed to work like one in shaders or materials (for example when calculating UV). +\ **Note:** This class is not intended for rendering or for use in shaders. Operations like calculating UV are not guaranteed to work. .. |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_popupmenu.rst b/classes/class_popupmenu.rst index 40dea72c773..d428e6501e1 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -59,131 +59,131 @@ Methods .. table:: :widths: auto - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_radio_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_radio_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_icon_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_multistate_item` **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_radio_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_separator` **(** :ref:`String` label="", :ref:`int` id=-1 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`clear` **(** **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_focused_item` **(** **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Key` | :ref:`get_item_accelerator` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_icon_max_width` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_indent` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_language` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Shortcut` | :ref:`get_item_shortcut` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`TextDirection` | :ref:`get_item_text_direction` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` index **)** |const| | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`remove_item` **(** :ref:`int` index **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`scroll_to_item` **(** :ref:`int` index **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_focused_item` **(** :ref:`int` index **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_accelerator` **(** :ref:`int` index, :ref:`Key` accel **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_as_checkable` **(** :ref:`int` index, :ref:`bool` enable **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` index, :ref:`bool` enable **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_as_separator` **(** :ref:`int` index, :ref:`bool` enable **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_checked` **(** :ref:`int` index, :ref:`bool` checked **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_disabled` **(** :ref:`int` index, :ref:`bool` disabled **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon` **(** :ref:`int` index, :ref:`Texture2D` icon **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_max_width` **(** :ref:`int` index, :ref:`int` width **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_icon_modulate` **(** :ref:`int` index, :ref:`Color` modulate **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_id` **(** :ref:`int` index, :ref:`int` id **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_indent` **(** :ref:`int` index, :ref:`int` indent **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_language` **(** :ref:`int` index, :ref:`String` language **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_metadata` **(** :ref:`int` index, :ref:`Variant` metadata **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_multistate` **(** :ref:`int` index, :ref:`int` state **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_shortcut` **(** :ref:`int` index, :ref:`Shortcut` shortcut, :ref:`bool` global=false **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` index, :ref:`bool` disabled **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_submenu` **(** :ref:`int` index, :ref:`String` submenu **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text` **(** :ref:`int` index, :ref:`String` text **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_text_direction` **(** :ref:`int` index, :ref:`TextDirection` direction **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`set_item_tooltip` **(** :ref:`int` index, :ref:`String` tooltip **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`toggle_item_checked` **(** :ref:`int` index **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`toggle_item_multistate` **(** :ref:`int` index **)** | - +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_icon_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_icon_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_icon_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_icon_radio_check_item` **(** :ref:`Texture2D` texture, :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_icon_radio_check_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_icon_shortcut` **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_multistate_item` **(** :ref:`String` label, :ref:`int` max_states, :ref:`int` default_state=0, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_radio_check_item` **(** :ref:`String` label, :ref:`int` id=-1, :ref:`Key` accel=0 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_radio_check_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_separator` **(** :ref:`String` label="", :ref:`int` id=-1 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_shortcut` **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_submenu_item` **(** :ref:`String` label, :ref:`String` submenu, :ref:`int` id=-1 **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`clear` **(** **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_focused_item` **(** **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Key` | :ref:`get_item_accelerator` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Texture2D` | :ref:`get_item_icon` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_icon_max_width` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`get_item_icon_modulate` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_id` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_indent` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_language` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Shortcut` | :ref:`get_item_shortcut` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_submenu` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`TextDirection` | :ref:`get_item_text_direction` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_checked` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_radio_checkable` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_separator` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_item_shortcut_disabled` **(** :ref:`int` index **)** |const| | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`remove_item` **(** :ref:`int` index **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`scroll_to_item` **(** :ref:`int` index **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_focused_item` **(** :ref:`int` index **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_accelerator` **(** :ref:`int` index, :ref:`Key` accel **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_as_checkable` **(** :ref:`int` index, :ref:`bool` enable **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_as_radio_checkable` **(** :ref:`int` index, :ref:`bool` enable **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_as_separator` **(** :ref:`int` index, :ref:`bool` enable **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_checked` **(** :ref:`int` index, :ref:`bool` checked **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_disabled` **(** :ref:`int` index, :ref:`bool` disabled **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_icon` **(** :ref:`int` index, :ref:`Texture2D` icon **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_icon_max_width` **(** :ref:`int` index, :ref:`int` width **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_icon_modulate` **(** :ref:`int` index, :ref:`Color` modulate **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_id` **(** :ref:`int` index, :ref:`int` id **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_indent` **(** :ref:`int` index, :ref:`int` indent **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_language` **(** :ref:`int` index, :ref:`String` language **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_metadata` **(** :ref:`int` index, :ref:`Variant` metadata **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_multistate` **(** :ref:`int` index, :ref:`int` state **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_shortcut` **(** :ref:`int` index, :ref:`Shortcut` shortcut, :ref:`bool` global=false **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_shortcut_disabled` **(** :ref:`int` index, :ref:`bool` disabled **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_submenu` **(** :ref:`int` index, :ref:`String` submenu **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_text` **(** :ref:`int` index, :ref:`String` text **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_text_direction` **(** :ref:`int` index, :ref:`TextDirection` direction **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_item_tooltip` **(** :ref:`int` index, :ref:`String` tooltip **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`toggle_item_checked` **(** :ref:`int` index **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`toggle_item_multistate` **(** :ref:`int` index **)** | + +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group @@ -542,12 +542,14 @@ Same as :ref:`add_icon_check_shortcut` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +void **add_icon_shortcut** **(** :ref:`Texture2D` texture, :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** Adds a new item and assigns the specified :ref:`Shortcut` and icon ``texture`` to it. Sets the label of the checkbox to the :ref:`Shortcut`'s name. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index. +If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. + .. rst-class:: classref-item-separator ---- @@ -634,12 +636,14 @@ A ``label`` can optionally be provided, which will appear at the center of the s .. rst-class:: classref-method -void **add_shortcut** **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false **)** +void **add_shortcut** **(** :ref:`Shortcut` shortcut, :ref:`int` id=-1, :ref:`bool` global=false, :ref:`bool` allow_echo=false **)** Adds a :ref:`Shortcut`. An ``id`` can optionally be provided. If no ``id`` is provided, one will be created from the index. +If ``allow_echo`` is ``true``, the shortcut can be activated with echo events. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_proceduralskymaterial.rst b/classes/class_proceduralskymaterial.rst index 567f9576f26..33002aeb0ef 100644 --- a/classes/class_proceduralskymaterial.rst +++ b/classes/class_proceduralskymaterial.rst @@ -12,18 +12,18 @@ ProceduralSkyMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Material` used with :ref:`Sky` to generate a background based on user input parameters. +A material that defines a simple sky for a :ref:`Sky` resource. .. rst-class:: classref-introduction-group Description ----------- -ProceduralSkyMaterial provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly, the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. +**ProceduralSkyMaterial** provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are defined by a main color, a color at the horizon, and an easing curve to interpolate between them. Suns are described by a position in the sky, a color, and a max angle from the sun at which the easing curve ends. The max angle therefore defines the size of the sun in the sky. -The **ProceduralSkyMaterial** uses a lightweight shader to draw the sky and is thus suited for real time updates. When you do not need a quick sky that is not realistic, this is a good option. If you need a more realistic option, try using :ref:`PhysicalSkyMaterial` instead. +\ **ProceduralSkyMaterial** supports up to 4 suns, using the color, and energy, direction, and angular distance of the first four :ref:`DirectionalLight3D` nodes in the scene. This means that the suns are defined individually by the properties of their corresponding :ref:`DirectionalLight3D`\ s and globally by :ref:`sun_angle_max` and :ref:`sun_curve`. -The **ProceduralSkyMaterial** supports up to 4 suns. Each sun takes its color, energy, and direction from the corresponding :ref:`DirectionalLight3D` in the scene. +\ **ProceduralSkyMaterial** uses a lightweight shader to draw the sky and is therefore suited for real time updates. This makes it a great option for a sky that is simple and computationally cheap, but unrealistic. If you need a more realistic procedural option, use :ref:`PhysicalSkyMaterial`. .. rst-class:: classref-reftable-group diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index e83cbe7ab1d..d2c28d70a2f 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1121,6 +1121,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/avoidance/thread_model/avoidance_use_multiple_threads` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/baking/thread_model/baking_use_high_priority_threads` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/baking/thread_model/baking_use_multiple_threads` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/limits/debugger/max_chars_per_second` | ``32768`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`network/limits/debugger/max_errors_per_second` | ``400`` | @@ -1820,7 +1824,7 @@ If ``false``, a non-hidden directory (``godot``) will be used instead. :ref:`String` **application/config/version** = ``""`` -The project's human-readable version identifier. This should always be set to a non-empty string, as some exporters rely on this value being defined. +The project's human-readable version identifier. This is used by exporters if the version identifier isn't overridden there. If :ref:`application/config/version` is an empty string and the version identifier isn't overridden in an exporter, the exporter will use ``1.0.0`` as a version identifier. .. rst-class:: classref-item-separator @@ -1992,6 +1996,8 @@ If :ref:`display/window/vsync/vsync_mode`. +This setting can be overridden using the ``--max-fps `` command line argument (including with a value of ``0`` for unlimited framerate). + \ **Note:** This property is only read when the project starts. To change the rendering FPS cap at runtime, set :ref:`Engine.max_fps` instead. .. rst-class:: classref-item-separator @@ -2098,7 +2104,9 @@ Specifies the preferred output latency in milliseconds for audio. Lower values w Audio output latency may be constrained by the host operating system and audio hardware drivers. If the host can not provide the specified audio output latency then Godot will attempt to use the nearest latency allowed by the host. As such you should always use :ref:`AudioServer.get_output_latency` to determine the actual audio output latency. -\ **Note:** This setting is ignored on all versions of Windows prior to Windows 10. +Audio output latency can be overridden using the ``--audio-output-latency `` command line argument. + +\ **Note:** This setting is ignored on Android, and on all versions of Windows prior to Windows 10. .. rst-class:: classref-item-separator @@ -8348,6 +8356,30 @@ If enabled the avoidance calculations use multiple threads. ---- +.. _class_ProjectSettings_property_navigation/baking/thread_model/baking_use_high_priority_threads: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/baking/thread_model/baking_use_high_priority_threads** = ``true`` + +If enabled and async navmesh baking uses multiple threads the threads run with high priority. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_navigation/baking/thread_model/baking_use_multiple_threads: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/baking/thread_model/baking_use_multiple_threads** = ``true`` + +If enabled the async navmesh baking uses multiple threads. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_network/limits/debugger/max_chars_per_second: .. rst-class:: classref-property diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index fd4ca06d371..2644a8f8e8b 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -7318,6 +7318,8 @@ Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). \ **Note:** When running a headless or server binary, this function returns an empty string. +\ **Note:** On the web platform, some browsers such as Firefox may report a different, fixed GPU name such as "GeForce GTX 980" (regardless of the user's actual GPU model). This is done to make fingerprinting more difficult. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 0ce7b7f6059..bf60f098b92 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -673,6 +673,8 @@ Returns an array of currently existing :ref:`Tween`\ s in the **Sce Returns ``true`` if the given group exists. +A group exists if any :ref:`Node` in the tree belongs to it (see :ref:`Node.add_to_group`). Groups without nodes are removed automatically. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_shaderglobalsoverride.rst b/classes/class_shaderglobalsoverride.rst index 84032084e1b..bdb325568b4 100644 --- a/classes/class_shaderglobalsoverride.rst +++ b/classes/class_shaderglobalsoverride.rst @@ -12,7 +12,7 @@ ShaderGlobalsOverride **Inherits:** :ref:`Node` **<** :ref:`Object` -Overrides global shader parameters' values in a specific scene. +A node used to override global shader parameters' values in a scene. .. rst-class:: classref-introduction-group @@ -25,6 +25,13 @@ Similar to how a :ref:`WorldEnvironment` node can be use \ **Note:** All **ShaderGlobalsOverride** nodes are made part of a ``"shader_overrides_group"`` group when they are added to the scene tree. The currently active **ShaderGlobalsOverride** node also has a ``"shader_overrides_group_active"`` group added to it. You can use this to check which **ShaderGlobalsOverride** node is currently active. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Shading language <../tutorials/shaders/shader_reference/shading_language>` + .. |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_shadermaterial.rst b/classes/class_shadermaterial.rst index 1242189c584..f8486d315b7 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -12,16 +12,18 @@ ShaderMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A material that uses a custom :ref:`Shader` program. +A material defined by a custom :ref:`Shader` program and the values of its shader parameters. .. rst-class:: classref-introduction-group Description ----------- -A material that uses a custom :ref:`Shader` program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. +A material that uses a custom :ref:`Shader` program to render visual items (canvas items, meshes, skies, fog), or to process particles. Compared to other materials, **ShaderMaterial** gives deeper control over the generated shader code. For more information, see the shaders documentation index below. -\ **Note:** For performance reasons the :ref:`Resource.changed` signal is only emitted when the :ref:`Resource.resource_name` is changed. Only in editor, is also emitted for :ref:`shader` changes. +Multiple **ShaderMaterial**\ s can use the same shader and configure different values for the shader uniforms. + +\ **Note:** For performance reasons, the :ref:`Resource.changed` signal is only emitted when the :ref:`Resource.resource_name` changes. Only in editor, it is also emitted for :ref:`shader` changes. .. rst-class:: classref-introduction-group diff --git a/classes/class_sky.rst b/classes/class_sky.rst index 97eccda2b31..07ed0d2198b 100644 --- a/classes/class_sky.rst +++ b/classes/class_sky.rst @@ -12,14 +12,14 @@ Sky **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Background that uses a :ref:`Material` to draw a sky. +Defines a 3D environment's background by using a :ref:`Material`. .. rst-class:: classref-introduction-group Description ----------- -The **Sky** class uses a :ref:`Material` to draw the background and update the reflection/radiance cubemaps. +The **Sky** class uses a :ref:`Material` to render a 3D environment's background and the light it emits by updating the reflection/radiance cubemaps. .. rst-class:: classref-reftable-group diff --git a/classes/class_standardmaterial3d.rst b/classes/class_standardmaterial3d.rst index ec75bd7f541..cc3309399c5 100644 --- a/classes/class_standardmaterial3d.rst +++ b/classes/class_standardmaterial3d.rst @@ -12,7 +12,7 @@ StandardMaterial3D **Inherits:** :ref:`BaseMaterial3D` **<** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Physically based rendering (PBR) material that can be applied to 3D objects. +A PBR (Physically Based Rendering) material to be used on 3D objects. .. rst-class:: classref-introduction-group diff --git a/classes/class_string.rst b/classes/class_string.rst index a1cd1bfdf84..34af8e2fe98 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -191,6 +191,8 @@ Methods +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`reverse` **(** **)** |const| | + +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | @@ -1462,6 +1464,18 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with ---- +.. _class_String_method_reverse: + +.. rst-class:: classref-method + +:ref:`String` **reverse** **(** **)** |const| + +Returns the copy of this string in reverse order. + +.. rst-class:: classref-item-separator + +---- + .. _class_String_method_rfind: .. rst-class:: classref-method diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index 27d0d4bfc97..78f95eaec21 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -170,6 +170,8 @@ Methods +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`reverse` **(** **)** |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | @@ -1301,6 +1303,18 @@ Replaces all **case-insensitive** occurrences of ``what`` inside the string with ---- +.. _class_StringName_method_reverse: + +.. rst-class:: classref-method + +:ref:`String` **reverse** **(** **)** |const| + +Returns the copy of this string in reverse order. + +.. rst-class:: classref-item-separator + +---- + .. _class_StringName_method_rfind: .. rst-class:: classref-method diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 6a21243209e..bf966c36d9c 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -44,7 +44,7 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_draw_when_editable_disabled` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`caret_mid_grapheme` | ``true`` | + | :ref:`bool` | :ref:`caret_mid_grapheme` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_move_on_right_click` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -1106,7 +1106,7 @@ If ``true``, caret will be visible when :ref:`editable` **caret_mid_grapheme** = ``true`` +:ref:`bool` **caret_mid_grapheme** = ``false`` .. rst-class:: classref-property-setget diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 86f4c328f54..07aedd2ca5e 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -302,6 +302,8 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shaped_text_clear` **(** :ref:`RID` rid **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_closest_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shaped_text_draw` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l=-1, :ref:`float` clip_r=-1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shaped_text_draw_outline` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l=-1, :ref:`float` clip_r=-1, :ref:`int` outline_size=1, :ref:`Color` color=Color(1, 1, 1, 1) **)** |const| | @@ -312,6 +314,8 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`shaped_text_get_character_breaks` **(** :ref:`RID` shaped **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`shaped_text_get_custom_punctuation` **(** :ref:`RID` shaped **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`shaped_text_get_descent` **(** :ref:`RID` shaped **)** |const| | @@ -376,10 +380,14 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shaped_text_is_ready` **(** :ref:`RID` shaped **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_next_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shaped_text_next_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shaped_text_overrun_trim_to_width` **(** :ref:`RID` shaped, :ref:`float` width=0, |bitfield|\<:ref:`TextOverrunFlag`\> overrun_trim_flags=0 **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`shaped_text_prev_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`shaped_text_prev_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shaped_text_resize_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`float` baseline=0.0 **)** | @@ -408,6 +416,8 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`spoof_check` **(** :ref:`String` string **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`string_get_character_breaks` **(** :ref:`String` string, :ref:`String` language="" **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`string_get_word_breaks` **(** :ref:`String` string, :ref:`String` language="", :ref:`int` chars_per_line=0 **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`string_to_lower` **(** :ref:`String` string, :ref:`String` language="" **)** |const| | @@ -3161,6 +3171,18 @@ Clears text buffer (removes text and inline objects). ---- +.. _class_TextServer_method_shaped_text_closest_character_pos: + +.. rst-class:: classref-method + +:ref:`int` **shaped_text_closest_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| + +Returns composite character position closest to the ``pos``. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_text_draw: .. rst-class:: classref-method @@ -3223,6 +3245,18 @@ Returns shapes of the carets corresponding to the character offset ``position`` ---- +.. _class_TextServer_method_shaped_text_get_character_breaks: + +.. rst-class:: classref-method + +:ref:`PackedInt32Array` **shaped_text_get_character_breaks** **(** :ref:`RID` shaped **)** |const| + +Returns array of the composite character boundaries. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_text_get_custom_punctuation: .. rst-class:: classref-method @@ -3611,13 +3645,25 @@ Returns ``true`` if buffer is successfully shaped. ---- +.. _class_TextServer_method_shaped_text_next_character_pos: + +.. rst-class:: classref-method + +:ref:`int` **shaped_text_next_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| + +Returns composite character end position closest to the ``pos``. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_text_next_grapheme_pos: .. rst-class:: classref-method :ref:`int` **shaped_text_next_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| -Returns composite character end position closest to the ``pos``. +Returns grapheme end position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -3635,13 +3681,25 @@ Trims text if it exceeds the given width. ---- +.. _class_TextServer_method_shaped_text_prev_character_pos: + +.. rst-class:: classref-method + +:ref:`int` **shaped_text_prev_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| + +Returns composite character start position closest to the ``pos``. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_shaped_text_prev_grapheme_pos: .. rst-class:: classref-method :ref:`int` **shaped_text_prev_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |const| -Returns composite character start position closest to the ``pos``. +Returns grapheme start position closest to the ``pos``. .. rst-class:: classref-item-separator @@ -3813,6 +3871,23 @@ Returns ``true`` if ``string`` is likely to be an attempt at confusing the reade ---- +.. _class_TextServer_method_string_get_character_breaks: + +.. rst-class:: classref-method + +:ref:`PackedInt32Array` **string_get_character_breaks** **(** :ref:`String` string, :ref:`String` language="" **)** |const| + +Returns array of the composite character boundaries. + +:: + + var ts = TextServerManager.get_primary_interface() + print(ts.string_get_word_breaks("Test ❤️‍🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14] + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_string_get_word_breaks: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 3427cd3cc28..b5ec5670732 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -306,6 +306,8 @@ Methods +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_clear` **(** :ref:`RID` shaped **)** |virtual| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_closest_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_draw` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`Color` color **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_draw_outline` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`int` outline_size, :ref:`Color` color **)** |virtual| |const| | @@ -316,6 +318,8 @@ Methods +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_shaped_text_get_character_breaks` **(** :ref:`RID` shaped **)** |virtual| |const| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_shaped_text_get_custom_punctuation` **(** :ref:`RID` shaped **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_shaped_text_get_descent` **(** :ref:`RID` shaped **)** |virtual| |const| | @@ -378,10 +382,14 @@ Methods +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_shaped_text_is_ready` **(** :ref:`RID` shaped **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_next_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_shaped_text_next_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_shaped_text_overrun_trim_to_width` **(** :ref:`RID` shaped, :ref:`float` width, |bitfield|\<:ref:`TextOverrunFlag`\> trim_flags **)** |virtual| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_shaped_text_prev_character_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_shaped_text_prev_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_shaped_text_resize_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`float` baseline **)** |virtual| | @@ -414,6 +422,8 @@ Methods +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_spoof_check` **(** :ref:`String` string **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedInt32Array` | :ref:`_string_get_character_breaks` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`_string_get_word_breaks` **(** :ref:`String` string, :ref:`String` language, :ref:`int` chars_per_line **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_string_to_lower` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | @@ -2352,6 +2362,20 @@ void **_shaped_text_clear** **(** :ref:`RID` shaped **)** |virtual| ---- +.. _class_TextServerExtension_method__shaped_text_closest_character_pos: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_text_closest_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__shaped_text_draw: .. rst-class:: classref-method @@ -2422,6 +2446,20 @@ void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` **_shaped_text_get_character_breaks** **(** :ref:`RID` shaped **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__shaped_text_get_custom_punctuation: .. rst-class:: classref-method @@ -2856,6 +2894,20 @@ const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)* ---- +.. _class_TextServerExtension_method__shaped_text_next_character_pos: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_text_next_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__shaped_text_next_grapheme_pos: .. rst-class:: classref-method @@ -2884,6 +2936,20 @@ void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, ---- +.. _class_TextServerExtension_method__shaped_text_prev_character_pos: + +.. rst-class:: classref-method + +:ref:`int` **_shaped_text_prev_character_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__shaped_text_prev_grapheme_pos: .. rst-class:: classref-method @@ -3108,6 +3174,20 @@ const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped ** ---- +.. _class_TextServerExtension_method__string_get_character_breaks: + +.. rst-class:: classref-method + +:ref:`PackedInt32Array` **_string_get_character_breaks** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__string_get_word_breaks: .. rst-class:: classref-method diff --git a/classes/class_tree.rst b/classes/class_tree.rst index fc6bc77318f..074eb6320d3 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -261,6 +261,8 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`font_size` | | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ + | :ref:`int` | :ref:`title_button_font_size` | | + +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Texture2D` | :ref:`arrow` | | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Texture2D` | :ref:`arrow_collapsed` | | @@ -1740,6 +1742,18 @@ Font size of the item's text. ---- +.. _class_Tree_theme_font_size_title_button_font_size: + +.. rst-class:: classref-themeproperty + +:ref:`int` **title_button_font_size** + +Font size of the title button's text. + +.. rst-class:: classref-item-separator + +---- + .. _class_Tree_theme_icon_arrow: .. rst-class:: classref-themeproperty diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 41b7a216047..abf968820db 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -169,6 +169,8 @@ Methods +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_canvas_cull_mask_bit` **(** :ref:`int` layer **)** |const| | +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Window[]` | :ref:`get_embedded_subwindows` **(** **)** |const| | + +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** |const| | +-----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** |const| | @@ -1839,6 +1841,20 @@ Returns an individual bit on the rendering layer mask. ---- +.. _class_Viewport_method_get_embedded_subwindows: + +.. rst-class:: classref-method + +:ref:`Window[]` **get_embedded_subwindows** **(** **)** |const| + +Returns a list of the visible embedded :ref:`Window`\ s inside the viewport. + +\ **Note:** :ref:`Window`\ s inside other viewports will not be listed. + +.. rst-class:: classref-item-separator + +---- + .. _class_Viewport_method_get_final_transform: .. rst-class:: classref-method diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index 0a54c0a1606..b34af625c27 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -19,9 +19,14 @@ A custom shader program with a visual editor. Description ----------- -This class allows you to define a custom shader program that can be used for various materials to render objects. +This class provides a graph-like visual editor for creating a :ref:`Shader`. Although **VisualShader**\ s do not require coding, they share the same logic with script shaders. They use :ref:`VisualShaderNode`\ s that can be connected to each other to control the flow of the shader. The visual shader graph is converted to a script shader behind the scenes. -The visual shader editor creates the shader. +.. rst-class:: classref-introduction-group + +Tutorials +--------- + +- :doc:`Using VisualShaders <../tutorials/shaders/visual_shaders>` .. rst-class:: classref-reftable-group diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index f362188f32a..deb0f83a5c0 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -14,21 +14,21 @@ VisualShaderNode **Inherited By:** :ref:`VisualShaderNodeBillboard`, :ref:`VisualShaderNodeClamp`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCompare`, :ref:`VisualShaderNodeConstant`, :ref:`VisualShaderNodeCubemap`, :ref:`VisualShaderNodeCustom`, :ref:`VisualShaderNodeDerivativeFunc`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDistanceFade`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFloatFunc`, :ref:`VisualShaderNodeFloatOp`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeIntFunc`, :ref:`VisualShaderNodeIntOp`, :ref:`VisualShaderNodeIs`, :ref:`VisualShaderNodeLinearSceneDepth`, :ref:`VisualShaderNodeMix`, :ref:`VisualShaderNodeMultiplyAdd`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeParameter`, :ref:`VisualShaderNodeParameterRef`, :ref:`VisualShaderNodeParticleAccelerator`, :ref:`VisualShaderNodeParticleConeVelocity`, :ref:`VisualShaderNodeParticleEmit`, :ref:`VisualShaderNodeParticleEmitter`, :ref:`VisualShaderNodeParticleMultiplyByAxisAngle`, :ref:`VisualShaderNodeParticleRandomness`, :ref:`VisualShaderNodeProximityFade`, :ref:`VisualShaderNodeRandomRange`, :ref:`VisualShaderNodeRemap`, :ref:`VisualShaderNodeResizableBase`, :ref:`VisualShaderNodeRotationByAxis`, :ref:`VisualShaderNodeSample3D`, :ref:`VisualShaderNodeScreenNormalWorldSpace`, :ref:`VisualShaderNodeScreenUVToSDF`, :ref:`VisualShaderNodeSDFRaymarch`, :ref:`VisualShaderNodeSDFToScreenUV`, :ref:`VisualShaderNodeSmoothStep`, :ref:`VisualShaderNodeStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTextureSDF`, :ref:`VisualShaderNodeTextureSDFNormal`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformOp`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUIntFunc`, :ref:`VisualShaderNodeUIntOp`, :ref:`VisualShaderNodeUVFunc`, :ref:`VisualShaderNodeUVPolarCoord`, :ref:`VisualShaderNodeVarying`, :ref:`VisualShaderNodeVectorBase`, :ref:`VisualShaderNodeWorldPositionFromDepth` -Base class for nodes in a visual shader graph. +Base class for :ref:`VisualShader` nodes. Not related to scene nodes. .. rst-class:: classref-introduction-group Description ----------- -Visual shader graphs consist of various nodes. Each node in the graph is a separate object and they are represented as a rectangular boxes with title and a set of properties. Each node has also connection ports that allow to connect it to another nodes and control the flow of the shader. +Visual shader graphs consist of various nodes. Each node in the graph is a separate object and they are represented as a rectangular boxes with title and a set of properties. Each node also has connection ports that allow to connect it to another nodes and control the flow of the shader. .. rst-class:: classref-introduction-group Tutorials --------- -- :doc:`VisualShaders <../tutorials/shaders/visual_shaders>` +- :doc:`Using VisualShaders <../tutorials/shaders/visual_shaders>` .. rst-class:: classref-reftable-group diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst index 3021755ae04..644cff3d0e9 100644 --- a/classes/class_visualshadernodeif.rst +++ b/classes/class_visualshadernodeif.rst @@ -12,14 +12,14 @@ VisualShaderNodeIf **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Compares two floating-point numbers in order to return a required vector within the visual shader graph. +Outputs a 3D vector based on the result of a floating point comparison within the visual shader graph. .. rst-class:: classref-introduction-group Description ----------- -First two ports are scalar floating-point numbers to compare, third is tolerance comparison amount and last three ports represents a vectors returned if ``a == b``, ``a > b`` and ``a < b`` respectively. +This visual shader node has six input ports. Port 1 and 2 provide the two floating point numbers ``a`` and ``b`` that will be compared. Port 3 is the tolerance, which allows similar floating point number to be considered equal. Ports 4 to 6 are the possible outputs, returned if ``a == b``, ``a > b``, or ``a < b`` respectively. .. |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_xmlparser.rst b/classes/class_xmlparser.rst index 79fd73c8cfe..bbac8825543 100644 --- a/classes/class_xmlparser.rst +++ b/classes/class_xmlparser.rst @@ -285,7 +285,7 @@ Check whether the current element has a certain attribute. :ref:`bool` **is_empty** **(** **)** |const| -Check whether the current element is empty (this only works for completely empty tags, e.g. ````). +Check whether the current element is empty (this only works for completely empty tags, e.g. ````). .. rst-class:: classref-item-separator diff --git a/classes/class_zipreader.rst b/classes/class_zipreader.rst index 015e3a424a8..66252b9e7ae 100644 --- a/classes/class_zipreader.rst +++ b/classes/class_zipreader.rst @@ -40,15 +40,17 @@ Methods .. table:: :widths: auto - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`close` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedStringArray` | :ref:`get_files` **(** **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Error` | :ref:`open` **(** :ref:`String` path **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedByteArray` | :ref:`read_file` **(** :ref:`String` path, :ref:`bool` case_sensitive=true **)** | - +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`close` **(** **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path, :ref:`bool` case_sensitive=true **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`get_files` **(** **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Error` | :ref:`open` **(** :ref:`String` path **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedByteArray` | :ref:`read_file` **(** :ref:`String` path, :ref:`bool` case_sensitive=true **)** | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -71,6 +73,20 @@ Closes the underlying resources used by this instance. ---- +.. _class_ZIPReader_method_file_exists: + +.. rst-class:: classref-method + +:ref:`bool` **file_exists** **(** :ref:`String` path, :ref:`bool` case_sensitive=true **)** + +Returns ``true`` if the file exists in the loaded zip archive. + +Must be called after :ref:`open`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ZIPReader_method_get_files: .. rst-class:: classref-method