Version: 2019.3
LanguageEnglish
  • C#

PrefabUtility.ApplyObjectOverride

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 void ApplyObjectOverride(Object instanceComponentOrGameObject, string assetPath, InteractionMode action);

Parameters

instanceComponentOrGameObjectThe object on the Prefab instance to apply.
assetPathThe path of the Prefab Asset to apply to.
actionThe interaction mode for this action.

Description

Applies all overridden properties on a Prefab instance component or GameObject to the Prefab Asset at the given asset path.

This method allows you to apply modified property values to an existing Prefab. It mirrors the functionality in the editor, described in the user manual here. To use this method, you must first modify one or more property values on an existing Prefab instance.

If you pass a GameObject as the object parameter, only the overrides on the GameObject itself are applied (such as layer, tag, and static flags); not its components or child GameObjects. If you pass a Component as the object parameter, only the overrides on that Component are applied. To apply all overrides of a Prefab, you can use PrefabUtility.ApplyPrefabInstance.

Modified property values on a Prefab instance are a type of Instance Override. The act of applying the modified property values to the Prefab means the modifed values become part of the Prefab Asset, and are no longer overrides.

When applying modified property values to a Prefab Asset, you must supply the asset path as a parameter. This is because there are some situations where there are multiple possible targets to apply the change to. For example, if the property values have been modified on a GameObject that is part of a nested Prefab, you may have the choice of applying the change to the inner nested Prefab Asset, or to the outer root Prefab Asset. Therefore, by specifying the asset path, you make it clear to Unity which Prefab Asset the change must be applied to.

You can read more in the user manual about the choice of apply targets.

See Also: PrefabUtility.ApplyAddedComponent, PrefabUtility.ApplyAddedGameObject, PrefabUtility.ApplyPropertyOverride, PrefabUtility.ApplyRemovedComponent, PrefabUtility.ApplyPrefabInstance.

Did you find this page useful? Please give it a rating: