Skip to content

Commit 5c0ea92

Browse files
skyace65skyace65
authored
Merge pull request #10961 from godotengine/classref/sync-45fc515
classref: Sync with current master branch (45fc515)
2 parents 67743e9 + d4a8f7f commit 5c0ea92

34 files changed

+3382
-337
lines changed

‎classes/class_animation.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ Properties
6767
.. table::
6868
:widths: auto
6969

70-
+------------------------------------------+--------------------------------------------------------------------+---------------+
71-
| :ref:`bool<class_bool>` | :ref:`capture_included<class_Animation_property_capture_included>` | ``false`` |
72-
+------------------------------------------+--------------------------------------------------------------------+---------------+
73-
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` | ``1.0`` |
74-
+------------------------------------------+--------------------------------------------------------------------+---------------+
75-
| :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_Animation_property_loop_mode>` | ``0`` |
76-
+------------------------------------------+--------------------------------------------------------------------+---------------+
77-
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` | ``0.0333333`` |
78-
+------------------------------------------+--------------------------------------------------------------------+---------------+
70+
+------------------------------------------+--------------------------------------------------------------------+-----------------+
71+
| :ref:`bool<class_bool>` | :ref:`capture_included<class_Animation_property_capture_included>` | ``false`` |
72+
+------------------------------------------+--------------------------------------------------------------------+-----------------+
73+
| :ref:`float<class_float>` | :ref:`length<class_Animation_property_length>` | ``1.0`` |
74+
+------------------------------------------+--------------------------------------------------------------------+-----------------+
75+
| :ref:`LoopMode<enum_Animation_LoopMode>` | :ref:`loop_mode<class_Animation_property_loop_mode>` | ``0`` |
76+
+------------------------------------------+--------------------------------------------------------------------+-----------------+
77+
| :ref:`float<class_float>` | :ref:`step<class_Animation_property_step>` | ``0.033333335`` |
78+
+------------------------------------------+--------------------------------------------------------------------+-----------------+
7979

8080
.. rst-class:: classref-reftable-group
8181

@@ -585,7 +585,7 @@ Determines the behavior of both ends of the animation timeline during animation
585585

586586
.. rst-class:: classref-property
587587

588-
:ref:`float<class_float>` **step** = ``0.0333333`` :ref:`🔗<class_Animation_property_step>`
588+
:ref:`float<class_float>` **step** = ``0.033333335`` :ref:`🔗<class_Animation_property_step>`
589589

590590
.. rst-class:: classref-property-setget
591591

‎classes/class_animationnodeoneshot.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio
291291

292292
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.
293293

294-
\ **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.
294+
\ **Note:** **AnimationNodeOneShot** transitions the current state after the fading has finished.
295295

296296
.. rst-class:: classref-item-separator
297297

@@ -327,7 +327,7 @@ Determines how cross-fading between animations is eased. If empty, the transitio
327327

328328
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.
329329

330-
\ **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.
330+
\ **Note:** **AnimationNodeOneShot** transitions the current state after the fading has finished.
331331

332332
.. rst-class:: classref-item-separator
333333

‎classes/class_basematerial3d.rst‎

Lines changed: 95 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,8 @@ Properties
143143
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
144144
| :ref:`bool<class_bool>` | :ref:`fixed_size<class_BaseMaterial3D_property_fixed_size>` | ``false`` |
145145
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
146+
| :ref:`float<class_float>` | :ref:`fov_override<class_BaseMaterial3D_property_fov_override>` | ``75.0`` |
147+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
146148
| :ref:`bool<class_bool>` | :ref:`grow<class_BaseMaterial3D_property_grow>` | ``false`` |
147149
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
148150
| :ref:`float<class_float>` | :ref:`grow_amount<class_BaseMaterial3D_property_grow_amount>` | ``0.0`` |
@@ -251,10 +253,14 @@ Properties
251253
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
252254
| :ref:`Transparency<enum_BaseMaterial3D_Transparency>` | :ref:`transparency<class_BaseMaterial3D_property_transparency>` | ``0`` |
253255
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
256+
| :ref:`bool<class_bool>` | :ref:`use_fov_override<class_BaseMaterial3D_property_use_fov_override>` | ``false`` |
257+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
254258
| :ref:`bool<class_bool>` | :ref:`use_particle_trails<class_BaseMaterial3D_property_use_particle_trails>` | ``false`` |
255259
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
256260
| :ref:`bool<class_bool>` | :ref:`use_point_size<class_BaseMaterial3D_property_use_point_size>` | ``false`` |
257261
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
262+
| :ref:`bool<class_bool>` | :ref:`use_z_clip_scale<class_BaseMaterial3D_property_use_z_clip_scale>` | ``false`` |
263+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
258264
| :ref:`Vector3<class_Vector3>` | :ref:`uv1_offset<class_BaseMaterial3D_property_uv1_offset>` | ``Vector3(0, 0, 0)`` |
259265
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
260266
| :ref:`Vector3<class_Vector3>` | :ref:`uv1_scale<class_BaseMaterial3D_property_uv1_scale>` | ``Vector3(1, 1, 1)`` |
@@ -279,6 +285,8 @@ Properties
279285
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
280286
| :ref:`bool<class_bool>` | :ref:`vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` | ``false`` |
281287
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
288+
| :ref:`float<class_float>` | :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>` | ``1.0`` |
289+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
282290

