Skip to content

Commit 77d6ca0

Browse files
authored
Merge pull request #10948 from godotengine/classref/sync-34f005d
classref: Sync with current master branch (34f005d)
2 parents 7729a1f + 2858109 commit 77d6ca0

12 files changed

+295
-39
lines changed

classes/[email protected]

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3889,11 +3889,23 @@ Hints that a property will be changed on its own after setting, such as :ref:`Au
38893889

38903890
Hints that a boolean property will enable the feature associated with the group that it occurs in. Only works within a group or subgroup.
38913891

3892+
.. _class_@GlobalScope_constant_PROPERTY_HINT_INPUT_NAME:
3893+
3894+
.. rst-class:: classref-enumeration-constant
3895+
3896+
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_INPUT_NAME** = ``43``
3897+
3898+
Hints that a :ref:`String<class_String>` or :ref:`StringName<class_StringName>` property is the name of an input action. This allows the selection of any action name from the Input Map in the Project Settings. The hint string may contain two options separated by commas:
3899+
3900+
- If it contains ``"show_builtin"``, built-in input actions are included in the selection.
3901+
3902+
- If it contains ``"loose_mode"``, loose mode is enabled. This allows inserting any action name even if it's not present in the input map.
3903+
38923904
.. _class_@GlobalScope_constant_PROPERTY_HINT_MAX:
38933905

38943906
.. rst-class:: classref-enumeration-constant
38953907

3896-
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_MAX** = ``43``
3908+
:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_MAX** = ``44``
38973909

38983910
Represents the size of the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` enum.
38993911

classes/class_basematerial3d.rst

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ Properties
7777
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
7878
| :ref:`Texture2D<class_Texture2D>` | :ref:`backlight_texture<class_BaseMaterial3D_property_backlight_texture>` | |
7979
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
80+
| :ref:`bool<class_bool>` | :ref:`bent_normal_enabled<class_BaseMaterial3D_property_bent_normal_enabled>` | ``false`` |
81+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
82+
| :ref:`Texture2D<class_Texture2D>` | :ref:`bent_normal_texture<class_BaseMaterial3D_property_bent_normal_texture>` | |
83+
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
8084
| :ref:`bool<class_bool>` | :ref:`billboard_keep_scale<class_BaseMaterial3D_property_billboard_keep_scale>` | ``false`` |
8185
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
8286
| :ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` | :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>` | ``0`` |
@@ -353,6 +357,14 @@ Texture specifying per-pixel emission color.
353357

354358
Texture specifying per-pixel normal vector.
355359

360+
.. _class_BaseMaterial3D_constant_TEXTURE_BENT_NORMAL:
361+
362+
.. rst-class:: classref-enumeration-constant
363+
364+
:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_BENT_NORMAL** = ``18``
365+
366+
Texture specifying per-pixel bent normal vector.
367+
356368
.. _class_BaseMaterial3D_constant_TEXTURE_RIM:
357369

358370
.. rst-class:: classref-enumeration-constant
@@ -461,7 +473,7 @@ Texture holding ambient occlusion, roughness, and metallic.
461473

462474
.. rst-class:: classref-enumeration-constant
463475

464-
:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_MAX** = ``18``
476+
:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_MAX** = ``19``
465477

466478
Represents the size of the :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` enum.
467479

@@ -763,11 +775,19 @@ Constant for setting :ref:`refraction_enabled<class_BaseMaterial3D_property_refr
763775

764776
Constant for setting :ref:`detail_enabled<class_BaseMaterial3D_property_detail_enabled>`.
765777

778+
.. _class_BaseMaterial3D_constant_FEATURE_BENT_NORMAL_MAPPING:
779+
780+
.. rst-class:: classref-enumeration-constant
781+
782+
:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_BENT_NORMAL_MAPPING** = ``12``
783+
784+
Constant for setting :ref:`bent_normal_enabled<class_BaseMaterial3D_property_bent_normal_enabled>`.
785+
766786
.. _class_BaseMaterial3D_constant_FEATURE_MAX:
767787

768788
.. rst-class:: classref-enumeration-constant
769789

770-
:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_MAX** = ``12``
790+
:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_MAX** = ``13``
771791

772792
Represents the size of the :ref:`Feature<enum_BaseMaterial3D_Feature>` enum.
773793

