Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetNearestPrefabInstanceRoot(Object)

Retrieves the GameObject that is the root of the nearest Prefab instance the object is part of.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor
public static GameObject GetNearestPrefabInstanceRoot(Object componentOrGameObject)

Parameters

componentOrGameObject

The object to check. Must be a component or GameObject.

Returns

Type

Description

GameObjectThe nearest Prefab instance root.

Remarks

The method searches the Transform hierarchy until it finds the root of any Prefab instance, regardless of whether that instance is an applied nested Prefab inside another Prefab, or not.
The method returns 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.
PrefabInstanceRoots (GetNearestPrefabInstanceRoot(Object))
Overview of which objects are Prefab instance roots.
In the editor, Prefab instance roots have Open and Select buttons, and in the case of an outermost Prefab instance root, an Overrides dropdown.