Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ConvertToPrefabInstance(GameObject, GameObject, ConvertToPrefabInstanceSettings, InteractionMode)

Convert the plain GameObject to a Prefab instance using the provided Prefab Asset root object.
Read time 1 minuteLast updated 10 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule
public static void ConvertToPrefabInstance(GameObject plainGameObject, GameObject prefabAssetRoot, ConvertToPrefabInstanceSettings settings, InteractionMode mode)

Parameters

plainGameObject

GameObject
The GameObject that will be converted to a Prefab instance.

prefabAssetRoot

GameObject
The Prefab Asset used to create the Prefab instance from.

settings

ConvertToPrefabInstanceSettings
Settings to control the conversion.

mode

InteractionMode
Using UserAction will record undo and show dialogs if needed.

Remarks

This function will keep the root GameObject position, rotation and scale in the Scene but merge the contents from the new Prefab Asset. When using ObjectMatchMode.ByName object matching is performed. When a match is found references to this object will survive the conversion. Note that matching cannot be performed for GameObjects with duplicate names in each of the input GameObject hierarchies.
Additional Resources: PrefabUtility.ConvertToPrefabInstances, PrefabUtility.ReplacePrefabAssetOfPrefabInstance.