283291
.. rst-class:: classref-reftable-group
284292

@@ -1141,11 +1149,27 @@ Disables receiving depth-based or volumetric fog.
11411149

11421150
Disables specular occlusion.
11431151

1152+
.. _class_BaseMaterial3D_constant_FLAG_USE_Z_CLIP_SCALE:
1153+
1154+
.. rst-class:: classref-enumeration-constant
1155+
1156+
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_Z_CLIP_SCALE** = ``23``
1157+
1158+
Enables using :ref:`z_clip_scale<class_BaseMaterial3D_property_z_clip_scale>`.
1159+
1160+
.. _class_BaseMaterial3D_constant_FLAG_USE_FOV_OVERRIDE:
1161+
1162+
.. rst-class:: classref-enumeration-constant
1163+
1164+
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_FOV_OVERRIDE** = ``24``
1165+
1166+
Enables using :ref:`fov_override<class_BaseMaterial3D_property_fov_override>`.
1167+
11441168
.. _class_BaseMaterial3D_constant_FLAG_MAX:
11451169

11461170
.. rst-class:: classref-enumeration-constant
11471171

1148-
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``23``
1172+
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``25``
11491173

11501174
Represents the size of the :ref:`Flags<enum_BaseMaterial3D_Flags>` enum.
11511175

@@ -2316,6 +2340,25 @@ If ``true``, the object is rendered at the same size regardless of distance. The
23162340

23172341
----
23182342

2343+
.. _class_BaseMaterial3D_property_fov_override:
2344+
2345+
.. rst-class:: classref-property
2346+
2347+
:ref:`float<class_float>` **fov_override** = ``75.0`` :ref:`🔗<class_BaseMaterial3D_property_fov_override>`
2348+
2349+
.. rst-class:: classref-property-setget
2350+
2351+
- |void| **set_fov_override**\ (\ value\: :ref:`float<class_float>`\ )
2352+
- :ref:`float<class_float>` **get_fov_override**\ (\ )
2353+
2354+
Overrides the :ref:`Camera3D<class_Camera3D>`'s field of view angle (in degrees).
2355+
2356+
\ **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.
2357+
2358+
.. rst-class:: classref-item-separator
2359+
2360+
----
2361+
23192362
.. _class_BaseMaterial3D_property_grow:
23202363

23212364
.. rst-class:: classref-property
@@ -3266,6 +3309,23 @@ The material's transparency mode. Some transparency modes will disable shadow ca
32663309

32673310
----
32683311

3312+
.. _class_BaseMaterial3D_property_use_fov_override:
3313+
3314+
.. rst-class:: classref-property
3315+
3316+
:ref:`bool<class_bool>` **use_fov_override** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_use_fov_override>`
3317+
3318+
.. rst-class:: classref-property-setget
3319+
3320+
- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
3321+
- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
3322+
3323+
If ``true`` use :ref:`fov_override<class_BaseMaterial3D_property_fov_override>` to override the :ref:`Camera3D<class_Camera3D>`'s field of view angle.
3324+
3325+
.. rst-class:: classref-item-separator
3326+
3327+
----
3328+
32693329
.. _class_BaseMaterial3D_property_use_particle_trails:
32703330

32713331
.. rst-class:: classref-property
@@ -3302,6 +3362,23 @@ If ``true``, render point size can be changed.
33023362

33033363
----
33043364

3365+
.. _class_BaseMaterial3D_property_use_z_clip_scale:
3366+
3367+
.. rst-class:: classref-property
3368+
3369+
:ref:`bool<class_bool>` **use_z_clip_scale** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_use_z_clip_scale>`
3370+
3371+
.. rst-class:: classref-property-setget
3372+
3373+
- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
3374+
- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
3375+
3376+
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.
3377+
3378+
.. rst-class:: classref-item-separator
3379+
3380+
----
3381+
33053382
.. _class_BaseMaterial3D_property_uv1_offset:
33063383

