PrefabUtility.GetOriginalSourceRootWhereGameObjectIsAdded

Parameters

Returns

GameObject The Prefab Asset root where the input GameObject was added.

Description

Use this method to find the Prefab Asset root where a Prefab instance or Prefab Asset object was added originally.

Use this method to find the "original source" where the input object was added. This is useful in situations where you are working with nested prefabs, and you need to in which prefab your instance of a nested prefab was originally added.

For example, in the diagram shown below, prefab asset "A" contains a child nested prefab "B", which contains a child nested prefab "C".



Due to this structure, prefab "C" exists in both "A" and "B", however it was originally added in "B".

Therefore in this example scenario, when the GameObject "C (Instance)" is passed in as the source to this method, this method returns the asset "B".

The 'Open Prefab' button in the Restructure Dialog uses this method to determine the correct Prefab Asset to open in Prefab Mode.

The example script below adds a menu item to the editor, which launches a simple wizard that allows you to test the results of this method.

using UnityEditor;
using UnityEngine;
public class AssetSourceTestWizard : ScriptableWizard
{
    public GameObject instance;

    [MenuItem("Test/Asset Source Test Wizard")]
    static void CreateWizard()
    {
        ScriptableWizard.DisplayWizard<AssetSourceTestWizard>("Asset Source Test Wizard", "Do Test");
    }

    void OnWizardCreate()
    {
        var o1 = PrefabUtility.GetOriginalSourceRootWhereGameObjectIsAdded(instance);
        Debug.Log("Original source root where GameObject is added: " + o1.name + " from: " + AssetDatabase.GetAssetPath(o1));
    }
}

If you need to know the original source for a given GameObject or Component (not where it is added) then use GetCorrespondingObjectFromOriginalSource.

See also: GetCorrespondingObjectFromSource, GetCorrespondingObjectFromSourceAtPath, GetCorrespondingObjectFromOriginalSource.