Skip to content

Commit 9474670

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (19bb187)
1 parent 0800120 commit 9474670

22 files changed

+322
-49
lines changed

classes/class_basematerial3d.rst

+32-1
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ Properties
115115
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
116116
| :ref:`bool<class_bool>` | :ref:`disable_receive_shadows<class_BaseMaterial3D_property_disable_receive_shadows>` | ``false`` |
117117
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
118+
| :ref:`bool<class_bool>` | :ref:`disable_specular_occlusion<class_BaseMaterial3D_property_disable_specular_occlusion>` | ``false`` |
119+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
118120
| :ref:`float<class_float>` | :ref:`distance_fade_max_distance<class_BaseMaterial3D_property_distance_fade_max_distance>` | ``10.0`` |
119121
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
120122
| :ref:`float<class_float>` | :ref:`distance_fade_min_distance<class_BaseMaterial3D_property_distance_fade_min_distance>` | ``0.0`` |
@@ -1111,11 +1113,19 @@ Enables multichannel signed distance field rendering shader.
11111113

11121114
Disables receiving depth-based or volumetric fog.
11131115

1116+
.. _class_BaseMaterial3D_constant_FLAG_DISABLE_SPECULAR_OCCLUSION:
1117+
1118+
.. rst-class:: classref-enumeration-constant
1119+
1120+
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_DISABLE_SPECULAR_OCCLUSION** = ``22``
1121+
1122+
Disables specular occlusion.
1123+
11141124
.. _class_BaseMaterial3D_constant_FLAG_MAX:
11151125

11161126
.. rst-class:: classref-enumeration-constant
11171127

1118-
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``22``
1128+
:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``23``
11191129

11201130
Represents the size of the :ref:`Flags<enum_BaseMaterial3D_Flags>` enum.
11211131

@@ -1179,6 +1189,10 @@ enum **SpecularMode**: :ref:`🔗<enum_BaseMaterial3D_SpecularMode>`
11791189

11801190
Default specular blob.
11811191

1192+
\ **Note:** Forward+ uses multiscattering for more accurate reflections, although the impact of multiscattering is more noticeable on rough metallic surfaces than on smooth, non-metallic surfaces.
1193+
1194+
\ **Note:** Mobile and Compatibility don't perform multiscattering for performance reasons. Instead, they perform single scattering, which means rough metallic surfaces may look slightly darker than intended.
1195+
11821196
.. _class_BaseMaterial3D_constant_SPECULAR_TOON:
11831197

11841198
.. rst-class:: classref-enumeration-constant
@@ -2034,6 +2048,23 @@ If ``true``, the object receives no shadow that would otherwise be cast onto it.
20342048

20352049
----
20362050

2051+
.. _class_BaseMaterial3D_property_disable_specular_occlusion:
2052+
2053+
.. rst-class:: classref-property
2054+
2055+
:ref:`bool<class_bool>` **disable_specular_occlusion** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_disable_specular_occlusion>`
2056+
2057+
.. rst-class:: classref-property-setget
2058+
2059+
- |void| **set_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`, enable\: :ref:`bool<class_bool>`\ )
2060+
- :ref:`bool<class_bool>` **get_flag**\ (\ flag\: :ref:`Flags<enum_BaseMaterial3D_Flags>`\ ) |const|
2061+
2062+
If ``true``, disables specular occlusion even if :ref:`ProjectSettings.rendering/reflections/specular_occlusion/enabled<class_ProjectSettings_property_rendering/reflections/specular_occlusion/enabled>` is ``false``.
2063+
2064+
.. rst-class:: classref-item-separator
2065+
2066+
----
2067+
20372068
.. _class_BaseMaterial3D_property_distance_fade_max_distance:
20382069

20392070
.. rst-class:: classref-property

classes/class_editorproperty.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ Used by the inspector, set to ``true`` when the property can be deleted by the u
315315
- |void| **set_draw_background**\ (\ value\: :ref:`bool<class_bool>`\ )
316316
- :ref:`bool<class_bool>` **is_draw_background**\ (\ )
317317

318-
Used by the inspector, set to ``true`` when the property label is drawn.
318+
Used by the inspector, set to ``true`` when the property background is drawn.
319319

320320
.. rst-class:: classref-item-separator
321321

@@ -332,7 +332,7 @@ Used by the inspector, set to ``true`` when the property label is drawn.
332332
- |void| **set_draw_label**\ (\ value\: :ref:`bool<class_bool>`\ )
333333
- :ref:`bool<class_bool>` **is_draw_label**\ (\ )
334334

