Skip to content

Commit 604d3d8

Browse files
authored
Merge pull request #10835 from aaronfranke/opt-out-name-suffix
Document how to opt out of name suffix customization in 3D import
2 parents 9ca65ff + f211035 commit 604d3d8

File tree

1 file changed

+40
-5
lines changed

1 file changed

+40
-5
lines changed

tutorials/assets_pipeline/importing_3d_scenes/node_type_customization.rst

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,33 @@ will detect suffixes in object names and will perform actions automatically.
2020
All the suffixes described below can be used with ``-``, ``$``, and ``_`` and are
2121
**case-insensitive**.
2222

23-
Remove nodes (-noimp)
24-
---------------------
25-
26-
Objects that have the ``-noimp`` suffix will be removed at import-time no matter
27-
what their type is. They will not appear in the imported scene.
23+
Opting out
24+
----------
25+
26+
If you do not want Godot to perform any of the actions described below, you
27+
can set the ``nodes/use_node_type_suffixes`` import option to ``false``.
28+
This will disable all node type suffixes, which keeps nodes the same type
29+
as the original file indicated. However, the ``-noimp`` suffix will still
30+
be respected, as well as non-node suffixes like ``-vcol`` or ``-loop``.
31+
32+
Alternatively, you can completely opt out of all name suffixes by setting
33+
the ``nodes/use_name_suffixes`` import option to ``false``. This will
34+
completely stop the general scene import code from looking at name suffixes.
35+
However, the format-specific import code may still look at name suffixes,
36+
such as the glTF importer checking for the ``-loop`` suffix.
37+
38+
Disabling these options makes editor-imported files more similar to the
39+
original files, and more similar to importing files at runtime.
40+
For an import workflow that works at runtime, gives more predictable
41+
results, and only has explicitly defined behavior, consider setting these
42+
options to ``false`` and using :ref:`class_GLTFDocumentExtension` instead.
43+
44+
Remove nodes and animations (-noimp)
45+
------------------------------------
46+
47+
Nodes and animations that have the ``-noimp`` suffix will be removed at
48+
import time no matter what their type is. They will not appear in the
49+
imported scene.
2850

2951
This is equivalent to enabling **Skip Import** for a node in the Advanced Import
3052
Settings dialog.
@@ -132,3 +154,16 @@ will be imported as a Godot :ref:`class_Animation` with the loop flag set.
132154

133155
In Blender, this requires using the NLA Editor and naming the Action with the ``loop`` or
134156
``cycle`` prefix or suffix.
157+
158+
Material alpha (-alpha)
159+
-----------------------
160+
161+
A material with the ``-alpha`` suffix will be imported with the
162+
:ref:`TRANSPARENCY_ALPHA<class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA>` transparency mode.
163+
164+
Material vertex color (-vcol)
165+
-----------------------------
166+
167+
A material with the ``-vcol`` suffix will be imported with the
168+
:ref:`FLAG_ALBEDO_FROM_VERTEX_COLOR<class_BaseMaterial3D_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR>` and
169+
:ref:`FLAG_SRGB_VERTEX_COLOR<class_BaseMaterial3D_constant_FLAG_SRGB_VERTEX_COLOR>` flags set.

0 commit comments

Comments
 (0)