[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/PrefabUtility.IsAnyPrefabInstanceRoot.html [Back]  [Original]

Unity - Scripting API: PrefabUtility.IsAnyPrefabInstanceRoot
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#

    PrefabUtility.IsAnyPrefabInstanceRoot

    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
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Declaration

    public static bool IsAnyPrefabInstanceRoot(GameObject gameObject);

    Parameters

    Parameter Description
    gameObject The GameObject to check.

    Returns

    bool True if the GameObject is the root GameObject of any Prefab instance.

    Description

    Is the GameObject the root of any Prefab instance?

    Returns true if the GameObject is the root GameObject of a Prefab instance or the root GameObject of a nested Prefab.

    This also returns true for a root GameObject of a nested Prefab instance inside a Prefab Asset.

    The method return false for the root GameObject of a Prefab Asset itself, except if its a Prefab Variant, in which case it returns true.

    PrefabInstanceRoots.png [PrefabInstanceRoots.png]
    Overview of which objects are Prefab instance roots.

    Additional resources: IsOutermostPrefabInstanceRoot.


    Web Proxy Viewer  |  New URL  |  Original Page