@@ -1715,6 +1735,46 @@ Texture used to control the backlight effect per-pixel. Added to :ref:`backlight
17151735

17161736
----
17171737

1738+
.. _class_BaseMaterial3D_property_bent_normal_enabled:
1739+
1740+
.. rst-class:: classref-property
1741+
1742+
:ref:`bool<class_bool>` **bent_normal_enabled** = ``false`` :ref:`🔗<class_BaseMaterial3D_property_bent_normal_enabled>`
1743+
1744+
.. rst-class:: classref-property-setget
1745+
1746+
- |void| **set_feature**\ (\ feature\: :ref:`Feature<enum_BaseMaterial3D_Feature>`, enable\: :ref:`bool<class_bool>`\ )
1747+
- :ref:`bool<class_bool>` **get_feature**\ (\ feature\: :ref:`Feature<enum_BaseMaterial3D_Feature>`\ ) |const|
1748+
1749+
If ``true``, the bent normal map is enabled. This allows for more accurate indirect lighting and specular occlusion.
1750+
1751+
.. rst-class:: classref-item-separator
1752+
1753+
----
1754+
1755+
.. _class_BaseMaterial3D_property_bent_normal_texture:
1756+
1757+
.. rst-class:: classref-property
1758+
1759+
:ref:`Texture2D<class_Texture2D>` **bent_normal_texture** :ref:`🔗<class_BaseMaterial3D_property_bent_normal_texture>`
1760+
1761+
.. rst-class:: classref-property-setget
1762+
1763+
- |void| **set_texture**\ (\ param\: :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
1764+
- :ref:`Texture2D<class_Texture2D>` **get_texture**\ (\ param\: :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>`\ ) |const|
1765+
1766+
Texture that specifies the average direction of incoming ambient light at a given pixel. The :ref:`bent_normal_texture<class_BaseMaterial3D_property_bent_normal_texture>` only uses the red and green channels; the blue and alpha channels are ignored. The normal read from :ref:`bent_normal_texture<class_BaseMaterial3D_property_bent_normal_texture>` is oriented around the surface normal provided by the :ref:`Mesh<class_Mesh>`.
1767+
1768+
\ **Note:** A bent normal map is different from a regular normal map. When baking a bent normal map make sure to use **a cosine distribution** for the bent normal map to work correctly.
1769+
1770+
\ **Note:** The mesh must have both normals and tangents defined in its vertex data. Otherwise, the shading produced by the bent normal map will not look correct. If creating geometry with :ref:`SurfaceTool<class_SurfaceTool>`, you can use :ref:`SurfaceTool.generate_normals()<class_SurfaceTool_method_generate_normals>` and :ref:`SurfaceTool.generate_tangents()<class_SurfaceTool_method_generate_tangents>` to automatically generate normals and tangents respectively.
1771+
1772+
\ **Note:** Godot expects the bent normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.
1773+
1774+
.. rst-class:: classref-item-separator
1775+
1776+
----
1777+
17181778
.. _class_BaseMaterial3D_property_billboard_keep_scale:
17191779

17201780
.. rst-class:: classref-property

classes/class_editorimportplugin.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,11 @@ Gets the name to display in the import window. You should choose this name as a
390390

391391
:ref:`Error<enum_@GlobalScope_Error>` **_import**\ (\ source_file\: :ref:`String<class_String>`, save_path\: :ref:`String<class_String>`, options\: :ref:`Dictionary<class_Dictionary>`, platform_variants\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\], gen_files\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ ) |virtual| |const| :ref:`🔗<class_EditorImportPlugin_private_method__import>`
392392

393-
Imports ``source_file`` into ``save_path`` with the import ``options`` specified. The ``platform_variants`` and ``gen_files`` arrays will be modified by this function.
393+
Imports ``source_file`` with the import ``options`` specified. Should return :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the import is successful, other values indicate failure.
394+
395+
The imported resource is expected to be saved to ``save_path + "." + _get_save_extension()``. If a different variant is preferred for a :doc:`feature tag <../tutorials/export/feature_tags>`, save the variant to ``save_path + "." + tag + "." + _get_save_extension()`` and add the feature tag to ``platform_variants``.
396+
397+
If additional resource files are generated in the resource filesystem (``res://``), add their full path to ``gen_files`` so that the editor knows they depend on ``source_file``.
394398

395399
This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.
396400

classes/class_editorscript.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Description
2121

2222
Scripts extending this class and implementing its :ref:`_run()<class_EditorScript_private_method__run>` method can be executed from the Script Editor's **File > Run** menu option (or by pressing :kbd:`Ctrl + Shift + X`) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using :ref:`EditorPlugin<class_EditorPlugin>`\ s instead.
2323

24+
If a script extending this class also has a global class name, it will be included in the editor's command palette.
25+
2426
\ **Note:** Extending scripts need to have ``tool`` mode enabled.
2527

2628
\ **Example:** Running the following script prints "Hello from the Godot Editor!":

classes/class_editorsettings.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -665,6 +665,8 @@ Properties
665665
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
666666
| :ref:`int<class_int>` | :ref:`text_editor/appearance/caret/type<class_EditorSettings_property_text_editor/appearance/caret/type>` |
667667
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
668+
| :ref:`bool<class_bool>` | :ref:`text_editor/appearance/enable_inline_color_picker<class_EditorSettings_property_text_editor/appearance/enable_inline_color_picker>` |
669+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
668670
| :ref:`int<class_int>` | :ref:`text_editor/appearance/guidelines/line_length_guideline_hard_column<class_EditorSettings_property_text_editor/appearance/guidelines/line_length_guideline_hard_column>` |
669671
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
670672
| :ref:`int<class_int>` | :ref:`text_editor/appearance/guidelines/line_length_guideline_soft_column<class_EditorSettings_property_text_editor/appearance/guidelines/line_length_guideline_soft_column>` |
@@ -4884,6 +4886,18 @@ The shape of the caret to use in the script editor. **Line** displays a vertical
48844886

48854887
----
48864888

4889+
.. _class_EditorSettings_property_text_editor/appearance/enable_inline_color_picker:
4890+
4891+
.. rst-class:: classref-property
4892+
4893+
:ref:`bool<class_bool>` **text_editor/appearance/enable_inline_color_picker** :ref:`🔗<class_EditorSettings_property_text_editor/appearance/enable_inline_color_picker>`
4894+
4895+
If ``true``, displays a colored button before any :ref:`Color<class_Color>` constructor in the script editor. Clicking on them allows the color to be modified through a color picker.
4896+
4897+
.. rst-class:: classref-item-separator
4898+
4899+
----
4900+
48874901
.. _class_EditorSettings_property_text_editor/appearance/guidelines/line_length_guideline_hard_column:
48884902

48894903
.. rst-class:: classref-property

0 commit comments

Comments
 (0)