335-
Used by the inspector, set to ``true`` when the property background is drawn.
335+
Used by the inspector, set to ``true`` when the property label is drawn.
336336

337337
.. rst-class:: classref-item-separator
338338

classes/class_editorsettings.rst

+23-15
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,8 @@ Properties
449449
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
450450
| :ref:`int<class_int>` | :ref:`interface/editor/code_font_size<class_EditorSettings_property_interface/editor/code_font_size>` |
451451
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
452+
| :ref:`bool<class_bool>` | :ref:`interface/editor/collapse_main_menu<class_EditorSettings_property_interface/editor/collapse_main_menu>` |
453+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
452454
| :ref:`float<class_float>` | :ref:`interface/editor/custom_display_scale<class_EditorSettings_property_interface/editor/custom_display_scale>` |
453455
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
454456
| :ref:`int<class_int>` | :ref:`interface/editor/display_scale<class_EditorSettings_property_interface/editor/display_scale>` |
@@ -881,8 +883,6 @@ Properties
881883
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
882884
| :ref:`Color<class_Color>` | :ref:`text_editor/theme/highlighting/word_highlighted_color<class_EditorSettings_property_text_editor/theme/highlighting/word_highlighted_color>` |
883885
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
884-
| :ref:`int<class_int>` | :ref:`text_editor/theme/line_spacing<class_EditorSettings_property_text_editor/theme/line_spacing>` |
885-
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
886886
| :ref:`String<class_String>` | :ref:`version_control/ssh_private_key_path<class_EditorSettings_property_version_control/ssh_private_key_path>` |
887887
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
888888
| :ref:`String<class_String>` | :ref:`version_control/ssh_public_key_path<class_EditorSettings_property_version_control/ssh_public_key_path>` |
@@ -3458,6 +3458,22 @@ The size of the font in the script editor. This setting does not impact the font
34583458

34593459
----
34603460

3461+
.. _class_EditorSettings_property_interface/editor/collapse_main_menu:
3462+
3463+
.. rst-class:: classref-property
3464+
3465+
:ref:`bool<class_bool>` **interface/editor/collapse_main_menu** :ref:`🔗<class_EditorSettings_property_interface/editor/collapse_main_menu>`
3466+
3467+
If ``true``, the main menu collapses into a :ref:`MenuButton<class_MenuButton>`.
3468+
3469+
\ **Note:** This setting is only applicable on macOS when :ref:`interface/editor/use_embedded_menu<class_EditorSettings_property_interface/editor/use_embedded_menu>` is ``true``.
3470+
3471+
\ **Note:** Defaults to ``true`` on the Android editor.
3472+
3473+
.. rst-class:: classref-item-separator
3474+
3475+
----
3476+
34613477
.. _class_EditorSettings_property_interface/editor/custom_display_scale:
34623478

34633479
.. rst-class:: classref-property
@@ -5078,7 +5094,11 @@ If ``true``, tool scripts will be automatically soft-reloaded after they are sav
50785094

50795095
:ref:`bool<class_bool>` **text_editor/behavior/files/auto_reload_scripts_on_external_change** :ref:`🔗<class_EditorSettings_property_text_editor/behavior/files/auto_reload_scripts_on_external_change>`
50805096

5081-
If ``true``, automatically reloads scripts in the editor when they have been modified and saved by external editors.
5097+
If ``true``, automatically reloads scripts and text-based shaders in the editor when they have been modified and saved by external editors or tools and the editor regains focus. External changes can be discarded by using the Undo function after they've been loaded in the editor.
5098+
5099+
If ``false``, a file conflict dialog will always be displayed when the editor regains focus. This dialog allows you to choose whether to keep local changes or discard them.
5100+
5101+
\ **Note:** Even when this setting is ``true``, a file conflict dialog is still displayed in certain situations. For instance, it will display when the script editor has unsaved changes that the external editor did not account for.
50825102

50835103
.. rst-class:: classref-item-separator
50845104

@@ -6200,18 +6220,6 @@ The script editor's color for words highlighted by selecting them. Only visible
62006220

62016221
----
62026222

6203-
.. _class_EditorSettings_property_text_editor/theme/line_spacing:
6204-
6205-
.. rst-class:: classref-property
6206-
6207-
:ref:`int<class_int>` **text_editor/theme/line_spacing** :ref:`🔗<class_EditorSettings_property_text_editor/theme/line_spacing>`
6208-
6209-
The vertical line separation used in text editors, in pixels.
6210-
6211-
.. rst-class:: classref-item-separator
6212-
6213-
----
6214-
62156223
.. _class_EditorSettings_property_version_control/ssh_private_key_path:
62166224

