Version: 2023.2
LanguageEnglish
  • C#

PrefabUtility.UnpackPrefabInstanceAndReturnNewOutermostRoots

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 GameObject[] UnpackPrefabInstanceAndReturnNewOutermostRoots(GameObject instanceRoot, PrefabUnpackMode unpackMode);

Parameters

instanceRoot Root GameObject of the Prefab instance.
unpackMode The unpack mode to use.

Returns

GameObject[] Array of GameObjects representing roots of unpacked Prefab instances.

Description

This function will unpack the given Prefab instance using the behaviour specified by unpackMode.

If the PrefabUnpackMode is the PrefabUnpackMode.OutermostRoot this function will return any new Prefab root GameObjects from any nested Prefabs at the first level.

Unlike UnpackPrefabInstance, this function can’t be made undoable. You will have to handle undo yourself.

See UnpackPrefabInstance for a full description of the unpacking behaviour.