Version: 2018.4
LanguageEnglish
  • C#

PrefabUtility.IsOutermostPrefabInstanceRoot

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static bool IsOutermostPrefabInstanceRoot(GameObject gameObject);

Parameters

gameObject The GameObject to check.

Returns

bool True if the GameObject is an outermost Prefab instance root.

Description

Is the GameObject the root of a Prefab instance, excluding nested Prefabs?

Returns true if the GameObject is the root GameObject of a Prefab instance, which is not itself inside another Prefab instance.

This also returns true for a the root GameObject of a nested Prefab instance inside a Prefab Asset, but not for a nested Prefab instance inside another Prefab instance inside a Prefab Asset.

If the GameObject is a Prefab instance root which is an added GameObject to another Prefab instance, it will return true, since it it not an the root of an applied nested Prefab instance.

The method will return null if the given object is not part of a Prefab instance. This includes GameObjects or components that have been added and not applied to a Prefab instance.

In the editor, outermost Prefab instance roots have the Overrides dropdown, whereas other Prefab instance roots don’t.