Skip to content

Commit e5fdcf7

Browse files
authored
UT-3314 Export FBX Linked Prefab Rename to Export FBX Prefab Variant (#529)
Rename menu items from 'linked prefab' to 'prefab variant'. Update docs to make prefab variant more clear. Update images in docs for new menu options.
1 parent c545a32 commit e5fdcf7

File tree

6 files changed

+37
-37
lines changed

6 files changed

+37
-37
lines changed
104 KB
Loading
110 KB
Loading

com.unity.formats.fbx/Documentation~/prefabs.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ When Unity imports a Model from a 3D modeling application such as Autodesk® May
66

77
![A Model Prefab in the Scene and Hierarchy views](images/FBXExporter_ModelPrefab.png)
88

9-
If you want to add components, Materials, or change most other property values without affecting the original FBX file in Unity, convert the Model Prefab to an **FBX Linked Prefab**. This is a Prefab Variant of the exported FBX's Model Prefab. Prefab Variants allow you to override their base Prefabs' properties.
9+
If you want to add components, Materials, or change most other property values without affecting the original FBX file in Unity, convert the Model Prefab to an **FBX Prefab Variant**. This is a Prefab Variant of the exported FBX's Model Prefab. Prefab Variants allow you to override their base Prefabs' properties.
1010

11-
Using FBX Linked Prefabs is the best way to ensure that your Models continue to reflect any changes you make to your FBX files in external applications while still taking full advantage of the Prefab system.
11+
Using FBX Prefab Variants is the best way to ensure that your Models continue to reflect any changes you make to your FBX files in external applications while still taking full advantage of the Prefab system.
1212

1313
In addition, you can use Variants to control updates from external applications. For example, if you have a Model with a Spot Light of size 10 and you override the size to 1 in your Variant, when the size and color change in the FBX file, the color changes but the size remains 1.
1414

1515
> **IMPORTANT:** Because the Prefab Variant inherits data from the base Model Prefab, you cannot make structural changes to the Prefab Variant. This means that you cannot delete inherited child objects or re-arrange the order of inherited child objects on the Prefab Variant.
1616
17-
### Creating an FBX Linked Prefab
17+
### Creating an FBX Prefab Variant
1818

19-
You can either create an FBX Linked Prefab [from a GameObject](#fromGameObject) or generate it directly [from the selected .fbx or .prefab file](#fromFBXorAssetFile). If you are upgrading from version 2.0.1-preview or earlier of the FBX Exporter, you can also [convert any existing](#conversion) Linked Prefabs you may have to the new FBX Linked Prefabs.
19+
You can either create an FBX Prefab Variant [from a GameObject](#fromGameObject) or generate it directly [from the selected .fbx or .prefab file](#fromFBXorAssetFile). If you are upgrading from version 2.0.1-preview or earlier of the FBX Exporter, you can also [convert any existing](#conversion) Linked Prefabs you may have to the new FBX Prefab Variants.
2020

21-
When you convert a GameObject to an FBX Linked Prefab, the FBX Exporter exports each selected GameObject hierarchy and writes an FBX file and a Prefab Variant (`.prefab`) with the FBX as its base.
21+
When you convert a GameObject to an FBX Prefab Variant, the FBX Exporter exports each selected GameObject hierarchy and writes an FBX file and a Prefab Variant (`.prefab`) with the FBX as its base.
2222

23-
When you generate an FBX Linked Prefab from a selected file, the FBX Exporter generates the FBX Linked Prefab without modifying the Scene:
23+
When you generate an FBX Prefab Variant from a selected file, the FBX Exporter generates the FBX Prefab Variant without modifying the Scene:
2424

2525
* If you select an FBX file, the FBX Exporter generates a Prefab Variant Asset file.
2626
* If you select a Prefab Asset file, the FBX Exporter generates a Prefab Variant Asset file and an FBX file.
@@ -30,76 +30,76 @@ When you generate an FBX Linked Prefab from a selected file, the FBX Exporter ge
3030
<a name="fromGameObject"></a>
3131
#### Converting a GameObject
3232

33-
To replace the GameObject hierarchy with an instance of an FBX Linked Prefab:
33+
To replace the GameObject hierarchy with an instance of an FBX Prefab Variant:
3434

35-
1. Right-click on the GameObject in the Hierarchy view and select __Convert To FBX Linked Prefab__ from the context menu.
35+
1. Right-click on the GameObject in the Hierarchy view and select __Convert To FBX Prefab Variant__ from the context menu.
3636

37-
![Convert GameObject to FBX Linked Prefab](images/FBXExporter_FBXLinkedPrefab-GameObject.png)
37+
![Convert GameObject to FBX Prefab Variant](images/FBXExporter_FBXLinkedPrefab-GameObject.png)
3838

39-
Alternatively, you can use the main menu: __GameObject__ > __Convert To FBX Linked Prefab__ with the GameObject selected.
39+
Alternatively, you can use the main menu: __GameObject__ > __Convert To FBX Prefab Variant__ with the GameObject selected.
4040

4141
2. Specify how you want to export the GameObject using the properties on the [Convert Options](#ConvertOptions) window and click **Convert**.
4242

43-
FBX Linked Prefabs use the same rules as for exporting: all selected objects and their descendants are exported to a single FBX file. If you select both a parent and a descendant, the FBX Linked Prefab only exports the parent’s hierarchy.
43+
FBX Prefab Variants use the same rules as for exporting: all selected objects and their descendants are exported to a single FBX file. If you select both a parent and a descendant, the FBX Prefab Variant only exports the parent’s hierarchy.
4444

45-
> **NOTE:** If the selected object is a Model Prefab instance, then the hierarchy is not re-exported: instead the FBX Linked Prefab links to the FBX file that already exists.
45+
> **NOTE:** If the selected object is a Model Prefab instance, then the hierarchy is not re-exported: instead the FBX Prefab Variant links to the FBX file that already exists.
4646
4747
<a name="fromFBXorAssetFile"></a>
4848
#### Converting an FBX file or a Prefab
4949

50-
To generate the FBX Linked Prefab from the selected file without modifying the Scene:
50+
To generate the FBX Prefab Variant from the selected file without modifying the Scene:
5151

52-
1. Right-click on an FBX or Prefab Asset file in the Project view and select __Convert To FBX Linked Prefab__ from the context menu.
52+
1. Right-click on an FBX or Prefab Asset file in the Project view and select __Convert To FBX Prefab Variant__ from the context menu.
5353

5454
![Convert Prefab file to FBX Linked Prefab](images/FBXExporter_FBXLinkedPrefab-Asset.png)
5555

56-
Alternatively, you can use the main menu: __Assets__ > __Convert To FBX Linked Prefab__.
56+
Alternatively, you can use the main menu: __Assets__ > __Convert To FBX Prefab Variant__.
5757

5858
2. Specify how you want to export the GameObject using the properties on the [Convert Options](#ConvertOptions) window and click **Convert**.
5959

60-
Depending on which type of file you selected, the FBX Exporter creates the FBX Linked Prefab in one of the following ways:
60+
Depending on which type of file you selected, the FBX Exporter creates the FBX Prefab Variant in one of the following ways:
6161

6262
* If an FBX file is selected, the FBX Exporter generates a Prefab Variant file with the selected FBX file as its base.
63-
* If a Prefab Asset file is selected, the FBX Exporter exports the Prefab to an FBX file and creates a new FBX Linked Prefab.
63+
* If a Prefab Asset file is selected, the FBX Exporter exports the Prefab to an FBX file and creates a new FBX Prefab Variant.
6464

6565
<a name="ConvertOptions"></a>
6666
### Convert Options window
6767

68-
When converting to an FBX Linked Prefab, the following window opens, displaying options for exporting:
68+
When converting to an FBX Prefab Variant, the following window opens, displaying options for exporting:
6969

70-
![Convert Options for an FBX Linked Prefab](images/FBXExporter_ConvertOptionsWindow.png)
70+
![Convert Options for an FBX Prefab Variant](images/FBXExporter_ConvertOptionsWindow.png)
7171

7272
#### Convert Option properties
7373

7474
| Property: | Function: |
7575
| :------------------------ | :----------------------------------------------------------- |
7676
| __Export Name__ | Specify the name of the FBX file to export. |
7777
| __Export Path__ | Specify the location where the FBX Exporter will save the FBX file. |
78-
| __Prefab Name__ | Specify the name of the FBX Linked Prefab's file. |
79-
| __Prefab Path__ | Specify the location where the FBX Exporter will save the FBX Linked Prefab file. |
78+
| __Prefab Name__ | Specify the name of the FBX Prefab Variant's file. |
79+
| __Prefab Path__ | Specify the location where the FBX Exporter will save the FBX Prefab Variant file. |
8080
| __Source__ | Transfer the transform animation from this object to the __Destination__ transform.<br/><br/>**NOTES:**<br/> - __Source__ must be an ancestor of __Destination__.<br/> - __Source__ may be an ancestor of the selected object. |
8181
| __Destination__ | Which object to transfer the transform animation to.<br/><br/>This object receives the transform animation on objects between __Source__ and __Destination__ as well as the animation on the __Source__ itself. |
8282
| __Export Format__ | Select the format for the FBX Exporter to use when exporting the FBX file (ASCII or binary). |
83-
| __Include__ | __Convert to FBX Linked Prefab__ always exports both Models and Animation in the hierarchy. |
84-
| __LOD level__ | __Convert to FBX Linked Prefab__ always exports All levels of detail (LOD) available in the hierarchy for LOD groups. |
85-
| __Object(s) Position__ | __Convert to FBX Linked Prefab__ always resets the root object's transform during export. However, the Prefab maintains the global transform for the root object. |
83+
| __Include__ | __Convert to FBX Prefab Variant__ always exports both Models and Animation in the hierarchy. |
84+
| __LOD level__ | __Convert to FBX Prefab Variant__ always exports All levels of detail (LOD) available in the hierarchy for LOD groups. |
85+
| __Object(s) Position__ | __Convert to FBX Prefab Variant__ always resets the root object's transform during export. However, the Prefab maintains the global transform for the root object. |
8686
| __Animated Skinned Mesh__ | Check this option to export animation on objects with skinned meshes.<br/><br/>If unchecked, the FBX Exporter does not export animation on skinned meshes. |
8787
| __Compatible Naming__ | Check this option to control renaming the GameObject and Materials during export. <br/><br/>The FBX Exporter ensures compatible naming with Autodesk® Maya® and Autodesk® Maya LT™ to avoid unexpected name changes between Unity and Autodesk® Maya® and Autodesk® Maya LT™. During export the FBX Exporter replaces characters in Unity names as follows:<br/> - Replaces invalid characters with underscores ("\_"). Invalid characters are all non-alphanumeric characters, except for colon (":").<br/> - Adds an underscore ("\_") to names that begin with a number. - Replaces diacritics. For example, replaces "é" with “e”.<br/><br/>**NOTE:** If you have a Material with a space in its name, the space is replaced with an underscore ("_"). This results in a new Material being created when it is imported. For example, the Material named "Default Material" is exported as "Default_Material" and is created as a new Material when it is imported. If you want the exported Material to match an existing Material in the scene, you must manually rename the Material before exporting. |
88-
| __Don't ask me again__ | Check this option to use the same **Convert Option** properties and hide this window when converting to FBX Linked Prefabs in the future. You can reset this option by turning on the **Show Convert UI** option under **Edit** > **Project Settings** > **Fbx Export** in Unity's top menu. |
88+
| __Don't ask me again__ | Check this option to use the same **Convert Option** properties and hide this window when converting to FBX Prefab Variants in the future. You can reset this option by turning on the **Show Convert UI** option under **Edit** > **Project Settings** > **Fbx Export** in Unity's top menu. |
8989

9090
> **NOTE:** For FBX Model filenames, the FBX Exporter ensures that names do not contain invalid characters for the file system. The set of invalid characters may differ between file systems.
9191
9292

9393

9494
<a name="conversion"></a>
95-
### Converting from Linked Prefabs to FBX Linked Prefabs
95+
### Converting from Linked Prefabs to FBX Prefab Variants
9696

97-
To convert existing Linked Prefabs to FBX Linked Prefabs, follow these steps:
97+
To convert existing Linked Prefabs to FBX Prefab Variants, follow these steps:
9898

99-
1. Fix any name discrepancies before converting. FBX Linked Prefabs do not handle name remapping. If you start to add game logic to components, and then the objects in the FBX get renamed, you are at risk of losing the components. This can happen because the old GameObjects are deleted and new objects with the new names are added in their place.
99+
1. Fix any name discrepancies before converting. FBX Prefab Variants do not handle name remapping. If you start to add game logic to components, and then the objects in the FBX get renamed, you are at risk of losing the components. This can happen because the old GameObjects are deleted and new objects with the new names are added in their place.
100100

101-
2. Right-click the Linked Prefab file and select **Convert to FBX Linked Prefab** from the context menu.
101+
2. Right-click the Linked Prefab file and select **Convert to FBX Prefab Variant** from the context menu.
102102

103103
![Create a Prefab variant from the file's context menu](images/FBXExporter_FBXLinkedPrefab-Asset.png)
104104

105-
> **NOTE:** This re-exports the Linked Prefab to a new FBX file, and it is no longer connected to the original FBX.
105+
> **NOTE:** This re-exports the Linked Prefab to a new FBX file, and it is no longer connected to the original FBX.

com.unity.formats.fbx/Editor/ConvertToNestedPrefab.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ protected ConvertToNestedPrefabException(SerializationInfo info, StreamingContex
3434

3535
internal static class ConvertToNestedPrefab
3636
{
37-
const string GameObjectMenuItemName = "GameObject/Convert To FBX Linked Prefab...";
38-
const string AssetsMenuItemName = "Assets/Convert To FBX Linked Prefab...";
39-
const string UndoConversionGroup = "Convert {0} to FBX Linked Prefab";
40-
internal const string UndoConversionCreateObject = "Convert to FBX Linked Prefab";
37+
const string GameObjectMenuItemName = "GameObject/Convert To FBX Prefab Variant...";
38+
const string AssetsMenuItemName = "Assets/Convert To FBX Prefab Variant...";
39+
const string UndoConversionGroup = "Convert {0} to FBX Prefab Variant";
40+
internal const string UndoConversionCreateObject = "Convert to FBX Prefab Variant";
4141

4242
/// <summary>
4343
/// OnContextItem is called either:

com.unity.formats.fbx/Editor/ConvertToPrefabEditorWindow.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ protected override void CreateCustomUI()
286286
GUILayout.BeginHorizontal();
287287
EditorGUILayout.LabelField(new GUIContent(
288288
"Prefab Path",
289-
"Relative path for saving Linked Prefabs."), GUILayout.Width(LabelWidth - FieldOffset));
289+
"Relative path for saving FBX Prefab Variants."), GUILayout.Width(LabelWidth - FieldOffset));
290290

291291
var pathLabels = ExportSettings.GetRelativePrefabSavePaths();
292292

@@ -297,7 +297,7 @@ protected override void CreateCustomUI()
297297
string initialPath = Application.dataPath;
298298

299299
string fullPath = EditorUtility.OpenFolderPanel(
300-
"Select Linked Prefab Save Path", initialPath, null
300+
"Select FBX Prefab Variant Save Path", initialPath, null
301301
);
302302

303303
// Unless the user canceled, make sure they chose something in the Assets folder.

com.unity.formats.fbx/Editor/FbxExportSettings.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public override void OnInspectorGUI() {
7171
EditorGUILayout.LabelField("Export Options", EditorStyles.boldLabel);
7272
EditorGUI.indentLevel++;
7373
exportSettings.ShowConvertToPrefabDialog = EditorGUILayout.Toggle(
74-
new GUIContent("Show Convert UI:", "Show the Convert dialog when converting to an FBX Linked Prefab"),
74+
new GUIContent("Show Convert UI:", "Show the Convert dialog when converting to an FBX Prefab Variant"),
7575
exportSettings.ShowConvertToPrefabDialog
7676
);
7777
EditorGUILayout.Space();

0 commit comments

Comments
 (0)