Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

PrefabUtility.GetPrefabInstanceHandle

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 Object GetPrefabInstanceHandle(Object instanceComponentOrGameObject);

Parameters

instanceComponentOrGameObject An object from the Prefab instance.

Returns

Object The Prefab instance handle.

Description

Retrieves the PrefabInstance object for the outermost Prefab instance the provided object is part of.

If the provided object is not part of a Prefab instance, the function returns null.

You can use this to check if two different GameObjects or Components are part of the same Prefab instance by comparing the objects. It cannot be used to compare a Prefab instance with a nested Prefab that’s part of it, since the method returns the handle of the outermost Prefab instance that an object is part of. It can however be used to compare an added child Prefab instance with the parent Prefab instance it’s added to, since an added object is not part of the Prefab instance it’s added to.

The method works for Prefab instances in Scenes as well as Prefab instances inside Prefab assets. If the method returns a valid Prefab instance handle for an object inside a Prefab Asset, it means the object is part of a Prefab instance which is either a nested Prefab inside the asset, or the base Prefab instance of a Prefab Variant.