33073384
.. rst-class:: classref-property
@@ -3508,6 +3585,23 @@ If ``true``, vertex colors are considered to be stored in sRGB color space and a
35083585

35093586
If ``true``, the vertex color is used as albedo color.
35103587

3588+
.. rst-class:: classref-item-separator
3589+
3590+
----
3591+
3592+
.. _class_BaseMaterial3D_property_z_clip_scale:
3593+
3594+
.. rst-class:: classref-property
3595+
3596+
:ref:`float<class_float>` **z_clip_scale** = ``1.0`` :ref:`🔗<class_BaseMaterial3D_property_z_clip_scale>`
3597+
3598+
.. rst-class:: classref-property-setget
3599+
3600+
- |void| **set_z_clip_scale**\ (\ value\: :ref:`float<class_float>`\ )
3601+
- :ref:`float<class_float>` **get_z_clip_scale**\ (\ )
3602+
3603+
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.
3604+
35113605
.. rst-class:: classref-section-separator
35123606

35133607
----

‎classes/class_capsuleshape2d.rst‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ Properties
3131
.. table::
3232
:widths: auto
3333

34-
+---------------------------+-----------------------------------------------------+----------+
35-
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``30.0`` |
36-
+---------------------------+-----------------------------------------------------+----------+
37-
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
38-
+---------------------------+-----------------------------------------------------+----------+
34+
+---------------------------+-------------------------------------------------------------+----------+
35+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape2D_property_height>` | ``30.0`` |
36+
+---------------------------+-------------------------------------------------------------+----------+
37+
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleShape2D_property_mid_height>` | |
38+
+---------------------------+-------------------------------------------------------------+----------+
39+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape2D_property_radius>` | ``10.0`` |
40+
+---------------------------+-------------------------------------------------------------+----------+
3941

4042
.. rst-class:: classref-section-separator
4143

@@ -57,7 +59,24 @@ Property Descriptions
5759
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
5860
- :ref:`float<class_float>` **get_height**\ (\ )
5961

60-
The capsule's height.
62+
The capsule's full height, including the semicircles.
63+
64+
.. rst-class:: classref-item-separator
65+
66+
----
67+
68+
.. _class_CapsuleShape2D_property_mid_height:
69+
70+
.. rst-class:: classref-property
71+
72+
:ref:`float<class_float>` **mid_height** :ref:`🔗<class_CapsuleShape2D_property_mid_height>`
73+
74+
.. rst-class:: classref-property-setget
75+
76+
- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
77+
- :ref:`float<class_float>` **get_mid_height**\ (\ )
78+
79+
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>`.
6180

6281
.. rst-class:: classref-item-separator
6382

‎classes/class_capsuleshape3d.rst‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@ Properties
3838
.. table::
3939
:widths: auto
4040

41-
+---------------------------+-----------------------------------------------------+---------+
42-
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>` | ``2.0`` |
43-
+---------------------------+-----------------------------------------------------+---------+
44-
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>` | ``0.5`` |
45-
+---------------------------+-----------------------------------------------------+---------+
41+
+---------------------------+-------------------------------------------------------------+---------+
42+
| :ref:`float<class_float>` | :ref:`height<class_CapsuleShape3D_property_height>` | ``2.0`` |
43+
+---------------------------+-------------------------------------------------------------+---------+
44+
| :ref:`float<class_float>` | :ref:`mid_height<class_CapsuleShape3D_property_mid_height>` | |
45+
+---------------------------+-------------------------------------------------------------+---------+
46+
| :ref:`float<class_float>` | :ref:`radius<class_CapsuleShape3D_property_radius>` | ``0.5`` |
47+
+---------------------------+-------------------------------------------------------------+---------+
4648

4749
.. rst-class:: classref-section-separator
4850

@@ -64,7 +66,24 @@ Property Descriptions
6466
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
6567
- :ref:`float<class_float>` **get_height**\ (\ )
6668

67-
The capsule's height.
69+
The capsule's full height, including the hemispheres.
70+
71+
.. rst-class:: classref-item-separator
72+
73+
----
74+
75+
.. _class_CapsuleShape3D_property_mid_height:
76+
77+
.. rst-class:: classref-property
78+
79+
:ref:`float<class_float>` **mid_height** :ref:`🔗<class_CapsuleShape3D_property_mid_height>`
80+
81+
.. rst-class:: classref-property-setget
82+
83+
- |void| **set_mid_height**\ (\ value\: :ref:`float<class_float>`\ )
84+
- :ref:`float<class_float>` **get_mid_height**\ (\ )
85+
86+
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>`.
6887

6988
.. rst-class:: classref-item-separator
7089

0 commit comments

Comments
 (0)