classref: Sync with current master branch (45fc515)

Author: Godot Organization

classes/class_animation.rst

@@ -67,15 +67,15 @@ Properties
 .. table::
    :widths: auto
 
-   +------------------------------------------+--------------------------------------------------------------------+---------------+
-   | :ref:`bool<class_bool>`                  | :ref:`capture_included<class_Animation_property_capture_included>` | ``false``     |
-   +------------------------------------------+--------------------------------------------------------------------+---------------+
-   | :ref:`float<class_float>`                | :ref:`length<class_Animation_property_length>`                     | ``1.0``       |
-   +------------------------------------------+--------------------------------------------------------------------+---------------+
-   | :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_Animation_property_loop_mode>`               | ``0``         |
-   +------------------------------------------+--------------------------------------------------------------------+---------------+
-   | :ref:`float<class_float>`                | :ref:`step<class_Animation_property_step>`                         | ``0.0333333`` |
-   +------------------------------------------+--------------------------------------------------------------------+---------------+
+   +------------------------------------------+--------------------------------------------------------------------+-----------------+
+   | :ref:`bool<class_bool>`                  | :ref:`capture_included<class_Animation_property_capture_included>` | ``false``       |
+   +------------------------------------------+--------------------------------------------------------------------+-----------------+
+   | :ref:`float<class_float>`                | :ref:`length<class_Animation_property_length>`                     | ``1.0``         |
+   +------------------------------------------+--------------------------------------------------------------------+-----------------+
+   | :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_Animation_property_loop_mode>`               | ``0``           |
+   +------------------------------------------+--------------------------------------------------------------------+-----------------+
+   | :ref:`float<class_float>`                | :ref:`step<class_Animation_property_step>`                         | ``0.033333335`` |
+   +------------------------------------------+--------------------------------------------------------------------+-----------------+
 
 .. rst-class:: classref-reftable-group
 
@@ -585,7 +585,7 @@ Determines the behavior of both ends of the animation timeline during animation
 
 .. rst-class:: classref-property
 
-:ref:`float<class_float>` **step** = ``0.0333333`` :ref:`🔗<class_Animation_property_step>`
+:ref:`float<class_float>` **step** = ``0.033333335`` :ref:`🔗<class_Animation_property_step>`
 
 .. rst-class:: classref-property-setget
 

classes/class_animationnodeoneshot.rst

@@ -291,7 +291,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio
 
 The fade-in duration. For example, setting this to ``1.0`` for a 5 second length animation will produce a cross-fade that starts at 0 second and ends at 1 second during the animation.
 
-\ **Note:** **AnimationNodeOneShot** transitions the current state after the end of the fading. When :ref:`AnimationNodeOutput<class_AnimationNodeOutput>` is considered as the most upstream, so the :ref:`fadein_time<class_AnimationNodeOneShot_property_fadein_time>` is scaled depending on the downstream delta. For example, if this value is set to ``1.0`` and a :ref:`AnimationNodeTimeScale<class_AnimationNodeTimeScale>` with a value of ``2.0`` is chained downstream, the actual processing time will be 0.5 second.
+\ **Note:** **AnimationNodeOneShot** transitions the current state after the fading has finished.
 
 .. rst-class:: classref-item-separator
 
@@ -327,7 +327,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio
 
 The fade-out duration. For example, setting this to ``1.0`` for a 5 second length animation will produce a cross-fade that starts at 4 second and ends at 5 second during the animation.
 
-\ **Note:** **AnimationNodeOneShot** transitions the current state after the end of the fading. When :ref:`AnimationNodeOutput<class_AnimationNodeOutput>` is considered as the most upstream, so the :ref:`fadeout_time<class_AnimationNodeOneShot_property_fadeout_time>` is scaled depending on the downstream delta. For example, if this value is set to ``1.0`` and an :ref:`AnimationNodeTimeScale<class_AnimationNodeTimeScale>` with a value of ``2.0`` is chained downstream, the actual processing time will be 0.5 second.
+\ **Note:** **AnimationNodeOneShot** transitions the current state after the fading has finished.
 
 .. rst-class:: classref-item-separator
 

classes/class_basematerial3d.rst