62176225
.. rst-class:: classref-property

classes/class_fileaccess.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1265,6 +1265,8 @@ Stores a floating-point number as 32 bits in the file.
12651265

12661266
Stores a half-precision floating-point number as 16 bits in the file.
12671267

1268+
\ **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate.
1269+
12681270
.. rst-class:: classref-item-separator
12691271

12701272
----

classes/class_inputeventaction.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Property Descriptions
7272
- |void| **set_action**\ (\ value\: :ref:`StringName<class_StringName>`\ )
7373
- :ref:`StringName<class_StringName>` **get_action**\ (\ )
7474

75-
The action's name. Actions are accessed via this :ref:`String<class_String>`.
75+
The action's name. This is usually the name of an existing action in the :ref:`InputMap<class_InputMap>` which you want this custom event to match.
7676

7777
.. rst-class:: classref-item-separator
7878

classes/class_light3d.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ enum **BakeMode**: :ref:`🔗<enum_Light3D_BakeMode>`
321321

322322
:ref:`BakeMode<enum_Light3D_BakeMode>` **BAKE_DISABLED** = ``0``
323323

324-
Light is ignored when baking. This is the fastest mode, but the light will be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights.
324+
Light is ignored when baking. This is the fastest mode, but the light will not be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights.
325325

326326
\ **Note:** Hiding a light does *not* affect baking :ref:`LightmapGI<class_LightmapGI>`. Hiding a light will still affect baking :ref:`VoxelGI<class_VoxelGI>` and SDFGI (see :ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`).
327327

classes/class_lineedit.rst

+20-1
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,8 @@ Properties
167167
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
168168
| :ref:`bool<class_bool>` | :ref:`virtual_keyboard_enabled<class_LineEdit_property_virtual_keyboard_enabled>` | ``true`` |
169169
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
170+
| :ref:`bool<class_bool>` | :ref:`virtual_keyboard_show_on_focus<class_LineEdit_property_virtual_keyboard_show_on_focus>` | ``true`` |
171+
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
170172
| :ref:`VirtualKeyboardType<enum_LineEdit_VirtualKeyboardType>` | :ref:`virtual_keyboard_type<class_LineEdit_property_virtual_keyboard_type>` | ``0`` |
171173
+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
172174

@@ -1260,7 +1262,24 @@ Base text writing direction.
12601262
- |void| **set_virtual_keyboard_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
12611263
- :ref:`bool<class_bool>` **is_virtual_keyboard_enabled**\ (\ )
12621264

1263-
If ``true``, the native virtual keyboard is shown when focused on platforms that support it.
1265+
If ``true``, the native virtual keyboard is enabled on platforms that support it.
1266+
1267+
.. rst-class:: classref-item-separator
1268+
1269+
----
1270+
1271+
.. _class_LineEdit_property_virtual_keyboard_show_on_focus:
1272+
1273+
.. rst-class:: classref-property
1274+
1275+
:ref:`bool<class_bool>` **virtual_keyboard_show_on_focus** = ``true`` :ref:`🔗<class_LineEdit_property_virtual_keyboard_show_on_focus>`
1276+
1277+
.. rst-class:: classref-property-setget
1278+
1279+
- |void| **set_virtual_keyboard_show_on_focus**\ (\ value\: :ref:`bool<class_bool>`\ )
1280+
- :ref:`bool<class_bool>` **get_virtual_keyboard_show_on_focus**\ (\ )
1281+
1282+
If ``true``, the native virtual keyboard is shown on focus events on platforms that support it.
12641283

12651284
.. rst-class:: classref-item-separator
12661285

classes/class_navigationagent2d.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ The pathfinding algorithm used in the path query.
585585

586586
The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by :ref:`neighbor_distance<class_NavigationAgent2D_property_neighbor_distance>`).
587587

588-
Does not affect normal pathfinding. To change an actor's pathfinding radius bake :ref:`NavigationMesh<class_NavigationMesh>` resources with a different :ref:`NavigationMesh.agent_radius<class_NavigationMesh_property_agent_radius>` property and use different navigation maps for each actor size.
588+
Does not affect normal pathfinding. To change an actor's pathfinding radius bake :ref:`NavigationPolygon<class_NavigationPolygon>` resources with a different :ref:`NavigationPolygon.agent_radius<class_NavigationPolygon_property_agent_radius>` property and use different navigation maps for each actor size.
589589

590590
.. rst-class:: classref-item-separator
591591

0 commit comments

Comments
 (0)