Version: 2020.2
LanguageEnglish
  • C#

PrefabUtility.IsPartOfImmutablePrefab

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

public static bool IsPartOfImmutablePrefab(Object componentOrGameObject);

Parameters

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

Returns

bool True if the object is part of a Prefab that cannot be edited.

Description

Is this object part of a Prefab that cannot be edited?

For an object on a Prefab Asset, the asset itself is checked. For an object on a Prefab instance, its corresponding asset is checked.

Examples of immutable Prefabs are Model Prefab and Prefabs in read-only folders.

For Prefab contents loaded in Prefab Mode, this method will not check the Prefab Asset the loaded contents are loaded from, since these Prefab contents are loaded into a preview scene and are not part of an Asset while being edited in Prefab Mode. This means that for Prefab contents in Prefab Mode, the method will return true for instances of immutable Prefabs, but not for GameObjects or components that are not part of a Prefab instance.

See Also: PrefabStage.IsPartOfPrefabContents.