Browse Source

Merge pull request #10835 from aaronfranke/opt-out-name-suffix

Document how to opt out of name suffix customization in 3D import
Matthew 3 months ago
parent
commit
604d3d8dcf

+ 40 - 5
tutorials/assets_pipeline/importing_3d_scenes/node_type_customization.rst

@@ -20,11 +20,33 @@ will detect suffixes in object names and will perform actions automatically.
     All the suffixes described below can be used with ``-``, ``$``, and ``_`` and are
     **case-insensitive**.
 
-Remove nodes (-noimp)
----------------------
-
-Objects that have the ``-noimp`` suffix will be removed at import-time no matter
-what their type is. They will not appear in the imported scene.
+Opting out
+----------
+
+If you do not want Godot to perform any of the actions described below, you
+can set the ``nodes/use_node_type_suffixes`` import option to ``false``.
+This will disable all node type suffixes, which keeps nodes the same type
+as the original file indicated. However, the ``-noimp`` suffix will still
+be respected, as well as non-node suffixes like ``-vcol`` or ``-loop``.
+
+Alternatively, you can completely opt out of all name suffixes by setting
+the ``nodes/use_name_suffixes`` import option to ``false``. This will
+completely stop the general scene import code from looking at name suffixes.
+However, the format-specific import code may still look at name suffixes,
+such as the glTF importer checking for the ``-loop`` suffix.
+
+Disabling these options makes editor-imported files more similar to the
+original files, and more similar to importing files at runtime.
+For an import workflow that works at runtime, gives more predictable
+results, and only has explicitly defined behavior, consider setting these
+options to ``false`` and using :ref:`class_GLTFDocumentExtension` instead.
+
+Remove nodes and animations (-noimp)
+------------------------------------
+
+Nodes and animations that have the ``-noimp`` suffix will be removed at
+import time no matter what their type is. They will not appear in the
+imported scene.
 
 This is equivalent to enabling **Skip Import** for a node in the Advanced Import
 Settings dialog.
@@ -132,3 +154,16 @@ will be imported as a Godot :ref:`class_Animation` with the loop flag set.
 
 In Blender, this requires using the NLA Editor and naming the Action with the ``loop`` or
 ``cycle`` prefix or suffix.
+
+Material alpha (-alpha)
+-----------------------
+
+A material with the ``-alpha`` suffix will be imported with the
+:ref:`TRANSPARENCY_ALPHA<class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA>` transparency mode.
+
+Material vertex color (-vcol)
+-----------------------------
+
+A material with the ``-vcol`` suffix will be imported with the
+:ref:`FLAG_ALBEDO_FROM_VERTEX_COLOR<class_BaseMaterial3D_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR>` and
+:ref:`FLAG_SRGB_VERTEX_COLOR<class_BaseMaterial3D_constant_FLAG_SRGB_VERTEX_COLOR>` flags set.