@@ -143,6 +143,8 @@ Properties
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`bool<class_bool>`                                         | :ref:`fixed_size<class_BaseMaterial3D_property_fixed_size>`                                                       | ``false``             |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
+   | :ref:`float<class_float>`                                       | :ref:`fov_override<class_BaseMaterial3D_property_fov_override>`                                                   | ``75.0``              |
+   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`bool<class_bool>`                                         | :ref:`grow<class_BaseMaterial3D_property_grow>`                                                                   | ``false``             |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`float<class_float>`                                       | :ref:`grow_amount<class_BaseMaterial3D_property_grow_amount>`                                                     | ``0.0``               |
@@ -251,10 +253,14 @@ Properties
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`Transparency<enum_BaseMaterial3D_Transparency>`           | :ref:`transparency<class_BaseMaterial3D_property_transparency>`                                                   | ``0``                 |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
+   | :ref:`bool<class_bool>`                                         | :ref:`use_fov_override<class_BaseMaterial3D_property_use_fov_override>`                                           | ``false``             |
+   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`bool<class_bool>`                                         | :ref:`use_particle_trails<class_BaseMaterial3D_property_use_particle_trails>`                                     | ``false``             |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`bool<class_bool>`                                         | :ref:`use_point_size<class_BaseMaterial3D_property_use_point_size>`                                               | ``false``             |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
+   | :ref:`bool<class_bool>`                                         | :ref:`use_z_clip_scale<class_BaseMaterial3D_property_use_z_clip_scale>`                                           | ``false``             |
+   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`Vector3<class_Vector3>`                                   | :ref:`uv1_offset<class_BaseMaterial3D_property_uv1_offset>`                                                       | ``Vector3(0, 0, 0)``  |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`Vector3<class_Vector3>`                                   | :ref:`uv1_scale<class_BaseMaterial3D_property_uv1_scale>`                                                         | ``Vector3(1, 1, 1)``  |
@@ -279,6 +285,8 @@ Properties
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
    | :ref:`bool<class_bool>`                                         | :ref:`vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>`                       | ``false``             |
    +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
+   | :ref:`float<class_float>`                                       | :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>`                                                   | ``1.0``               |
+   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
 
 .. rst-class:: classref-reftable-group
 
@@ -1141,11 +1149,27 @@ Disables receiving depth-based or volumetric fog.
 
 Disables specular occlusion.
 
+.. _class_BaseMaterial3D_constant_FLAG_USE_Z_CLIP_SCALE:
+
+.. rst-class:: classref-enumeration-constant
+
+:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_Z_CLIP_SCALE** = ``23``
+
+Enables using :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>`.
+
+.. _class_BaseMaterial3D_constant_FLAG_USE_FOV_OVERRIDE:
+
+.. rst-class:: classref-enumeration-constant
+
+:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_FOV_OVERRIDE** = ``24``
+
+Enables using :ref:`fov_override<class_BaseMaterial3D_property_fov_override>`.
+
 .. _class_BaseMaterial3D_constant_FLAG_MAX:
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``23``
+:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``25``
 
 Represents the size of the :ref:`Flags<enum_BaseMaterial3D_Flags>` enum.
 
@@ -2316,6 +2340,25 @@ If ``true``, the object is rendered at the same size regardless of distance. The
 
 ----
 
+.. _class_BaseMaterial3D_property_fov_override:
+
+.. rst-class:: classref-property
+
+:ref:`float<class_float>` **fov_override** = ``75.0`` :ref:`🔗<class_BaseMaterial3D_property_fov_override>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_fov_override**\ (\ value\: :ref:`float<class_float>`\ )
+- :ref:`float<class_float>` **get_fov_override**\ (\ )
+
+Overrides the :ref:`Camera3D<class_Camera3D>`'s field of view angle (in degrees).
+
+\ **Note:** This behaves as if the field of view is set on a :ref:`Camera3D<class_Camera3D>` with :ref:`Camera3D.keep_aspect<class_Camera3D_property_keep_aspect>` set to :ref:`Camera3D.KEEP_HEIGHT<class_Camera3D_constant_KEEP_HEIGHT>`. Additionally, it may not look correct on a non-perspective camera where the field of view setting is ignored.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_BaseMaterial3D_property_grow:
 
 .. rst-class:: classref-property
@@ -3266,6 +3309,23 @@ The material's transparency mode. Some transparency modes will disable shadow ca
 
 ----
 
+.. _class_BaseMaterial3D_property_use_fov_override:
+
+.. rst-class:: classref-property
+
+:ref:`bool<class_bool>` **use_fov_override** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_use_fov_override>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
+- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
+
+If ``true`` use :ref:`fov_override<class_BaseMaterial3D_property_fov_override>` to override the :ref:`Camera3D<class_Camera3D>`'s field of view angle.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_BaseMaterial3D_property_use_particle_trails:
 
 .. rst-class:: classref-property
@@ -3302,6 +3362,23 @@ If ``true``, render point size can be changed.
 
 ----
 
+.. _class_BaseMaterial3D_property_use_z_clip_scale:
+
+.. rst-class:: classref-property
+
+:ref:`bool<class_bool>` **use_z_clip_scale** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_use_z_clip_scale>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
+- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
+
+If ``true`` use :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>` to scale the object being rendered towards the camera to avoid clipping into things like walls.
+
+.. rst-class:: classref-item-separator
+
+----
+
 .. _class_BaseMaterial3D_property_uv1_offset:
 
 .. rst-class:: classref-property
