docs.unity3d.com
    Show / Hide Table of Contents

    Class PrefabMetadata

    Container for prefab overrides

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    PrefabMetadata
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Unity.RuntimeSceneSerialization.Prefabs
    Syntax
    public class PrefabMetadata : MonoBehaviour

    Properties

    Guid

    The guid of this prefab

    Declaration
    public string Guid { get; set; }
    Property Value
    Type Description
    String

    Methods

    AddComponentOverride(Component)

    Add a component as an override to its parent prefab, if one exists

    Declaration
    public static void AddComponentOverride(Component component)
    Parameters
    Type Name Description
    Component component

    The component to add

    SetAddedComponent(String, Component)

    Add or update a property override to this prefab

    Declaration
    public void SetAddedComponent(string transformPath, Component addedComponent)
    Parameters
    Type Name Description
    String transformPath

    The transform path of the GameObject relative to the prefab root

    Component addedComponent

    The added Component to be applied as an override

    SetAddedGameObject(String, GameObject, SerializationMetadata)

    Add a GameObject to this prefab as an override

    Declaration
    public void SetAddedGameObject(string transformPath, GameObject addedGameObject, SerializationMetadata metadata)
    Parameters
    Type Name Description
    String transformPath

    The transform path of the GameObject relative to the prefab root

    GameObject addedGameObject

    The added GameObject to be applied as an override

    SerializationMetadata metadata

    SerializationMetadata to be used when serializing the scene

    SetPropertyOverride<TValue>(String, String, Int32, TValue, SerializationMetadata)

    Add or update a property override to this prefab

    Declaration
    public void SetPropertyOverride<TValue>(string propertyPath, string transformPath, int componentIndex, TValue value, SerializationMetadata metadata = null)
    Parameters
    Type Name Description
    String propertyPath

    The path of the property relative to its component

    String transformPath

    The transform path of the GameObject relative to the prefab root

    Int32 componentIndex

    The index of the component on the target transform

    TValue value

    The value to be applied as an override

    SerializationMetadata metadata

    SerializationMetadata to use for scene object or asset references

    Type Parameters
    Name Description
    TValue

    The property value type

    SetRemovedComponents(String, Int32)

    Remove a component from this prefab as an override

    Declaration
    public void SetRemovedComponents(string transformPath, int componentIndex)
    Parameters
    Type Name Description
    String transformPath

    The transform path of the GameObject relative to the prefab root

    Int32 componentIndex

    The index of the component to be removed as an override

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023