diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index e9117118399..a115ebeb22d 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -73,6 +73,10 @@ Properties +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`JavaScriptBridge` | :ref:`JavaScriptBridge` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`MCPBridge` | :ref:`MCPBridge` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | :ref:`MCPServer` | :ref:`MCPServer` | + +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Marshalls` | :ref:`Marshalls` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`NativeMenu` | :ref:`NativeMenu` | @@ -5026,6 +5030,34 @@ The :ref:`JavaScriptBridge` singleton. ---- +.. _class_@GlobalScope_property_MCPBridge: + +.. rst-class:: classref-property + +:ref:`MCPBridge` **MCPBridge** :ref:`🔗` + +.. container:: contribute + + There is currently no description for this property. Please help us by `contributing one `__! + +.. rst-class:: classref-item-separator + +---- + +.. _class_@GlobalScope_property_MCPServer: + +.. rst-class:: classref-property + +:ref:`MCPServer` **MCPServer** :ref:`🔗` + +.. container:: contribute + + There is currently no description for this property. Please help us by `contributing one `__! + +.. rst-class:: classref-item-separator + +---- + .. _class_@GlobalScope_property_Marshalls: .. rst-class:: classref-property @@ -5995,7 +6027,7 @@ Returns the :ref:`Object` that corresponds to ``instance_id``. All func _ready(): var id = get_instance_id() var instance = instance_from_id(id) - print(instance.foo) # Prints "water" + print(instance.drink) # Prints "water" .. code-tab:: csharp diff --git a/classes/class_array.rst b/classes/class_array.rst index b8e63c1f9b7..7820609b2dc 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -17,7 +17,7 @@ A built-in data structure that holds a sequence of elements. Description ----------- -An array data structure that can contain a sequence of elements of any :ref:`Variant` type. Elements are accessed by a numerical index starting at ``0``. Negative indices are used to count from the back (``-1`` is the last element, ``-2`` is the second to last, etc.). +An array data structure that can contain a sequence of elements of any :ref:`Variant` type by default. Values can optionally be constrained to a specific type by creating a *typed array*. Elements are accessed by a numerical index starting at ``0``. Negative indices are used to count from the back (``-1`` is the last element, ``-2`` is the second to last, etc.). .. tabs:: @@ -33,6 +33,10 @@ An array data structure that can contain a sequence of elements of any :ref:`Var print(array[1]) # Prints "Second" print(array[-3]) # Prints "Second" + # This typed array can only contain integers. + # Attempting to add any other type will result in an error. + var typed_array: Array[int] = [1, 2, 3] + .. code-tab:: csharp Godot.Collections.Array array = ["First", 2, 3, "Last"]; @@ -44,6 +48,10 @@ An array data structure that can contain a sequence of elements of any :ref:`Var GD.Print(array[1]); // Prints "Second" GD.Print(array[^3]); // Prints "Second" + // This typed array can only contain integers. + // Attempting to add any other type will result in an error. + Godot.Collections.Array typedArray = [1, 2, 3]; + \ **Note:** Arrays are always passed by **reference**. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()`. @@ -1229,8 +1237,6 @@ If you need to return the removed element, use :ref:`pop_at()`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -450,7 +450,7 @@ Sets a name for a given surface. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -464,7 +464,7 @@ Sets a name for a given surface. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 7c3aeca3d31..8ade6902bde 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -607,7 +607,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -621,7 +621,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -635,7 +635,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -649,7 +649,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -663,7 +663,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -677,7 +677,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -691,7 +691,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -705,7 +705,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -719,7 +719,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -733,7 +733,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -747,7 +747,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -761,7 +761,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audioeffectdistortion.rst b/classes/class_audioeffectdistortion.rst index 0dc4950d7c7..17813bf5308 100644 --- a/classes/class_audioeffectdistortion.rst +++ b/classes/class_audioeffectdistortion.rst @@ -83,7 +83,7 @@ Digital distortion effect which cuts off peaks at the top and bottom of the wave .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index b3e6d829582..774d909c719 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -106,7 +106,7 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index d5109225627..8eb0c92247f 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -167,7 +167,7 @@ The size of the `Fast Fourier transform `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index e1a5b848115..e499881d3c3 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -81,7 +81,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -100,7 +100,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -119,7 +119,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index f349e1ef275..ddf196baceb 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -88,7 +88,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -126,7 +126,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_audiostreamplaybackoggvorbis.rst b/classes/class_audiostreamplaybackoggvorbis.rst index b1eb0e72ad1..a635971db1d 100644 --- a/classes/class_audiostreamplaybackoggvorbis.rst +++ b/classes/class_audiostreamplaybackoggvorbis.rst @@ -14,7 +14,7 @@ AudioStreamPlaybackOggVorbis .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index 3093d920e07..13abce84199 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -16,7 +16,7 @@ AudioStreamPlaybackResampled .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -51,7 +51,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_audiostreamplaybacksynchronized.rst b/classes/class_audiostreamplaybacksynchronized.rst index 5ba4dc21420..4eefce469bf 100644 --- a/classes/class_audiostreamplaybacksynchronized.rst +++ b/classes/class_audiostreamplaybacksynchronized.rst @@ -14,7 +14,7 @@ AudioStreamPlaybackSynchronized .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 940a3051be2..65e913ae5f9 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -3437,6 +3437,8 @@ The stencil reference value (0-255). Typically a power of 2. If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. Subsurface scattering quality is controlled by :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality`. +\ **Note:** Subsurface scattering is not supported on viewports that have a transparent background (where :ref:`Viewport.transparent_bg` is ``true``). + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 3d0076a1338..cdaaadb395f 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -377,7 +377,7 @@ Returns the `determinant `__ of this - If the determinant is a negative number, the basis represents a negative scale. -\ **Note:** If the basis's scale is the same for every axis, its determinant is always that scale by the power of 2. +\ **Note:** If the basis's scale is the same for every axis, its determinant is always that scale by the power of 3. .. rst-class:: classref-item-separator diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst index 6165549637a..73d0d636ca5 100644 --- a/classes/class_cameraattributespractical.rst +++ b/classes/class_cameraattributespractical.rst @@ -143,6 +143,8 @@ Enables depth of field blur for objects further than :ref:`dof_blur_far_distance \ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. +\ **Note:** Depth of field blur is not supported on viewports that have a transparent background (where :ref:`Viewport.transparent_bg` is ``true``). + .. rst-class:: classref-item-separator ---- @@ -196,6 +198,8 @@ Enables depth of field blur for objects closer than :ref:`dof_blur_near_distance \ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. +\ **Note:** Depth of field blur is not supported on viewports that have a transparent background (where :ref:`Viewport.transparent_bg` is ``true``). + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 5d66304e9e4..1c7969eed7c 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -836,7 +836,7 @@ Subsequent drawing commands will be ignored unless they fall within the specifie |void| **draw_arc**\ (\ center\: :ref:`Vector2`, radius\: :ref:`float`, start_angle\: :ref:`float`, end_angle\: :ref:`float`, point_count\: :ref:`int`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws an unfilled arc between the given angles with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). The larger the value of ``point_count``, the smoother the curve. See also :ref:`draw_circle()`. +Draws an unfilled arc between the given angles with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). The larger the value of ``point_count``, the smoother the curve. ``center`` is defined in local space. See also :ref:`draw_circle()`. If ``width`` is negative, it will be ignored and the arc will be drawn using :ref:`RenderingServer.PRIMITIVE_LINE_STRIP`. This means that when the CanvasItem is scaled, the arc will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -852,7 +852,7 @@ The arc is drawn from ``start_angle`` towards the value of ``end_angle`` so in c |void| **draw_char**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -Draws a string first character using a custom font. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. +Draws a string first character using a custom font. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. ``pos`` is defined in local space. .. rst-class:: classref-item-separator @@ -864,7 +864,7 @@ Draws a string first character using a custom font. If ``oversampling`` is great |void| **draw_char_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, char\: :ref:`String`, font_size\: :ref:`int` = 16, size\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -Draws a string first character outline using a custom font. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. +Draws a string first character outline using a custom font. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. ``pos`` is defined in local space. .. rst-class:: classref-item-separator @@ -876,7 +876,7 @@ Draws a string first character outline using a custom font. If ``oversampling`` |void| **draw_circle**\ (\ position\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws a circle. See also :ref:`draw_arc()`, :ref:`draw_polyline()`, and :ref:`draw_polygon()`. +Draws a circle, with ``position`` defined in local space. See also :ref:`draw_arc()`, :ref:`draw_polyline()`, and :ref:`draw_polygon()`. If ``filled`` is ``true``, the circle will be filled with the ``color`` specified. If ``filled`` is ``false``, the circle will be drawn as a stroke with the ``color`` and ``width`` specified. @@ -896,7 +896,7 @@ If ``antialiased`` is ``true``, half transparent "feathers" will be attached to |void| **draw_colored_polygon**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` -Draws a colored polygon of any number of points, convex or concave. Unlike :ref:`draw_polygon()`, a single color must be specified for the whole polygon. +Draws a colored polygon of any number of points, convex or concave. The points in the ``points`` array are defined in local space. Unlike :ref:`draw_polygon()`, a single color must be specified for the whole polygon. \ **Note:** If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with :ref:`Geometry2D.triangulate_polygon()` and using :ref:`draw_mesh()`, :ref:`draw_multimesh()`, or :ref:`RenderingServer.canvas_item_add_triangle_array()`. @@ -910,7 +910,7 @@ Draws a colored polygon of any number of points, convex or concave. Unlike :ref: |void| **draw_dashed_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, dash\: :ref:`float` = 2.0, aligned\: :ref:`bool` = true, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws a dashed line from a 2D point to another, with a given color and width. See also :ref:`draw_line()`, :ref:`draw_multiline()`, and :ref:`draw_polyline()`. +Draws a dashed line from a 2D point to another, with a given color and width. The ``from`` and ``to`` positions are defined in local space. See also :ref:`draw_line()`, :ref:`draw_multiline()`, and :ref:`draw_polyline()`. If ``width`` is negative, then a two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the line parts will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -942,7 +942,7 @@ After submitting all animations slices via :ref:`draw_animation_slice()`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` -Draws a textured rectangle region of the font texture with LCD subpixel anti-aliasing at a given position, optionally modulated by a color. +Draws a textured rectangle region of the font texture with LCD subpixel anti-aliasing at a given position, optionally modulated by a color. The ``rect`` is defined in local space. Texture is drawn using the following blend operation, blend mode of the :ref:`CanvasItemMaterial` is ignored: @@ -963,7 +963,7 @@ Texture is drawn using the following blend operation, blend mode of the :ref:`Ca |void| **draw_line**\ (\ from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also :ref:`draw_dashed_line()`, :ref:`draw_multiline()`, and :ref:`draw_polyline()`. +Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. The ``from`` and ``to`` positions are defined in local space. See also :ref:`draw_dashed_line()`, :ref:`draw_multiline()`, and :ref:`draw_polyline()`. If ``width`` is negative, then a two-point primitive will be drawn instead of a four-point one. This means that when the CanvasItem is scaled, the line will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -977,7 +977,7 @@ If ``width`` is negative, then a two-point primitive will be drawn instead of a |void| **draw_mesh**\ (\ mesh\: :ref:`Mesh`, texture\: :ref:`Texture2D`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` -Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`MeshInstance2D` for related documentation. +Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`MeshInstance2D` for related documentation. The ``transform`` is defined in local space. .. rst-class:: classref-item-separator @@ -989,7 +989,7 @@ Draws a :ref:`Mesh` in 2D, using the provided texture. See :ref:`Mes |void| **draw_msdf_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline\: :ref:`float` = 0.0, pixel_range\: :ref:`float` = 4.0, scale\: :ref:`float` = 1.0\ ) :ref:`🔗` -Draws a textured rectangle region of the multichannel signed distance field texture at a given position, optionally modulated by a color. See :ref:`FontFile.multichannel_signed_distance_field` for more information and caveats about MSDF font rendering. +Draws a textured rectangle region of the multichannel signed distance field texture at a given position, optionally modulated by a color. The ``rect`` is defined in local space. See :ref:`FontFile.multichannel_signed_distance_field` for more information and caveats about MSDF font rendering. If ``outline`` is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the ``outline`` radius. @@ -1005,7 +1005,7 @@ Value of the ``pixel_range`` should the same that was used during distance field |void| **draw_multiline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws multiple disconnected lines with a uniform ``width`` and ``color``. Each line is defined by two consecutive points from ``points`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw interconnected lines, use :ref:`draw_polyline()` instead. +Draws multiple disconnected lines with a uniform ``width`` and ``color``. Each line is defined by two consecutive points from ``points`` array in local space, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw interconnected lines, use :ref:`draw_polyline()` instead. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -1021,7 +1021,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f |void| **draw_multiline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws multiple disconnected lines with a uniform ``width`` and segment-by-segment coloring. Each segment is defined by two consecutive points from ``points`` array and a corresponding color from ``colors`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints and has ``colors[i]`` color. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw interconnected lines, use :ref:`draw_polyline_colors()` instead. +Draws multiple disconnected lines with a uniform ``width`` and segment-by-segment coloring. Each segment is defined by two consecutive points from ``points`` array in local space and a corresponding color from ``colors`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints and has ``colors[i]`` color. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw interconnected lines, use :ref:`draw_polyline_colors()` instead. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -1037,7 +1037,7 @@ If ``width`` is negative, then two-point primitives will be drawn instead of a f |void| **draw_multiline_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -Breaks ``text`` into lines and draws it using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. +Breaks ``text`` into lines and draws it using the specified ``font`` at the ``pos`` in local space (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. .. rst-class:: classref-item-separator @@ -1049,7 +1049,7 @@ Breaks ``text`` into lines and draws it using the specified ``font`` at the ``po |void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, max_lines\: :ref:`int` = -1, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -Breaks ``text`` to the lines and draws text outline using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. +Breaks ``text`` to the lines and draws text outline using the specified ``font`` at the ``pos`` in local space (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. .. rst-class:: classref-item-separator @@ -1073,7 +1073,7 @@ Draws a :ref:`MultiMesh` in 2D with the provided texture. See : |void| **draw_polygon**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` -Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`draw_colored_polygon()`, each point's color can be changed individually. See also :ref:`draw_polyline()` and :ref:`draw_polyline_colors()`. If you need more flexibility (such as being able to use bones), use :ref:`RenderingServer.canvas_item_add_triangle_array()` instead. +Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`draw_colored_polygon()`, each point's color can be changed individually. The ``points`` array is defined in local space. See also :ref:`draw_polyline()` and :ref:`draw_polyline_colors()`. If you need more flexibility (such as being able to use bones), use :ref:`RenderingServer.canvas_item_add_triangle_array()` instead. \ **Note:** If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with :ref:`Geometry2D.triangulate_polygon()` and using :ref:`draw_mesh()`, :ref:`draw_multimesh()`, or :ref:`RenderingServer.canvas_item_add_triangle_array()`. @@ -1087,7 +1087,7 @@ Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`d |void| **draw_polyline**\ (\ points\: :ref:`PackedVector2Array`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw disconnected lines, use :ref:`draw_multiline()` instead. See also :ref:`draw_polygon()`. +Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). The ``points`` array is defined in local space. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw disconnected lines, use :ref:`draw_multiline()` instead. See also :ref:`draw_polygon()`. If ``width`` is negative, it will be ignored and the polyline will be drawn using :ref:`RenderingServer.PRIMITIVE_LINE_STRIP`. This means that when the CanvasItem is scaled, the polyline will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -1101,7 +1101,7 @@ If ``width`` is negative, it will be ignored and the polyline will be drawn usin |void| **draw_polyline_colors**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws interconnected line segments with a uniform ``width``, point-by-point coloring, and optional antialiasing (supported only for positive ``width``). Colors assigned to line points match by index between ``points`` and ``colors``, i.e. each line segment is filled with a gradient between the colors of the endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw disconnected lines, use :ref:`draw_multiline_colors()` instead. See also :ref:`draw_polygon()`. +Draws interconnected line segments with a uniform ``width``, point-by-point coloring, and optional antialiasing (supported only for positive ``width``). Colors assigned to line points match by index between ``points`` and ``colors``, i.e. each line segment is filled with a gradient between the colors of the endpoints. The ``points`` array is defined in local space. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line()` calls. To draw disconnected lines, use :ref:`draw_multiline_colors()` instead. See also :ref:`draw_polygon()`. If ``width`` is negative, it will be ignored and the polyline will be drawn using :ref:`RenderingServer.PRIMITIVE_LINE_STRIP`. This means that when the CanvasItem is scaled, the polyline will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -1115,7 +1115,7 @@ If ``width`` is negative, it will be ignored and the polyline will be drawn usin |void| **draw_primitive**\ (\ points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`Texture2D` = null\ ) :ref:`🔗` -Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also :ref:`draw_line()`, :ref:`draw_polyline()`, :ref:`draw_polygon()`, and :ref:`draw_rect()`. +Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. The ``points`` array is defined in local space. See also :ref:`draw_line()`, :ref:`draw_polyline()`, :ref:`draw_polygon()`, and :ref:`draw_rect()`. .. rst-class:: classref-item-separator @@ -1127,7 +1127,7 @@ Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for |void| **draw_rect**\ (\ rect\: :ref:`Rect2`, color\: :ref:`Color`, filled\: :ref:`bool` = true, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` -Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. See also :ref:`draw_texture_rect()`. +Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. The ``rect`` is specified in local space. See also :ref:`draw_texture_rect()`. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``. @@ -1147,7 +1147,7 @@ If ``antialiased`` is ``true``, half transparent "feathers" will be attached to |void| **draw_set_transform**\ (\ position\: :ref:`Vector2`, rotation\: :ref:`float` = 0.0, scale\: :ref:`Vector2` = Vector2(1, 1)\ ) :ref:`🔗` -Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. +Sets a custom local transform for drawing via components. Anything drawn afterwards will be transformed by this. \ **Note:** :ref:`FontFile.oversampling` does *not* take ``scale`` into account. This means that scaling up/down will cause bitmap fonts and rasterized (non-MSDF) dynamic fonts to appear blurry or pixelated. To ensure text remains crisp regardless of scale, you can enable MSDF font rendering by enabling :ref:`ProjectSettings.gui/theme/default_font_multichannel_signed_distance_field` (applies to the default project font only), or enabling **Multichannel Signed Distance Field** in the import options of a DynamicFont for custom fonts. On system fonts, :ref:`SystemFont.multichannel_signed_distance_field` can be enabled in the inspector. @@ -1161,7 +1161,7 @@ Sets a custom transform for drawing via components. Anything drawn afterwards wi |void| **draw_set_transform_matrix**\ (\ xform\: :ref:`Transform2D`\ ) :ref:`🔗` -Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. +Sets a custom local transform for drawing via matrix. Anything drawn afterwards will be transformed by this. .. rst-class:: classref-item-separator @@ -1173,7 +1173,7 @@ Sets a custom transform for drawing via matrix. Anything drawn afterwards will b |void| **draw_string**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -Draws ``text`` using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. +Draws ``text`` using the specified ``font`` at the ``pos`` in local space (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. \ **Example:** Draw "Hello world", using the project's default font: @@ -1212,7 +1212,7 @@ See also :ref:`Font.draw_string()`. |void| **draw_string_outline**\ (\ font\: :ref:`Font`, pos\: :ref:`Vector2`, text\: :ref:`String`, alignment\: :ref:`HorizontalAlignment` = 0, width\: :ref:`float` = -1, font_size\: :ref:`int` = 16, size\: :ref:`int` = 1, modulate\: :ref:`Color` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag`\] = 3, direction\: :ref:`Direction` = 0, orientation\: :ref:`Orientation` = 0, oversampling\: :ref:`float` = 0.0\ ) |const| :ref:`🔗` -Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. +Draws ``text`` outline using the specified ``font`` at the ``pos`` in local space (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used. .. rst-class:: classref-item-separator @@ -1224,7 +1224,7 @@ Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left |void| **draw_style_box**\ (\ style_box\: :ref:`StyleBox`, rect\: :ref:`Rect2`\ ) :ref:`🔗` -Draws a styled rectangle. +Draws a styled rectangle. The ``rect`` is defined in local space. .. rst-class:: classref-item-separator @@ -1236,7 +1236,7 @@ Draws a styled rectangle. |void| **draw_texture**\ (\ texture\: :ref:`Texture2D`, position\: :ref:`Vector2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` -Draws a texture at a given position. +Draws a texture at a given position. The ``position`` is defined in local space. .. rst-class:: classref-item-separator @@ -1248,7 +1248,7 @@ Draws a texture at a given position. |void| **draw_texture_rect**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, tile\: :ref:`bool`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) :ref:`🔗` -Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_rect()` and :ref:`draw_texture_rect_region()`. +Draws a textured rectangle at a given position, optionally modulated by a color. The ``rect`` is defined in local space. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_rect()` and :ref:`draw_texture_rect_region()`. .. rst-class:: classref-item-separator @@ -1260,7 +1260,7 @@ Draws a textured rectangle at a given position, optionally modulated by a color. |void| **draw_texture_rect_region**\ (\ texture\: :ref:`Texture2D`, rect\: :ref:`Rect2`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) :ref:`🔗` -Draws a textured rectangle from a texture's region (specified by ``src_rect``) at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_texture_rect()`. +Draws a textured rectangle from a texture's region (specified by ``src_rect``) at a given position in local space, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_texture_rect()`. .. rst-class:: classref-item-separator diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index af9f4087a03..ba8acd5175c 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -446,6 +446,8 @@ Vector pointing upwards, used to determine what is a wall and what is a floor (o Current velocity vector in pixels per second, used and modified during calls to :ref:`move_and_slide()`. +This property should not be set to a value multiplied by ``delta``, because this happens internally in :ref:`move_and_slide()`. Otherwise, the simulation will run at an incorrect speed. + .. rst-class:: classref-item-separator ---- @@ -709,6 +711,8 @@ Returns ``true`` if the body collided only with a wall on the last call of :ref: Moves the body based on :ref:`velocity`. If the body collides with another, it will slide along the other body (by default only on floor) rather than stop immediately. If the other body is a **CharacterBody2D** or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. +This method should be used in :ref:`Node._physics_process()` (or in a method called by :ref:`Node._physics_process()`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. + Modifies :ref:`velocity` if a slide collision occurred. To get the latest collision call :ref:`get_last_slide_collision()`, for detailed information about collisions that occurred, use :ref:`get_slide_collision()`. When the body touches a moving platform, the platform's velocity is automatically added to the body motion. If a collision occurs due to the platform's motion, it will always be first in the slide collisions. diff --git a/classes/class_characterbody3d.rst b/classes/class_characterbody3d.rst index 19b355c4669..1c2bfe992ba 100644 --- a/classes/class_characterbody3d.rst +++ b/classes/class_characterbody3d.rst @@ -450,6 +450,8 @@ Vector pointing upwards, used to determine what is a wall and what is a floor (o Current velocity vector (typically meters per second), used and modified during calls to :ref:`move_and_slide()`. +This property should not be set to a value multiplied by ``delta``, because this happens internally in :ref:`move_and_slide()`. Otherwise, the simulation will run at an incorrect speed. + .. rst-class:: classref-item-separator ---- @@ -704,6 +706,8 @@ Returns ``true`` if the body collided only with a wall on the last call of :ref: Moves the body based on :ref:`velocity`. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a **CharacterBody3D** or :ref:`RigidBody3D`, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. +This method should be used in :ref:`Node._physics_process()` (or in a method called by :ref:`Node._physics_process()`), as it uses the physics step's ``delta`` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. + Modifies :ref:`velocity` if a slide collision occurred. To get the latest collision call :ref:`get_last_slide_collision()`, for more detailed information about collisions that occurred, use :ref:`get_slide_collision()`. When the body touches a moving platform, the platform's velocity is automatically added to the body motion. If a collision occurs due to the platform's motion, it will always be first in the slide collisions. diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 454dffee2bc..70c5e7f8a7d 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -134,7 +134,7 @@ To add a key to an existing dictionary, access it like an existing key and assig -Finally, dictionaries can contain different types of keys and values in the same dictionary: +Finally, untyped dictionaries can contain different types of keys and values in the same dictionary: .. tabs:: @@ -185,6 +185,45 @@ The keys of a dictionary can be iterated with the ``for`` keyword: +To enforce a certain type for keys and values, you can create a *typed dictionary*. Typed dictionaries can only contain keys and values of the given types, or that inherit from the given classes: + + +.. tabs:: + + .. code-tab:: gdscript + + # Creates a typed dictionary with String keys and int values. + # Attempting to use any other type for keys or values will result in an error. + var typed_dict: Dictionary[String, int] = { + "some_key": 1, + "some_other_key": 2, + } + + # Creates a typed dictionary with String keys and values of any type. + # Attempting to use any other type for keys will result in an error. + var typed_dict_key_only: Dictionary[String, Variant] = { + "some_key": 12.34, + "some_other_key": "string", + } + + .. code-tab:: csharp + + // Creates a typed dictionary with String keys and int values. + // Attempting to use any other type for keys or values will result in an error. + var typedDict = new Godot.Collections.Dictionary { + {"some_key", 1}, + {"some_other_key", 2}, + }; + + // Creates a typed dictionary with String keys and values of any type. + // Attempting to use any other type for keys will result in an error. + var typedDictKeyOnly = new Godot.Collections.Dictionary { + {"some_key", 12.34}, + {"some_other_key", "string"}, + }; + + + \ **Note:** Dictionaries are always passed by reference. To get a copy of a dictionary which can be modified independently of the original dictionary, use :ref:`duplicate()`. \ **Note:** Erasing elements while iterating over dictionaries is **not** supported and will result in unpredictable behavior. diff --git a/classes/class_editorexportplatformandroid.rst b/classes/class_editorexportplatformandroid.rst index 9e2c4a42e5a..607aa658de5 100644 --- a/classes/class_editorexportplatformandroid.rst +++ b/classes/class_editorexportplatformandroid.rst @@ -2904,6 +2904,8 @@ Indicates whether the application supports extra large screen form-factors. If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformios.rst b/classes/class_editorexportplatformios.rst index 6eb3c9eebff..19030a84508 100644 --- a/classes/class_editorexportplatformios.rst +++ b/classes/class_editorexportplatformios.rst @@ -3372,6 +3372,8 @@ The reasons your app use user defaults API. See `Describing use of required reas If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformlinuxbsd.rst b/classes/class_editorexportplatformlinuxbsd.rst index 5bd81f4bcbe..d1ed8b4c840 100644 --- a/classes/class_editorexportplatformlinuxbsd.rst +++ b/classes/class_editorexportplatformlinuxbsd.rst @@ -142,6 +142,8 @@ If ``true``, a console wrapper is exported alongside the main executable, which If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformmacos.rst b/classes/class_editorexportplatformmacos.rst index 5634ab36b60..c3707f25579 100644 --- a/classes/class_editorexportplatformmacos.rst +++ b/classes/class_editorexportplatformmacos.rst @@ -3226,6 +3226,8 @@ Indicates whether your app uses data for tracking. See `Privacy manifest files < If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ or Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformvisionos.rst b/classes/class_editorexportplatformvisionos.rst index 37ea28b0d9d..91f3c3c816b 100644 --- a/classes/class_editorexportplatformvisionos.rst +++ b/classes/class_editorexportplatformvisionos.rst @@ -551,7 +551,7 @@ Interpolation method used to resize application icon. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2678,6 +2678,8 @@ The reasons your app use user defaults API. See `Describing use of required reas If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportplatformwindows.rst b/classes/class_editorexportplatformwindows.rst index a0da89037b9..891ac47fefb 100644 --- a/classes/class_editorexportplatformwindows.rst +++ b/classes/class_editorexportplatformwindows.rst @@ -477,6 +477,8 @@ If ``true``, a console wrapper executable is exported alongside the main executa If ``true``, shaders will be compiled and embedded in the application. This option is only supported when using the Forward+ and Mobile renderers. +\ **Note:** When exporting as a dedicated server, the shader baker is always disabled since no rendering is performed. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_editorexportpreset.rst b/classes/class_editorexportpreset.rst index 76f3432ae85..cc82e8a9893 100644 --- a/classes/class_editorexportpreset.rst +++ b/classes/class_editorexportpreset.rst @@ -104,7 +104,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -116,7 +116,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -128,7 +128,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -140,7 +140,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -152,7 +152,7 @@ enum **ExportFilter**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -174,7 +174,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -186,7 +186,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -198,7 +198,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -210,7 +210,7 @@ enum **FileExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -232,7 +232,7 @@ enum **ScriptExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -244,7 +244,7 @@ enum **ScriptExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -256,7 +256,7 @@ enum **ScriptExportMode**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_editornode3dgizmo.rst b/classes/class_editornode3dgizmo.rst index 76166a02aaf..3b0882ccdf8 100644 --- a/classes/class_editornode3dgizmo.rst +++ b/classes/class_editornode3dgizmo.rst @@ -98,7 +98,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index 3d5d18b79d6..6b9a8f77a9e 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -103,7 +103,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_editorsceneformatimporter.rst b/classes/class_editorsceneformatimporter.rst index 9b15889fe2a..f72516d22d5 100644 --- a/classes/class_editorsceneformatimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -64,7 +64,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -76,7 +76,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -88,7 +88,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -100,7 +100,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -112,7 +112,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -124,7 +124,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -136,7 +136,7 @@ Constants .. container:: contribute - There is currently no description for this constant. Please help us by :ref:`contributing one `! + There is currently no description for this constant. Please help us by `contributing one `__! diff --git a/classes/class_editorsceneformatimportergltf.rst b/classes/class_editorsceneformatimportergltf.rst index b265db397ed..57be5fe7ec0 100644 --- a/classes/class_editorsceneformatimportergltf.rst +++ b/classes/class_editorsceneformatimportergltf.rst @@ -14,7 +14,7 @@ EditorSceneFormatImporterGLTF .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_editorscenepostimportplugin.rst b/classes/class_editorscenepostimportplugin.rst index d79ef20b404..ab08b91bf7e 100644 --- a/classes/class_editorscenepostimportplugin.rst +++ b/classes/class_editorscenepostimportplugin.rst @@ -76,7 +76,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -88,7 +88,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -100,7 +100,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -112,7 +112,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -124,7 +124,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -136,7 +136,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -148,7 +148,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -160,7 +160,7 @@ enum **InternalImportCategory**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 5d91ab4fb69..0fcc255d97f 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -23,6 +23,8 @@ Object that holds the project-independent editor settings. These settings are ge Property names use slash delimiters to distinguish sections. Setting values can be of any :ref:`Variant` type. It's recommended to use ``snake_case`` for editor settings to be consistent with the Redot editor itself. +Editor settings are saved automatically when changed. + Accessing the settings can be done using the following methods, such as: @@ -2457,7 +2459,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2471,7 +2473,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2485,7 +2487,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2499,7 +2501,7 @@ The modulate color to use for "past" frames displayed in the animation editor's .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3606,7 +3608,7 @@ Tab style of editor docks. The language to use for the editor interface. -Translations are provided by the community. If you spot a mistake, :doc:`contribute to editor translations on Weblate! <../contributing/documentation/editor_and_docs_localization>` +Translations are provided by the community. If you spot a mistake, `contribute to editor translations on Weblate! `__ .. rst-class:: classref-item-separator diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 5c4c2a93492..27e59d8eb39 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -72,8 +72,6 @@ Methods +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_godot_compatible_version_info`\ (\ ) |const| | +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Dictionary` | :ref:`get_godot_donor_info`\ (\ ) |const| | - +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_license_info`\ (\ ) |const| | +----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_license_text`\ (\ ) |const| | @@ -358,11 +356,7 @@ Every :ref:`Dictionary` contains a ``name`` identifier, and a Returns a :ref:`Dictionary` of categorized donor names. Each entry is an :ref:`Array` of strings: -{``platinum_sponsors``, ``gold_sponsors``, ``silver_sponsors``, ``bronze_sponsors``, ``mini_sponsors``, ``gold_donors``, ``silver_donors``, ``bronze_donors``} - -See also :ref:`get_godot_donor_info()` for Godot's donor info. - -\ **Warning:** All donor names are empty. This currently maintained for compatibility with Redot. +{``donors``} .. rst-class:: classref-item-separator @@ -463,22 +457,6 @@ See also :ref:`get_version_info()` for Red ---- -.. _class_Engine_method_get_godot_donor_info: - -.. rst-class:: classref-method - -:ref:`Dictionary` **get_godot_donor_info**\ (\ ) |const| :ref:`🔗` - -Returns a :ref:`Dictionary` of categorized donor names for Godot. Each entry is an :ref:`Array` of strings: - -{``platinum_sponsors``, ``gold_sponsors``, ``silver_sponsors``, ``bronze_sponsors``, ``mini_sponsors``, ``gold_donors``, ``silver_donors``, ``bronze_donors``} - -See also :ref:`get_donor_info()` for Redot's donor info. - -.. rst-class:: classref-item-separator - ----- - .. _class_Engine_method_get_license_info: .. rst-class:: classref-method diff --git a/classes/class_environment.rst b/classes/class_environment.rst index c89f52f73d5..b270dabab19 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -1989,6 +1989,8 @@ If ``true``, screen-space reflections are enabled. Screen-space reflections are \ **Note:** SSR is only supported in the Forward+ rendering method, not Mobile or Compatibility. +\ **Note:** SSR is not supported on viewports that have a transparent background (where :ref:`Viewport.transparent_bg` is ``true``). + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index bcd11fe87df..d3bfd49fcaa 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -314,7 +314,7 @@ The maximum force the linear motor will apply while trying to reach the velocity .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -326,7 +326,7 @@ The maximum force the linear motor will apply while trying to reach the velocity .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -338,7 +338,7 @@ The maximum force the linear motor will apply while trying to reach the velocity .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -422,7 +422,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -434,7 +434,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -446,7 +446,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -492,7 +492,7 @@ If enabled, rotational motion is possible within the given limits. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -504,7 +504,7 @@ If enabled, rotational motion is possible within the given limits. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1117,7 +1117,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1136,7 +1136,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1155,7 +1155,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1174,7 +1174,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1193,7 +1193,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1212,7 +1212,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1231,7 +1231,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1250,7 +1250,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1269,7 +1269,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1288,7 +1288,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1307,7 +1307,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1326,7 +1326,7 @@ Target speed for the motor at the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1804,7 +1804,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1823,7 +1823,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1842,7 +1842,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1861,7 +1861,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1880,7 +1880,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1899,7 +1899,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1918,7 +1918,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1937,7 +1937,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1956,7 +1956,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1975,7 +1975,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1994,7 +1994,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2013,7 +2013,7 @@ The speed that the linear motor will attempt to reach on the Z axis. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -2032,7 +2032,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2046,7 +2046,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2060,7 +2060,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2074,7 +2074,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2088,7 +2088,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2102,7 +2102,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2116,7 +2116,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2130,7 +2130,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2144,7 +2144,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2158,7 +2158,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2172,7 +2172,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2186,7 +2186,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index 7bcfcf8b784..6da1f806c2e 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -14,7 +14,7 @@ GLTFAnimation .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group @@ -73,7 +73,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index f9ae5b4e098..1fb07068b1a 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -14,7 +14,7 @@ GLTFDocumentExtensionConvertImporterMesh .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group diff --git a/classes/class_gltflight.rst b/classes/class_gltflight.rst index 4984c530d09..cc5cc0b3c43 100644 --- a/classes/class_gltflight.rst +++ b/classes/class_gltflight.rst @@ -228,7 +228,7 @@ Create a new GLTFLight instance from the given Redot :ref:`Light3D`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -242,7 +242,7 @@ Create a new GLTFLight instance from the given Redot :ref:`Light3D`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index cb11a4a1152..a2db9d5e2e8 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -14,7 +14,7 @@ GLTFSkeleton .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group @@ -83,7 +83,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -104,7 +104,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -125,7 +125,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -139,7 +139,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -165,7 +165,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -179,7 +179,7 @@ Returns a :ref:`Dictionary` that maps skeleton bone indices to .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Sets a :ref:`Dictionary` that maps skeleton bone indices to th .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 4e9cea4a8a5..b09c1288351 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -14,7 +14,7 @@ GLTFSkin .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-introduction-group @@ -91,7 +91,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -110,7 +110,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -131,7 +131,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -152,7 +152,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -173,7 +173,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedInt32Array` for more details. @@ -194,7 +194,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -213,7 +213,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -232,7 +232,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -246,7 +246,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -260,7 +260,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -274,7 +274,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -288,7 +288,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -302,7 +302,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index 3f3e8d7f7b4..a6406c3d6a4 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -261,7 +261,7 @@ The folder path associated with this glTF data. This is used to find other files .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -297,7 +297,7 @@ The copyright string in the asset header of the glTF file. This is set during im .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -386,7 +386,7 @@ The original raw JSON document corresponding to this GLTFState. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -405,7 +405,7 @@ The original raw JSON document corresponding to this GLTFState. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -460,7 +460,7 @@ The name of the scene. When importing, if not specified, this will be the file n .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -519,7 +519,7 @@ The ``parent_node_index`` parameter is the index of the parent :ref:`GLTFNode`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -583,7 +583,7 @@ Returns an array of all :ref:`GLTFAnimation`\ s in the glTF .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -609,7 +609,7 @@ Returns an array of all :ref:`GLTFCamera`\ s in the glTF file. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -647,7 +647,7 @@ Returns an array of all :ref:`GLTFLight`\ s in the glTF file. T .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -749,7 +749,7 @@ Retrieves the array of texture samplers that are used by the textures contained .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -787,7 +787,7 @@ Returns an array of unique node names. This is used in both the import process a .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -827,7 +827,7 @@ Sets the :ref:`GLTFAnimation`\ s in the state. When importi .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -853,7 +853,7 @@ Sets the :ref:`GLTFCamera`\ s in the state. These are the came .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -891,7 +891,7 @@ Sets the :ref:`GLTFLight`\ s in the state. These are the lights .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -965,7 +965,7 @@ Sets the array of texture samplers that are used by the textures contained in th .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 59a0933261e..0371b10622c 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -264,7 +264,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -276,7 +276,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -288,7 +288,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -300,7 +300,7 @@ enum **TransformAlign**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -504,7 +504,7 @@ The number of draw passes when rendering particles. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -826,7 +826,7 @@ The amount of time the particle's trail should represent (in seconds). Only effe .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 27c0b1dfcd0..702fbb11f9c 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -1664,7 +1664,7 @@ The icon for the zoom reset button. .. container:: contribute - There is currently no description for this theme property. Please help us by :ref:`contributing one `! + There is currently no description for this theme property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 452c931ef5a..eeb42f02a42 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -265,7 +265,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 8047e15175a..01715e3014e 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -501,7 +501,9 @@ Maximum number of allowed redirects. - |void| **set_timeout**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_timeout**\ (\ ) -The duration to wait in seconds before a request times out. If :ref:`timeout` is set to ``0.0`` then the request will never time out. For simple requests, such as communication with a REST API, it is recommended that :ref:`timeout` is set to a value suitable for the server response time (e.g. between ``1.0`` and ``10.0``). This will help prevent unwanted timeouts caused by variation in server response times while still allowing the application to detect when a request has timed out. For larger requests such as file downloads it is suggested the :ref:`timeout` be set to ``0.0``, disabling the timeout functionality. This will help to prevent large transfers from failing due to exceeding the timeout value. +The duration to wait before a request times out, in seconds (independent of :ref:`Engine.time_scale`). If :ref:`timeout` is set to ``0.0``, the request will never time out. + +For simple requests, such as communication with a REST API, it is recommended to set :ref:`timeout` to a value suitable for the server response time (commonly between ``1.0`` and ``10.0``). This will help prevent unwanted timeouts caused by variation in response times while still allowing the application to detect when a request has timed out. For larger requests such as file downloads, it is recommended to set :ref:`timeout` to ``0.0``, disabling the timeout functionality. This will help prevent large transfers from failing due to exceeding the timeout value. .. rst-class:: classref-item-separator diff --git a/classes/class_imageformatloader.rst b/classes/class_imageformatloader.rst index b172f34844b..a06d42aeb10 100644 --- a/classes/class_imageformatloader.rst +++ b/classes/class_imageformatloader.rst @@ -46,7 +46,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -58,7 +58,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -70,7 +70,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_imageframesformatloader.rst b/classes/class_imageframesformatloader.rst index c9751dd0549..ad10315718a 100644 --- a/classes/class_imageframesformatloader.rst +++ b/classes/class_imageframesformatloader.rst @@ -46,7 +46,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -58,7 +58,7 @@ flags **LoaderFlags**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_imageframesformatloaderextension.rst b/classes/class_imageframesformatloaderextension.rst index a3e4d6615e6..780ba722011 100644 --- a/classes/class_imageframesformatloaderextension.rst +++ b/classes/class_imageframesformatloaderextension.rst @@ -58,7 +58,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index 4afa6bffe88..307d09969c3 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -14,7 +14,7 @@ ImporterMeshInstance3D .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -68,7 +68,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -87,7 +87,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -106,7 +106,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -125,7 +125,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -144,7 +144,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -182,7 +182,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -201,7 +201,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -220,7 +220,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -239,7 +239,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 181d86410d8..deeafc4216a 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -1460,7 +1460,7 @@ Font size of the item's text. :ref:`StyleBox` **focus** :ref:`🔗` -The focused style for the **ItemList**, drawn on top of the background, but below everything else. +The focused style for the **ItemList**, drawn on top of everything. .. rst-class:: classref-item-separator diff --git a/classes/class_javascriptbridge.rst b/classes/class_javascriptbridge.rst index 0424be0b8f7..8406dcf8037 100644 --- a/classes/class_javascriptbridge.rst +++ b/classes/class_javascriptbridge.rst @@ -21,14 +21,14 @@ Description The JavaScriptBridge singleton is implemented only in the Web export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. -\ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See :doc:`Compiling for the Web <../contributing/development/compiling/compiling_for_web>` in the documentation for more information. +\ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See :doc:`Compiling for the Web <../engine_details/development/compiling/compiling_for_web>` in the documentation for more information. .. rst-class:: classref-introduction-group Tutorials --------- -- `Exporting for the Web: Calling JavaScript from script <../tutorials/export/exporting_for_web.html#calling-javascript-from-script>`__ +- :doc:`The JavaScriptBridge singleton <../tutorials/platform/web/javascript_bridge>` .. rst-class:: classref-reftable-group diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index 1b067be9abe..09b00864edc 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -12,6 +12,8 @@ JSONRPC **Inherits:** :ref:`Object` +**Inherited By:** :ref:`MCPProtocol` + A helper to handle dictionaries which look like JSONRPC documents. .. rst-class:: classref-introduction-group @@ -201,7 +203,7 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index 3a7abb7ec76..4ad2a0ee892 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -515,6 +515,8 @@ The light's color in the nonlinear sRGB color space. An *overbright* color can b The light will affect objects in the selected layers. +\ **Note:** The light cull mask is ignored by :ref:`VoxelGI`, SDFGI, :ref:`LightmapGI`, and volumetric fog. These will always render lights in a way that ignores the cull mask. See also :ref:`VisualInstance3D.layers`. + .. rst-class:: classref-item-separator ---- @@ -841,7 +843,7 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index e7d6dba572e..db8dbc2c41b 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -171,7 +171,7 @@ Implemented on desktop platforms if the crash handler is enabled. Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). -Specific to the macOS platform. +Implemented on desktop and web platforms. .. _class_MainLoop_constant_NOTIFICATION_APPLICATION_RESUMED: diff --git a/classes/class_mcpbridge.rst b/classes/class_mcpbridge.rst new file mode 100644 index 00000000000..cb7042420c5 --- /dev/null +++ b/classes/class_mcpbridge.rst @@ -0,0 +1,58 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/modules/mcp/doc_classes/MCPBridge.xml. + +.. _class_MCPBridge: + +MCPBridge +========= + +**Inherits:** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by `contributing one `__! + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +--------+----------------------------------------------------+ + | |void| | :ref:`update`\ (\ ) | + +--------+----------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_MCPBridge_method_update: + +.. rst-class:: classref-method + +|void| **update**\ (\ ) :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_mcpprotocol.rst b/classes/class_mcpprotocol.rst new file mode 100644 index 00000000000..cef0208957d --- /dev/null +++ b/classes/class_mcpprotocol.rst @@ -0,0 +1,58 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/modules/mcp/doc_classes/MCPProtocol.xml. + +.. _class_MCPProtocol: + +MCPProtocol +=========== + +**Inherits:** :ref:`JSONRPC` **<** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by `contributing one `__! + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_initialized`\ (\ ) |const| | + +-------------------------+------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_MCPProtocol_method_is_initialized: + +.. rst-class:: classref-method + +:ref:`bool` **is_initialized**\ (\ ) |const| :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_mcpserver.rst b/classes/class_mcpserver.rst new file mode 100644 index 00000000000..6b30cb71724 --- /dev/null +++ b/classes/class_mcpserver.rst @@ -0,0 +1,90 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/modules/mcp/doc_classes/MCPServer.xml. + +.. _class_MCPServer: + +MCPServer +========= + +**Inherits:** :ref:`Object` + +.. container:: contribute + + There is currently no description for this class. Please help us by `contributing one `__! + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+--------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_running`\ (\ ) |const| | + +-------------------------+--------------------------------------------------------------------+ + | |void| | :ref:`start`\ (\ ) | + +-------------------------+--------------------------------------------------------------------+ + | |void| | :ref:`stop`\ (\ ) | + +-------------------------+--------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_MCPServer_method_is_running: + +.. rst-class:: classref-method + +:ref:`bool` **is_running**\ (\ ) |const| :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. rst-class:: classref-item-separator + +---- + +.. _class_MCPServer_method_start: + +.. rst-class:: classref-method + +|void| **start**\ (\ ) :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. rst-class:: classref-item-separator + +---- + +.. _class_MCPServer_method_stop: + +.. rst-class:: classref-method + +|void| **stop**\ (\ ) :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 5d9b18e70b3..ab52068ed67 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -192,7 +192,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedFloat32Array` for more details. diff --git a/classes/class_node.rst b/classes/class_node.rst index 45d0cc7be52..80a09533798 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1105,7 +1105,7 @@ Implemented on desktop platforms, if the crash handler is enabled. Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string). -Implemented only on macOS. +Implemented on desktop and web platforms. .. _class_Node_constant_NOTIFICATION_APPLICATION_RESUMED: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 26c88335a80..9913b202cc2 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -396,7 +396,7 @@ Rotates the node so that its local +X axis points towards the ``point``, which i |void| **move_local_x**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) :ref:`🔗` -Applies a local translation on the node's X axis based on the :ref:`Node._process()`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. +Applies a local translation on the node's X axis with the amount specified in ``delta``. If ``scaled`` is ``false``, normalizes the movement to occur independently of the node's :ref:`scale`. .. rst-class:: classref-item-separator @@ -408,7 +408,7 @@ Applies a local translation on the node's X axis based on the :ref:`Node._proces |void| **move_local_y**\ (\ delta\: :ref:`float`, scaled\: :ref:`bool` = false\ ) :ref:`🔗` -Applies a local translation on the node's Y axis based on the :ref:`Node._process()`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. +Applies a local translation on the node's Y axis with the amount specified in ``delta``. If ``scaled`` is ``false``, normalizes the movement to occur independently of the node's :ref:`scale`. .. rst-class:: classref-item-separator diff --git a/classes/class_object.rst b/classes/class_object.rst index f905a572c01..4e7ef9f03b5 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapper`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`ShaderIncludeDB`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorInterface`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorUndoRedoManager`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`FramebufferCacheRD`, :ref:`GDExtensionManager`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`Input`, :ref:`InputMap`, :ref:`IP`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MCPBridge`, :ref:`MCPServer`, :ref:`MovieWriter`, :ref:`NativeMenu`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OpenXRExtensionWrapper`, :ref:`OpenXRInteractionProfileMetadata`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderData`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`RenderSceneData`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`ShaderIncludeDB`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`UniformSetCacheRD`, :ref:`WorkerThreadPool`, :ref:`XRServer`, :ref:`XRVRS` Base class for all other classes in the engine. @@ -56,7 +56,7 @@ Lastly, every object can also contain metadata (data about data). :ref:`set_meta Tutorials --------- -- :doc:`Object class introduction <../contributing/development/core_and_modules/object_class>` +- :doc:`Object class introduction <../engine_details/architecture/object_class>` - :doc:`When and how to avoid using nodes for everything <../tutorials/best_practices/node_alternatives>` diff --git a/classes/class_oggpacketsequenceplayback.rst b/classes/class_oggpacketsequenceplayback.rst index 8eade964d7c..4f3248f4a06 100644 --- a/classes/class_oggpacketsequenceplayback.rst +++ b/classes/class_oggpacketsequenceplayback.rst @@ -14,7 +14,7 @@ OggPacketSequencePlayback .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_omnilight3d.rst b/classes/class_omnilight3d.rst index cce392a484d..6cb2db2cccc 100644 --- a/classes/class_omnilight3d.rst +++ b/classes/class_omnilight3d.rst @@ -152,7 +152,7 @@ The light's radius. Note that the effectively lit area may appear to be smaller .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_openxraction.rst b/classes/class_openxraction.rst index afb1e559b97..50f0fcbf24e 100644 --- a/classes/class_openxraction.rst +++ b/classes/class_openxraction.rst @@ -90,7 +90,7 @@ This action provides a :ref:`Vector2` value and can be bound to e .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index fc5649eab8b..04edf6772c8 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -14,7 +14,7 @@ PacketPeerExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -51,7 +51,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index f2e5c49c825..08b5e7f9439 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -61,7 +61,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -80,7 +80,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index 047e30179c9..417e9e8e3be 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -481,7 +481,7 @@ Use with :ref:`set_particle_flag()`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -585,7 +585,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -597,7 +597,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -609,7 +609,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -621,7 +621,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -633,7 +633,7 @@ enum **SubEmitterMode**: :ref:`🔗 .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst index 9f1ef30f299..3d8ad634f65 100644 --- a/classes/class_physicsdirectbodystate2dextension.rst +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -290,7 +290,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_m .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -304,7 +304,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.center_of_m .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -642,7 +642,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_vel .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -656,7 +656,7 @@ Implement to override the behavior of :ref:`PhysicsDirectBodyState2D.angular_vel .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index fb42c946418..0ece4b4b8dd 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -309,7 +309,7 @@ The body's linear velocity in units per second. .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_physicsdirectbodystate3dextension.rst b/classes/class_physicsdirectbodystate3dextension.rst index 5d80ac0bbc7..08e74c3a3d7 100644 --- a/classes/class_physicsdirectbodystate3dextension.rst +++ b/classes/class_physicsdirectbodystate3dextension.rst @@ -150,7 +150,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -164,7 +164,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -178,7 +178,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -192,7 +192,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -206,7 +206,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -220,7 +220,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -234,7 +234,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -248,7 +248,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -262,7 +262,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -276,7 +276,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -290,7 +290,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -304,7 +304,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -318,7 +318,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -332,7 +332,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -346,7 +346,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -360,7 +360,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -374,7 +374,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -388,7 +388,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -402,7 +402,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -416,7 +416,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -430,7 +430,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -444,7 +444,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -458,7 +458,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -472,7 +472,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -486,7 +486,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -500,7 +500,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -514,7 +514,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -528,7 +528,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -542,7 +542,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -556,7 +556,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -570,7 +570,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -584,7 +584,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -598,7 +598,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -612,7 +612,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -626,7 +626,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -640,7 +640,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -654,7 +654,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -668,7 +668,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -682,7 +682,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -696,7 +696,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -710,7 +710,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -724,7 +724,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -738,7 +738,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -752,7 +752,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -766,7 +766,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -780,7 +780,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -794,7 +794,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -808,7 +808,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -822,7 +822,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -836,7 +836,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst index c65f74320e4..54975eb596a 100644 --- a/classes/class_physicsdirectspacestate2dextension.rst +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -64,7 +64,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -78,7 +78,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -92,7 +92,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -106,7 +106,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -120,7 +120,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -134,7 +134,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -148,7 +148,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index 8df56ca7f35..71f688a131f 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -66,7 +66,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -80,7 +80,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -94,7 +94,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -108,7 +108,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -122,7 +122,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -136,7 +136,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -150,7 +150,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -164,7 +164,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index 1ebd157f43f..9309342b5ef 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -548,7 +548,7 @@ The speed with which the rotation across the axis perpendicular to the hinge get .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -930,7 +930,7 @@ The maximum force that the linear motor can apply while trying to reach the targ .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -942,7 +942,7 @@ The maximum force that the linear motor can apply while trying to reach the targ .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -954,7 +954,7 @@ The maximum force that the linear motor can apply while trying to reach the targ .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1038,7 +1038,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1050,7 +1050,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1062,7 +1062,7 @@ Maximum acceleration for the motor at the axes. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1108,7 +1108,7 @@ If set, rotational motion is possible. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1120,7 +1120,7 @@ If set, rotational motion is possible. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1788,7 +1788,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1800,7 +1800,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1812,7 +1812,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1824,7 +1824,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1836,7 +1836,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -1848,7 +1848,7 @@ enum **BodyAxis**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2111,7 +2111,7 @@ By counting (or keeping track of) the shapes that enter and exit, it can be dete .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2161,7 +2161,7 @@ Substitutes a given area shape by another. The old shape is selected by its inde .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2583,7 +2583,7 @@ Returns a body state. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2659,7 +2659,7 @@ Restores the default inertia and center of mass based on shapes to cancel any cu .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2859,7 +2859,7 @@ Substitutes a given body shape by another. The old shape is selected by its inde .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2939,7 +2939,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2953,7 +2953,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2967,7 +2967,7 @@ Returns ``true`` if a collision would result from moving along a motion vector f .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3005,7 +3005,7 @@ Sets a cone twist joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3019,7 +3019,7 @@ Sets a cone twist joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3033,7 +3033,7 @@ Sets a cone twist joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3119,7 +3119,7 @@ Returns the value of a physics engine state specified by ``process_info``. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3181,7 +3181,7 @@ Sets a hinge joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3195,7 +3195,7 @@ Sets a hinge joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3257,7 +3257,7 @@ Returns whether the bodies attached to the :ref:`Joint3D` will co .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3283,7 +3283,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3297,7 +3297,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3311,7 +3311,7 @@ Make the joint a generic six degrees of freedom (6DOF) joint. Use :ref:`generic_ .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3409,7 +3409,7 @@ Sets a pin joint parameter. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -4075,7 +4075,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -4089,7 +4089,7 @@ Sets the value for a space parameter. A list of available parameters is on the : .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index 74770c2bec4..da7567683ef 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -442,7 +442,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -456,7 +456,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -470,7 +470,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -484,7 +484,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -498,7 +498,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -512,7 +512,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -526,7 +526,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -540,7 +540,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -554,7 +554,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -568,7 +568,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -582,7 +582,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -596,7 +596,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -610,7 +610,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -624,7 +624,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -638,7 +638,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -652,7 +652,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -666,7 +666,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -680,7 +680,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -694,7 +694,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -708,7 +708,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -722,7 +722,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -736,7 +736,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -750,7 +750,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -764,7 +764,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -778,7 +778,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -792,7 +792,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -806,7 +806,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -820,7 +820,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -834,7 +834,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -848,7 +848,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -862,7 +862,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -876,7 +876,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -890,7 +890,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -904,7 +904,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -918,7 +918,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -932,7 +932,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -946,7 +946,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -960,7 +960,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -974,7 +974,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -988,7 +988,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1002,7 +1002,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1016,7 +1016,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1030,7 +1030,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1044,7 +1044,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1058,7 +1058,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1072,7 +1072,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1086,7 +1086,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1100,7 +1100,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1114,7 +1114,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1128,7 +1128,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1142,7 +1142,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1156,7 +1156,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1170,7 +1170,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1184,7 +1184,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1198,7 +1198,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1212,7 +1212,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1226,7 +1226,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1240,7 +1240,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1254,7 +1254,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1268,7 +1268,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1282,7 +1282,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1296,7 +1296,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1310,7 +1310,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1324,7 +1324,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1338,7 +1338,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1352,7 +1352,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1366,7 +1366,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1380,7 +1380,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1394,7 +1394,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1408,7 +1408,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1422,7 +1422,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1436,7 +1436,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1450,7 +1450,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1464,7 +1464,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1478,7 +1478,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1492,7 +1492,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1506,7 +1506,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1520,7 +1520,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1534,7 +1534,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1548,7 +1548,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1562,7 +1562,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1576,7 +1576,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1590,7 +1590,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1604,7 +1604,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1618,7 +1618,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1632,7 +1632,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1646,7 +1646,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1660,7 +1660,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1674,7 +1674,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1688,7 +1688,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1702,7 +1702,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1716,7 +1716,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1730,7 +1730,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1744,7 +1744,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1758,7 +1758,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1772,7 +1772,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1786,7 +1786,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1800,7 +1800,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1814,7 +1814,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1828,7 +1828,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1842,7 +1842,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1856,7 +1856,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1870,7 +1870,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1884,7 +1884,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1898,7 +1898,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1912,7 +1912,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1926,7 +1926,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1940,7 +1940,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1954,7 +1954,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1968,7 +1968,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1982,7 +1982,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1996,7 +1996,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2010,7 +2010,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2024,7 +2024,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2038,7 +2038,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2052,7 +2052,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2066,7 +2066,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2080,7 +2080,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2094,7 +2094,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2108,7 +2108,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2122,7 +2122,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2136,7 +2136,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2150,7 +2150,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2164,7 +2164,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2178,7 +2178,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2192,7 +2192,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2206,7 +2206,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2220,7 +2220,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2234,7 +2234,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2248,7 +2248,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2262,7 +2262,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2276,7 +2276,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2290,7 +2290,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2304,7 +2304,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2318,7 +2318,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2332,7 +2332,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2346,7 +2346,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2360,7 +2360,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2374,7 +2374,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2388,7 +2388,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2402,7 +2402,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2416,7 +2416,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2430,7 +2430,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2444,7 +2444,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2458,7 +2458,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2472,7 +2472,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2486,7 +2486,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2500,7 +2500,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2514,7 +2514,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2528,7 +2528,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2542,7 +2542,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2556,7 +2556,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2570,7 +2570,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2584,7 +2584,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2598,7 +2598,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2612,7 +2612,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2626,7 +2626,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2640,7 +2640,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2654,7 +2654,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2668,7 +2668,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2682,7 +2682,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2696,7 +2696,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2710,7 +2710,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2724,7 +2724,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2738,7 +2738,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2752,7 +2752,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2766,7 +2766,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2780,7 +2780,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2794,7 +2794,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2808,7 +2808,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2822,7 +2822,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2836,7 +2836,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2850,7 +2850,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2864,7 +2864,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2878,7 +2878,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2892,7 +2892,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2906,7 +2906,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2920,7 +2920,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2934,7 +2934,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2948,7 +2948,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2962,7 +2962,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2976,7 +2976,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -2990,7 +2990,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3004,7 +3004,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3018,7 +3018,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3032,7 +3032,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3046,7 +3046,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3060,7 +3060,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3074,7 +3074,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3088,7 +3088,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3102,7 +3102,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3116,7 +3116,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3130,7 +3130,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3144,7 +3144,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3158,7 +3158,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -3172,7 +3172,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index f17c66a9cee..21fd61fa94b 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -14,7 +14,7 @@ PolygonPathFinder .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -59,7 +59,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -73,7 +73,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -87,7 +87,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -101,7 +101,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -115,7 +115,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -169,7 +169,7 @@ Returns ``true`` if ``point`` falls inside the polygon area. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index 722db1b2126..dec0123621e 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -90,7 +90,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -102,7 +102,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -114,7 +114,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -126,7 +126,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -138,7 +138,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -150,7 +150,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -162,7 +162,7 @@ enum **CompressionMode**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 2c0f42d7bb4..5d1e06f4991 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -1271,6 +1271,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/2d/use_edge_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/2d/warnings/navmesh_cell_size_mismatch` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/2d/warnings/navmesh_edge_merge_errors` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`navigation/3d/default_cell_height` | ``0.25`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`navigation/3d/default_cell_size` | ``0.25`` | @@ -1285,6 +1289,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/3d/use_edge_connections` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/3d/warnings/navmesh_cell_size_mismatch` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`navigation/3d/warnings/navmesh_edge_merge_errors` | ``true`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/avoidance/thread_model/avoidance_use_high_priority_threads` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`navigation/avoidance/thread_model/avoidance_use_multiple_threads` | ``true`` | @@ -1497,7 +1505,7 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/driver/threads/thread_model` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | :ref:`Color` | :ref:`rendering/environment/defaults/default_clear_color` | ``Color(0.128, 0.128, 0.128, 1)`` | + | :ref:`Color` | :ref:`rendering/environment/defaults/default_clear_color` | ``Color(0.14, 0.14, 0.14, 1)`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rendering/environment/defaults/default_environment` | ``""`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ @@ -1992,7 +2000,9 @@ If ``true``, :ref:`AnimationMixer` prints the warning of n :ref:`Color` **application/boot_splash/bg_color** = ``Color(0.14, 0.14, 0.14, 1)`` :ref:`🔗` -Background color for the boot splash. +.. container:: contribute + + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -4714,7 +4724,11 @@ Main window initial position. \ ``1`` - "Primary Screen Center". -\ ``2`` - "Other Screen Center", :ref:`display/window/size/initial_screen` is used to set the screen. +\ ``3`` - "Other Screen Center", :ref:`display/window/size/initial_screen` is used to set the screen. + +\ ``4`` - "Center of Screen With Mouse Pointer". + +\ ``5`` - "Center of Screen With Keyboard Focus". \ **Note:** This setting only affects the exported project, or when the project is run from the command line. In the editor, the value of :ref:`EditorSettings.run/window_placement/rect` is used instead. @@ -4896,7 +4910,7 @@ On desktop platforms, overrides the game's initial window width. See also :ref:` .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -5062,7 +5076,7 @@ The maximum width to use when importing textures as an atlas. The value will be .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -5332,7 +5346,7 @@ Search path for project-specific script templates. Redot will search for script .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -5346,7 +5360,7 @@ Search path for project-specific script templates. Redot will search for script .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9748,6 +9762,30 @@ If enabled 2D navigation regions will use edge connections to connect with other ---- +.. _class_ProjectSettings_property_navigation/2d/warnings/navmesh_cell_size_mismatch: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/2d/warnings/navmesh_cell_size_mismatch** = ``true`` :ref:`🔗` + +If ``true``, the navigation system will print warnings when a navigation mesh with a small cell size is used on a navigation map with a larger size as this commonly causes rasterization errors. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_navigation/2d/warnings/navmesh_edge_merge_errors: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/2d/warnings/navmesh_edge_merge_errors** = ``true`` :ref:`🔗` + +If ``true``, the navigation system will print warnings about navigation mesh edge merge errors occurring in navigation regions or maps. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_navigation/3d/default_cell_height: .. rst-class:: classref-property @@ -9832,6 +9870,30 @@ If enabled 3D navigation regions will use edge connections to connect with other ---- +.. _class_ProjectSettings_property_navigation/3d/warnings/navmesh_cell_size_mismatch: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/3d/warnings/navmesh_cell_size_mismatch** = ``true`` :ref:`🔗` + +If ``true``, the navigation system will print warnings when a navigation mesh with a small cell size (or in 3D height) is used on a navigation map with a larger size as this commonly causes rasterization errors. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_navigation/3d/warnings/navmesh_edge_merge_errors: + +.. rst-class:: classref-property + +:ref:`bool` **navigation/3d/warnings/navmesh_edge_merge_errors** = ``true`` :ref:`🔗` + +If ``true``, the navigation system will print warnings about navigation mesh edge merge errors occurring in navigation regions or maps. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_navigation/avoidance/thread_model/avoidance_use_high_priority_threads: .. rst-class:: classref-property @@ -11362,7 +11424,7 @@ The thread model to use for rendering. Rendering on a thread may improve perform .. rst-class:: classref-property -:ref:`Color` **rendering/environment/defaults/default_clear_color** = ``Color(0.128, 0.128, 0.128, 1)`` :ref:`🔗` +:ref:`Color` **rendering/environment/defaults/default_clear_color** = ``Color(0.14, 0.14, 0.14, 1)`` :ref:`🔗` Default background clear color. Overridable per :ref:`Viewport` using its :ref:`Environment`. See :ref:`Environment.background_mode` and :ref:`Environment.background_color` in particular. To change this default color programmatically, use :ref:`RenderingServer.set_default_clear_color()`. @@ -12222,7 +12284,7 @@ Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv** = ``2`` :ref:`🔗` -The subdivision amount of the first quadrant on the shadow atlas. See the `documentation <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. +The subdivision amount of the first quadrant on the shadow atlas. See the `documentation <../tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. .. rst-class:: classref-item-separator @@ -12234,7 +12296,7 @@ The subdivision amount of the first quadrant on the shadow atlas. See the `docum :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv** = ``2`` :ref:`🔗` -The subdivision amount of the second quadrant on the shadow atlas. See the `documentation <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. +The subdivision amount of the second quadrant on the shadow atlas. See the `documentation <../tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. .. rst-class:: classref-item-separator @@ -12246,7 +12308,7 @@ The subdivision amount of the second quadrant on the shadow atlas. See the `docu :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv** = ``3`` :ref:`🔗` -The subdivision amount of the third quadrant on the shadow atlas. See the `documentation <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. +The subdivision amount of the third quadrant on the shadow atlas. See the `documentation <../tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. .. rst-class:: classref-item-separator @@ -12258,7 +12320,7 @@ The subdivision amount of the third quadrant on the shadow atlas. See the `docum :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv** = ``4`` :ref:`🔗` -The subdivision amount of the fourth quadrant on the shadow atlas. See the `documentation <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. +The subdivision amount of the fourth quadrant on the shadow atlas. See the `documentation <../tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. .. rst-class:: classref-item-separator @@ -12270,7 +12332,7 @@ The subdivision amount of the fourth quadrant on the shadow atlas. See the `docu :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size** = ``4096`` :ref:`🔗` -The size of the shadow atlas used for :ref:`OmniLight3D` and :ref:`SpotLight3D` nodes. See the `documentation <../tutorials/tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. +The size of the shadow atlas used for :ref:`OmniLight3D` and :ref:`SpotLight3D` nodes. See the `documentation <../tutorials/3d/lights_and_shadows.html#shadow-atlas>`__ for more information. .. rst-class:: classref-item-separator @@ -12434,7 +12496,7 @@ The minimum number of instances that must be present in a scene to enable cullin .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13136,7 +13198,7 @@ Scales the 3D render buffer based on the viewport size uses an image filter spec .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13162,7 +13224,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13176,7 +13238,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -13190,7 +13252,7 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 7ddd79d3d6d..b6f7a105882 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SignalSmith`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 98c435431f1..10a3b8b07a4 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -2385,7 +2385,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2397,7 +2397,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2409,7 +2409,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2421,7 +2421,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2433,7 +2433,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2445,7 +2445,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2457,7 +2457,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2469,7 +2469,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2481,7 +2481,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2493,7 +2493,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2505,7 +2505,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2517,7 +2517,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2529,7 +2529,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2541,7 +2541,7 @@ VRAM-compressed unsigned floating-point data format with normalized value and no .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -3185,7 +3185,7 @@ flags **StorageBufferUsage**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4074,7 +4074,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4086,7 +4086,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4098,7 +4098,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4110,7 +4110,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4122,7 +4122,7 @@ Allows dynamically changing the depth bias. .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 9c9356d3fb8..8aab890f83d 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -2196,7 +2196,7 @@ Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolu .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2650,7 +2650,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2662,7 +2662,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2674,7 +2674,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2686,7 +2686,7 @@ enum **ParticlesTransformAlign**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2750,7 +2750,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2762,7 +2762,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2774,7 +2774,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2786,7 +2786,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2798,7 +2798,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2810,7 +2810,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2822,7 +2822,7 @@ enum **ParticlesCollisionType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2844,7 +2844,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2856,7 +2856,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2868,7 +2868,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2880,7 +2880,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2892,7 +2892,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -2904,7 +2904,7 @@ enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -4032,7 +4032,7 @@ The callback is called after our transparent rendering pass, but before any buil .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -5342,7 +5342,7 @@ Parent is used for clipping child, but parent is also drawn underneath child as .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -6041,7 +6041,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6053,7 +6053,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6065,7 +6065,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6077,7 +6077,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -6089,7 +6089,7 @@ The number of custom data arrays available (:ref:`ARRAY_CUSTOM0`! + There is currently no description for this constant. Please help us by `contributing one `__! @@ -7088,7 +7088,7 @@ This is useful when moving an occluder to a new location, to give an instantaneo .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -7472,7 +7472,7 @@ Sets the shape of the occluder polygon. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -8182,7 +8182,7 @@ Sets the variables to be used with the screen-space reflections (SSR) post-proce .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9316,7 +9316,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9330,7 +9330,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9344,7 +9344,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9358,7 +9358,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9384,7 +9384,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9398,7 +9398,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9412,7 +9412,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9426,7 +9426,7 @@ Used to inform the renderer what exposure normalization value was used while bak .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9552,7 +9552,7 @@ Sets a shader material's shader. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9566,7 +9566,7 @@ Sets a shader material's shader. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9610,7 +9610,7 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9660,7 +9660,7 @@ Returns a mesh's custom aabb. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9710,7 +9710,7 @@ Sets a mesh's custom aabb. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9856,7 +9856,7 @@ Sets a mesh's surface's material. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9882,7 +9882,7 @@ Updates the index buffer of the mesh surface with the given ``data``. The expect .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9896,7 +9896,7 @@ Updates the index buffer of the mesh surface with the given ``data``. The expect .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -9910,7 +9910,7 @@ Updates the index buffer of the mesh surface with the given ``data``. The expect .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10598,7 +10598,7 @@ Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUPartic .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10744,7 +10744,7 @@ Sets the value that informs a :ref:`ParticleProcessMaterial`! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10844,7 +10844,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10858,7 +10858,7 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -10884,7 +10884,7 @@ If ``enable`` is ``true``, enables trails for the ``particles`` with the specifi .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11350,7 +11350,7 @@ Sets the path hint for the specified shader. This should generally match the :re .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11438,7 +11438,7 @@ Returns the number of bones allocated for this skeleton. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11762,7 +11762,7 @@ Returns the internal graphics handle for this texture object. For use when commu .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11840,7 +11840,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11854,7 +11854,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -11868,7 +11868,7 @@ Replaces ``texture``'s texture data by the texture specified by the ``by_texture .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12601,7 +12601,7 @@ To place in a scene, attach this notifier to an instance using :ref:`instance_se .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12615,7 +12615,7 @@ To place in a scene, attach this notifier to an instance using :ref:`instance_se .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12629,7 +12629,7 @@ To place in a scene, attach this notifier to an instance using :ref:`instance_se .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12659,7 +12659,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12673,7 +12673,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12687,7 +12687,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12701,7 +12701,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12715,7 +12715,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -12729,7 +12729,7 @@ Once finished with your RID, you will want to free the RID using the RenderingSe .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index afc8859815f..8e6677a40d4 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -129,7 +129,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -143,7 +143,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_resourceimporterspriteframes.rst b/classes/class_resourceimporterspriteframes.rst index 08d986d174b..ce64fe5b481 100644 --- a/classes/class_resourceimporterspriteframes.rst +++ b/classes/class_resourceimporterspriteframes.rst @@ -14,7 +14,7 @@ ResourceImporterSpriteFrames .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group diff --git a/classes/class_resourceimportertexture.rst b/classes/class_resourceimportertexture.rst index 1a9e1df79b6..c5b23411e1b 100644 --- a/classes/class_resourceimportertexture.rst +++ b/classes/class_resourceimportertexture.rst @@ -249,7 +249,7 @@ Changing this import option only has an effect if a texture is detected as being :ref:`bool` **editor/convert_colors_with_editor_theme** = ``false`` :ref:`🔗` -If ``true``, converts the imported image's colors to match :ref:`EditorSettings.interface/theme/icon_and_font_color`. This assumes the image uses the exact same colors as :doc:`Godot's own color palette for editor icons <../contributing/development/editor/creating_icons>`, with the source file designed for a dark editor theme. This should be enabled for editor plugin icons and custom class icons, but should be left disabled otherwise. +If ``true``, converts the imported image's colors to match :ref:`EditorSettings.interface/theme/icon_and_font_color`. This assumes the image uses the exact same colors as :doc:`Godot's own color palette for editor icons <../engine_details/editor/creating_icons>`, with the source file designed for a dark editor theme. This should be enabled for editor plugin icons and custom class icons, but should be left disabled otherwise. \ **Note:** Only available for SVG images. diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index d1c76ac2c49..7b536fd3ff9 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -14,7 +14,7 @@ ScriptExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -117,7 +117,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -131,7 +131,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -145,7 +145,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -159,7 +159,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -173,7 +173,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -187,7 +187,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -201,7 +201,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -215,7 +215,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -229,7 +229,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -243,7 +243,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -257,7 +257,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -271,7 +271,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -285,7 +285,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -299,7 +299,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -313,7 +313,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -339,7 +339,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -353,7 +353,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -367,7 +367,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -381,7 +381,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -395,7 +395,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -409,7 +409,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -423,7 +423,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -437,7 +437,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -451,7 +451,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -465,7 +465,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -479,7 +479,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -493,7 +493,7 @@ Return the expected argument count for the given ``method``, or ``null`` if it c .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -519,7 +519,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -533,7 +533,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -547,7 +547,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -561,7 +561,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -575,7 +575,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -589,7 +589,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -603,7 +603,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -617,7 +617,7 @@ Returns ``true`` if the script is an abstract script. Abstract scripts cannot be .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index 7b17d9f947a..aab792066b8 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -16,7 +16,7 @@ ScriptLanguage .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-section-separator @@ -41,7 +41,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -53,7 +53,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -65,7 +65,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -77,7 +77,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -89,7 +89,7 @@ enum **ScriptNameCasing**: :ref:`🔗` .. container:: contribute - There is currently no description for this enum. Please help us by :ref:`contributing one `! + There is currently no description for this enum. Please help us by `contributing one `__! diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 5309bb3ad5d..a57f7f0f846 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -14,7 +14,7 @@ ScriptLanguageExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -169,7 +169,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -181,7 +181,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -193,7 +193,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -205,7 +205,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -217,7 +217,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -229,7 +229,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -241,7 +241,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -263,7 +263,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -275,7 +275,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -287,7 +287,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -299,7 +299,7 @@ enum **LookupResultType**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -363,7 +363,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -375,7 +375,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -387,7 +387,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -399,7 +399,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -411,7 +411,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -423,7 +423,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -435,7 +435,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -447,7 +447,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -459,7 +459,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -471,7 +471,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -483,7 +483,7 @@ enum **CodeCompletionKind**: :ref:`🔗`! + There is currently no description for this enum. Please help us by `contributing one `__! @@ -504,7 +504,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -518,7 +518,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -532,7 +532,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -546,7 +546,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -560,7 +560,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -574,7 +574,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -588,7 +588,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -602,7 +602,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -616,7 +616,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -630,7 +630,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -644,7 +644,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -658,7 +658,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -672,7 +672,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -686,7 +686,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -700,7 +700,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -714,7 +714,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -740,7 +740,7 @@ Returns the source associated with a given debug stack position. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -766,7 +766,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -780,7 +780,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -794,7 +794,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -808,7 +808,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -822,7 +822,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -836,7 +836,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -850,7 +850,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -864,7 +864,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -878,7 +878,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -892,7 +892,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -906,7 +906,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -920,7 +920,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -934,7 +934,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -948,7 +948,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -962,7 +962,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -976,7 +976,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1002,7 +1002,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1016,7 +1016,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1030,7 +1030,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1044,7 +1044,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1058,7 +1058,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1072,7 +1072,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1086,7 +1086,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1100,7 +1100,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1114,7 +1114,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1128,7 +1128,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1142,7 +1142,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1156,7 +1156,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1170,7 +1170,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1184,7 +1184,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1198,7 +1198,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1212,7 +1212,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1226,7 +1226,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1240,7 +1240,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1254,7 +1254,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1268,7 +1268,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1282,7 +1282,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1296,7 +1296,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1310,7 +1310,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -1324,7 +1324,7 @@ Returns the line where the function is defined in the code, or ``-1`` if the fun .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_signalsmith.rst b/classes/class_signalsmith.rst new file mode 100644 index 00000000000..5e2b4c82541 --- /dev/null +++ b/classes/class_signalsmith.rst @@ -0,0 +1,195 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Redot engine sources. +.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SignalSmith.xml. + +.. _class_SignalSmith: + +SignalSmith +=========== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +Performs time-stretching and pitch-shifting on raw audio buffers using Signalsmith. + +.. rst-class:: classref-introduction-group + +Description +----------- + +SignalSmith is a low-level audio processing utility which wraps the Signalsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | + +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_SignalSmith_method_change_tempo: + +.. rst-class:: classref-method + +:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` + +Loads an MP3 file, applies time-stretching and pitch-shifting using the Signalsmith engine, and returns a streamable AudioStreamWAV. + +The `tempo` parameter controls playback speed without affecting pitch. A value of `1.0` preserves the original speed. + +The `pitch` parameter is a transpose factor. A value of `1.0` preserves pitch, `2.0` raises pitch by one octave, + +and `0.5` lowers pitch by one octave. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_get_last_channels: + +.. rst-class:: classref-method + +:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_get_last_sample_rate: + +.. rst-class:: classref-method + +:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` + +.. container:: contribute + + There is currently no description for this method. Please help us by `contributing one `__! + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_process: + +.. rst-class:: classref-method + +:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` + +Processes a block of interleaved audio samples and returns a new buffer containing the time-stretched and pitch-shifted result. + +The effective playback speed is determined by the ratio of input samples to output samples, as influenced by the current tempo setting. The input buffer must contain 32-bit floating-point PCM data and be interleaved according to the configured channel count. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_reset: + +.. rst-class:: classref-method + +|void| **reset**\ (\ ) :ref:`🔗` + +Resets the internal processing state. + +This should be called when restarting playback or discontinuously changing input streams. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_set_channels: + +.. rst-class:: classref-method + +|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` + +Sets the number of audio channels. + +Input and output buffers are expected to be interleaved according to this channel count. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_set_pitch: + +.. rst-class:: classref-method + +|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` + +Sets the pitch transpose factor. + +A value of `1.0` leaves pitch unchanged. Values greater than `1.0` raise pitch, while values less than `1.0` lower pitch. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_set_sample_rate: + +.. rst-class:: classref-method + +|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` + +Sets the sample rate, in Hz, used by the internal processing engine. + +Changing the sample rate resets the internal state. + +.. rst-class:: classref-item-separator + +---- + +.. _class_SignalSmith_method_set_tempo: + +.. rst-class:: classref-method + +|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` + +Sets the tempo multiplier used during processing. + +This value influences the ratio between input and output buffer sizes during time-stretching. A value of `1.0` preserves the original tempo, values greater than `1.0` speed up playback, and values less than `1.0` slow it down. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` +.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` +.. |void| replace:: :abbr:`void (No return value.)` diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index 823a1411914..d317429f91c 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -443,7 +443,7 @@ Removes the global pose override on all bones in the skeleton. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_skin.rst b/classes/class_skin.rst index b362436f58e..f21d6615cee 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -14,7 +14,7 @@ Skin .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -121,7 +121,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -149,7 +149,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -191,7 +191,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 9bb9d8cd3bb..aeca16481f5 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -14,7 +14,7 @@ StreamPeerExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -53,7 +53,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -67,7 +67,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -81,7 +81,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -95,7 +95,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -109,7 +109,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 6787c68601c..e22f840de0e 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -181,7 +181,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -195,7 +195,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -221,7 +221,7 @@ Virtual method to be implemented by the user. Returns a custom minimum size that .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 6fe45d639ff..51e10ca7faf 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -2232,7 +2232,7 @@ Returns ``true`` if ``string`` is a valid identifier. .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_variant.rst b/classes/class_variant.rst index 74e5bd96d16..4d8cfa9bd65 100644 --- a/classes/class_variant.rst +++ b/classes/class_variant.rst @@ -130,7 +130,7 @@ Modifications to a container will modify all references to it. A :ref:`Mutex` +- :doc:`Variant class introduction <../engine_details/architecture/variant_class>` .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_vector2i.rst b/classes/class_vector2i.rst index cd09c93490e..4d5e3ca3bd4 100644 --- a/classes/class_vector2i.rst +++ b/classes/class_vector2i.rst @@ -706,7 +706,7 @@ Divides each component of the **Vector2i** by the given :ref:`float :: - print(Vector2i(10, 20) / 2.9) # Prints (5.0, 10.0) + print(Vector2i(1, 2) / 2.5) # Prints (0.4, 0.8) .. rst-class:: classref-item-separator diff --git a/classes/class_vector3i.rst b/classes/class_vector3i.rst index b4a54c6293e..b8bfa9602d1 100644 --- a/classes/class_vector3i.rst +++ b/classes/class_vector3i.rst @@ -730,7 +730,7 @@ Divides each component of the **Vector3i** by the given :ref:`float :: - print(Vector3i(10, 20, 30) / 2.9) # Prints (5.0, 10.0, 15.0) + print(Vector3i(1, 2, 3) / 2.5) # Prints (0.4, 0.8, 1.2) .. rst-class:: classref-item-separator diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 737240fe9e9..d95dd6a55c0 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -697,7 +697,7 @@ Returns a Vector4 value due to floating-point operations. :: - print(Vector4i(10, 20, 30, 40) / 2) # Prints (5.0, 10.0, 15.0, 20.0) + print(Vector4i(1, 2, 3, 4) / 2.5) # Prints (0.4, 0.8, 1.2, 1.6) .. rst-class:: classref-item-separator diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index ee5b4274571..7a0fbcd6f9c 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -1930,6 +1930,8 @@ To control this property on the root viewport, set the :ref:`ProjectSettings.ren If ``true``, the viewport should render its background as transparent. +\ **Note:** Due to technical limitations, certain rendering features are disabled when a viewport has a transparent background. This currently applies to screen-space reflections, subsurface scattering, and depth of field. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index 3a66b024b01..911069e1ddf 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -146,7 +146,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator diff --git a/classes/class_visualshadernoderemap.rst b/classes/class_visualshadernoderemap.rst index 5449e39bb75..ee5abb3f613 100644 --- a/classes/class_visualshadernoderemap.rst +++ b/classes/class_visualshadernoderemap.rst @@ -134,7 +134,7 @@ Property Descriptions .. container:: contribute - There is currently no description for this property. Please help us by :ref:`contributing one `! + There is currently no description for this property. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index 1787e5770f9..e60789d7947 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -219,7 +219,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -247,7 +247,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -261,7 +261,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -275,7 +275,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -289,7 +289,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -303,7 +303,7 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index de4b8634084..f8d8c9c5892 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -16,7 +16,7 @@ WebRTCDataChannel .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 4e45eafdbf9..d383b8f40a0 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -14,7 +14,7 @@ WebRTCDataChannelExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -121,7 +121,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -149,7 +149,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -191,7 +191,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -219,7 +219,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -233,7 +233,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -247,7 +247,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -261,7 +261,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -275,7 +275,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -289,7 +289,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -303,7 +303,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -317,7 +317,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index ac8c4f8e7cc..190d315c9f2 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -14,7 +14,7 @@ WebRTCPeerConnectionExtension .. container:: contribute - There is currently no description for this class. Please help us by :ref:`contributing one `! + There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group @@ -65,7 +65,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -79,7 +79,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -93,7 +93,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -107,7 +107,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -121,7 +121,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -135,7 +135,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -149,7 +149,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -163,7 +163,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -177,7 +177,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -191,7 +191,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -205,7 +205,7 @@ Method Descriptions .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/class_webxrinterface.rst b/classes/class_webxrinterface.rst index d1b47533550..a7a64d00f6e 100644 --- a/classes/class_webxrinterface.rst +++ b/classes/class_webxrinterface.rst @@ -448,7 +448,7 @@ If a user's browser or device doesn't support one of the given features, initial This doesn't have any effect on the interface when already initialized. -Possible values come from `WebXR's XRReferenceSpaceType `__, or include other features like ``"hand-tracking"`` to enable hand tracking. +See the MDN documentation on `WebXR's session features `__ for a list of possible values. .. rst-class:: classref-item-separator @@ -512,7 +512,7 @@ If a user's browser or device doesn't support one of the given features, initial This doesn't have any effect on the interface when already initialized. -Possible values come from `WebXR's XRReferenceSpaceType `__, or include other features like ``"hand-tracking"`` to enable hand tracking. +See the MDN documentation on `WebXR's session features `__ for a list of possible values. .. rst-class:: classref-item-separator diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index 3fdac530de7..43106888598 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -357,7 +357,7 @@ Returns the number of views this interface requires, 1 for mono, 2 for stereosco .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -527,7 +527,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -541,7 +541,7 @@ Blits our render results to screen optionally applying lens distortion. This can .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator @@ -567,7 +567,7 @@ Returns a valid :ref:`RID` for a texture to which we should render th .. container:: contribute - There is currently no description for this method. Please help us by :ref:`contributing one `! + There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` diff --git a/classes/index.rst b/classes/index.rst index 88369963ca5..4eba42a0b5a 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -835,6 +835,9 @@ Other objects class_logger class_mainloop class_marshalls + class_mcpbridge + class_mcpprotocol + class_mcpserver class_meshconvexdecompositionsettings class_meshdatatool class_methodtweener @@ -966,6 +969,7 @@ Other objects class_scriptlanguageextension class_semaphore class_shaderincludedb + class_signalsmith class_skinreference class_streampeer class_streampeerbuffer