@@ -3508,6 +3585,23 @@ If ``true``, vertex colors are considered to be stored in sRGB color space and a
 
 If ``true``, the vertex color is used as albedo color.
 
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_BaseMaterial3D_property_z_clip_scale:
+
+.. rst-class:: classref-property
+
+:ref:`float<class_float>` **z_clip_scale** = ``1.0`` :ref:`🔗<class_BaseMaterial3D_property_z_clip_scale>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_z_clip_scale**\ (\ value\: :ref:`float<class_float>`\ )
+- :ref:`float<class_float>` **get_z_clip_scale**\ (\ )
+
+Scales the object being rendered towards the camera to avoid clipping into things like walls. This is intended to be used for objects that are fixed with respect to the camera like player arms, tools, etc. Lighting and shadows will continue to work correctly when this setting is adjusted, but screen-space effects like SSAO and SSR may break with lower scales. Therefore, try to keep this setting as close to ``1.0`` as possible.
+
 .. rst-class:: classref-section-separator
 
 ----

classes/class_capsuleshape2d.rst

@@ -31,11 +31,13 @@ Properties
 .. table::
    :widths: auto
 
-   +---------------------------+-----------------------------------------------------+----------+
-   | :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``30.0`` |
-   +---------------------------+-----------------------------------------------------+----------+
-   | :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
-   +---------------------------+-----------------------------------------------------+----------+
+   +---------------------------+-------------------------------------------------------------+----------+
+   | :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>`         | ``30.0`` |
+   +---------------------------+-------------------------------------------------------------+----------+
+   | :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleShape2D_property_mid_height>` |          |
+   +---------------------------+-------------------------------------------------------------+----------+
+   | :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>`         | ``10.0`` |
+   +---------------------------+-------------------------------------------------------------+----------+
 
 .. rst-class:: classref-section-separator
 
@@ -57,7 +59,24 @@ Property Descriptions
 - |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
 - :ref:`float<class_float>` **get_height**\ (\ )
 
-The capsule's height.
+The capsule's full height, including the semicircles.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_CapsuleShape2D_property_mid_height:
+
+.. rst-class:: classref-property
+
+:ref:`float<class_float>` **mid_height** :ref:`🔗<class_CapsuleShape2D_property_mid_height>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
+- :ref:`float<class_float>` **get_mid_height**\ (\ )
+
+The capsule's height, excluding the semicircles. This is the height of the central rectangular part in the middle of the capsule, and is the distance between the centers of the two semicircles. This is a wrapper for :ref:`height<class_CapsuleShape2D_property_height>`.
 
 .. rst-class:: classref-item-separator
 

classes/class_capsuleshape3d.rst

@@ -38,11 +38,13 @@ Properties
 .. table::
    :widths: auto
 
-   +---------------------------+-----------------------------------------------------+---------+
-   | :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>` | ``2.0`` |
-   +---------------------------+-----------------------------------------------------+---------+
-   | :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>` | ``0.5`` |
-   +---------------------------+-----------------------------------------------------+---------+
+   +---------------------------+-------------------------------------------------------------+---------+
+   | :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>`         | ``2.0`` |
+   +---------------------------+-------------------------------------------------------------+---------+
+   | :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleShape3D_property_mid_height>` |         |
+   +---------------------------+-------------------------------------------------------------+---------+
+   | :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>`         | ``0.5`` |
+   +---------------------------+-------------------------------------------------------------+---------+
 
 .. rst-class:: classref-section-separator
 
@@ -64,7 +66,24 @@ Property Descriptions
 - |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
 - :ref:`float<class_float>` **get_height**\ (\ )
 
-The capsule's height.
+The capsule's full height, including the hemispheres.
+
+.. rst-class:: classref-item-separator
+
+----
+
+.. _class_CapsuleShape3D_property_mid_height:
+
+.. rst-class:: classref-property
+
+:ref:`float<class_float>` **mid_height** :ref:`🔗<class_CapsuleShape3D_property_mid_height>`
+
+.. rst-class:: classref-property-setget
+
+- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
+- :ref:`float<class_float>` **get_mid_height**\ (\ )
+
+The capsule's height, excluding the hemispheres. This is the height of the central cylindrical part in the middle of the capsule, and is the distance between the centers of the two hemispheres. This is a wrapper for :ref:`height<class_CapsuleShape3D_property_height>`.
 
 .. rst-class:: classref-item-separator