docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Metadata

    Inheritance
    object
    Metadata
    DictionaryIndexMetadata
    IndexMetadata
    IndexerMetadata
    MemberMetadata
    ObjectMetadata
    PluginConfigurationItemMetadata
    ProxyMetadata
    RootMetadata
    Implements
    IAttributeProvider
    IList
    IDictionary
    ICollection
    IEnumerable
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.Core.Editor.dll
    Syntax
    public abstract class Metadata : IAttributeProvider, IList, IDictionary, ICollection, IEnumerable

    Constructors

    Metadata(object, Metadata)

    Declaration
    protected Metadata(object subpath, Metadata parent)
    Parameters
    Type Name Description
    object subpath
    Metadata parent

    Fields

    _definedType

    Declaration
    protected Type _definedType
    Field Value
    Type Description
    Type

    Properties

    Count

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    int

    IsFixedSize

    Declaration
    public bool IsFixedSize { get; }
    Property Value
    Type Description
    bool

    IsReadOnly

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type Description
    bool

    IsSynchronized

    Declaration
    public bool IsSynchronized { get; }
    Property Value
    Type Description
    bool

    this[int]

    Declaration
    public IndexMetadata this[int index] { get; }
    Parameters
    Type Name Description
    int index
    Property Value
    Type Description
    IndexMetadata

    this[string]

    Declaration
    public MemberMetadata this[string name] { get; }
    Parameters
    Type Name Description
    string name
    Property Value
    Type Description
    MemberMetadata

    Keys

    Declaration
    public ICollection Keys { get; }
    Property Value
    Type Description
    ICollection

    SyncRoot

    Declaration
    public object SyncRoot { get; }
    Property Value
    Type Description
    object

    Values

    Declaration
    public ICollection Values { get; }
    Property Value
    Type Description
    ICollection

    children

    Declaration
    public Metadata.Children children { get; }
    Property Value
    Type Description
    Metadata.Children

    definedType

    Declaration
    public Type definedType { get; protected set; }
    Property Value
    Type Description
    Type

    dictionaryKeyType

    Declaration
    public Type dictionaryKeyType { get; }
    Property Value
    Type Description
    Type

    dictionaryType

    Declaration
    public Type dictionaryType { get; }
    Property Value
    Type Description
    Type

    dictionaryValueType

    Declaration
    public Type dictionaryValueType { get; }
    Property Value
    Type Description
    Type

    enumerableElementType

    Declaration
    public Type enumerableElementType { get; }
    Property Value
    Type Description
    Type

    enumerableType

    Declaration
    public Type enumerableType { get; }
    Property Value
    Type Description
    Type

    instantiate

    Declaration
    public bool instantiate { get; set; }
    Property Value
    Type Description
    bool

    instantiator

    Declaration
    public Func<object> instantiator { get; set; }
    Property Value
    Type Description
    Func<object>

    isDictionary

    Declaration
    public bool isDictionary { get; }
    Property Value
    Type Description
    bool

    isEditable

    Declaration
    public virtual bool isEditable { get; set; }
    Property Value
    Type Description
    bool

    isEnumerable

    Declaration
    public bool isEnumerable { get; }
    Property Value
    Type Description
    bool

    isLinked

    Declaration
    public bool isLinked { get; }
    Property Value
    Type Description
    bool

    isList

    Declaration
    public bool isList { get; }
    Property Value
    Type Description
    bool

    isOrderedDictionary

    Declaration
    public bool isOrderedDictionary { get; }
    Property Value
    Type Description
    bool

    isPrefabDiff

    Declaration
    public bool isPrefabDiff { get; }
    Property Value
    Type Description
    bool

    isPrefabInstance

    Declaration
    public bool isPrefabInstance { get; }
    Property Value
    Type Description
    bool

    isPrefabInstanceWithDefinition

    Declaration
    public bool isPrefabInstanceWithDefinition { get; }
    Property Value
    Type Description
    bool

    isPrefabInstanceWithoutDefinition

    Declaration
    public bool isPrefabInstanceWithoutDefinition { get; }
    Property Value
    Type Description
    bool

    isPrefabRoot

    Declaration
    public bool isPrefabRoot { get; }
    Property Value
    Type Description
    bool

    isRevertibleToPrefab

    Declaration
    public bool isRevertibleToPrefab { get; }
    Property Value
    Type Description
    bool

    isRoot

    Declaration
    protected virtual bool isRoot { get; }
    Property Value
    Type Description
    bool

    label

    Declaration
    public GUIContent label { get; protected set; }
    Property Value
    Type Description
    GUIContent

    listElementType

    Declaration
    public Type listElementType { get; }
    Property Value
    Type Description
    Type

    listType

    Declaration
    public Type listType { get; }
    Property Value
    Type Description
    Type

    nullableValueType

    Declaration
    public Type nullableValueType { get; }
    Property Value
    Type Description
    Type

    parent

    Declaration
    public Metadata parent { get; }
    Property Value
    Type Description
    Metadata

    path

    Declaration
    public string path { get; }
    Property Value
    Type Description
    string

    prefabDefinition

    Declaration
    public Metadata prefabDefinition { get; protected set; }
    Property Value
    Type Description
    Metadata

    rawValue

    Declaration
    protected abstract object rawValue { get; set; }
    Property Value
    Type Description
    object

    root

    Declaration
    public Metadata root { get; }
    Property Value
    Type Description
    Metadata

    subpath

    Declaration
    protected object subpath { get; }
    Property Value
    Type Description
    object

    value

    Declaration
    public object value { get; set; }
    Property Value
    Type Description
    object

    valueType

    Declaration
    public Type valueType { get; }
    Property Value
    Type Description
    Type

    Methods

    Add(object)

    Declaration
    public int Add(object value)
    Parameters
    Type Name Description
    object value
    Returns
    Type Description
    int

    Add(object, object)

    Declaration
    public void Add(object key, object value)
    Parameters
    Type Name Description
    object key
    object value

    Ancestor(Func<Metadata, bool>, bool)

    Declaration
    public Metadata Ancestor(Func<Metadata, bool> predicate, bool includeSelf = false)
    Parameters
    Type Name Description
    Func<Metadata, bool> predicate
    bool includeSelf
    Returns
    Type Description
    Metadata

    AncestorHasAttribute(Type, bool)

    Declaration
    public bool AncestorHasAttribute(Type attributeType, bool inherit = true)
    Parameters
    Type Name Description
    Type attributeType
    bool inherit
    Returns
    Type Description
    bool

    AncestorHasAttribute<TAttribute>(bool)

    Declaration
    public bool AncestorHasAttribute<TAttribute>(bool inherit = true) where TAttribute : Attribute
    Parameters
    Type Name Description
    bool inherit
    Returns
    Type Description
    bool
    Type Parameters
    Name Description
    TAttribute

    Ancestor<T>(bool)

    Declaration
    public T Ancestor<T>(bool includeSelf = false) where T : Metadata
    Parameters
    Type Name Description
    bool includeSelf
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    ApplyResizableList()

    Declaration
    protected void ApplyResizableList()

    AutoDig(string)

    Declaration
    public Metadata AutoDig(string path)
    Parameters
    Type Name Description
    string path
    Returns
    Type Description
    Metadata

    Cast(Type)

    Declaration
    public CastMetadata Cast(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    CastMetadata

    Cast<T>()

    Declaration
    public CastMetadata Cast<T>()
    Returns
    Type Description
    CastMetadata
    Type Parameters
    Name Description
    T

    Clear()

    Declaration
    public void Clear()

    Contains(object)

    Declaration
    public bool Contains(object value)
    Parameters
    Type Name Description
    object value
    Returns
    Type Description
    bool

    CopyTo(Array, int)

    Declaration
    public void CopyTo(Array array, int index)
    Parameters
    Type Name Description
    Array array
    int index

    Descendants(Func<Metadata, bool>)

    Declaration
    public IEnumerable<Metadata> Descendants(Func<Metadata, bool> predicate)
    Parameters
    Type Name Description
    Func<Metadata, bool> predicate
    Returns
    Type Description
    IEnumerable<Metadata>

    Descendants<T>()

    Declaration
    public IEnumerable<T> Descendants<T>() where T : Metadata
    Returns
    Type Description
    IEnumerable<T>
    Type Parameters
    Name Description
    T

    DictionaryKeyAt(int)

    Declaration
    public DictionaryKeyAtIndexMetadata DictionaryKeyAt(int index)
    Parameters
    Type Name Description
    int index
    Returns
    Type Description
    DictionaryKeyAtIndexMetadata

    DictionaryValueAt(int)

    Declaration
    public DictionaryValueAtIndexMetadata DictionaryValueAt(int index)
    Parameters
    Type Name Description
    int index
    Returns
    Type Description
    DictionaryValueAtIndexMetadata

    Dig<TSubpath, TMetadata>(TSubpath, Func<Metadata, TMetadata>, bool, Metadata)

    Declaration
    protected TMetadata Dig<TSubpath, TMetadata>(TSubpath subpath, Func<Metadata, TMetadata> constructor, bool createInPrefab, Metadata prefabInstance = null) where TMetadata : Metadata
    Parameters
    Type Name Description
    TSubpath subpath
    Func<Metadata, TMetadata> constructor
    bool createInPrefab
    Metadata prefabInstance
    Returns
    Type Description
    TMetadata
    Type Parameters
    Name Description
    TSubpath
    TMetadata

    Duplicate(int)

    Declaration
    public void Duplicate(int index)
    Parameters
    Type Name Description
    int index

    EditorPref(PluginConfiguration, MemberInfo)

    Declaration
    public EditorPrefMetadata EditorPref(PluginConfiguration configuration, MemberInfo member)
    Parameters
    Type Name Description
    PluginConfiguration configuration
    MemberInfo member
    Returns
    Type Description
    EditorPrefMetadata

    EnsureLinked()

    Declaration
    public void EnsureLinked()

    Equals(object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    object.Equals(object)

    FromProperty(SerializedProperty)

    Declaration
    public static Metadata FromProperty(SerializedProperty property)
    Parameters
    Type Name Description
    SerializedProperty property
    Returns
    Type Description
    Metadata

    GetAncestorAttribute(Type, bool)

    Declaration
    public Attribute GetAncestorAttribute(Type attributeType, bool inherit = true)
    Parameters
    Type Name Description
    Type attributeType
    bool inherit
    Returns
    Type Description
    Attribute

    GetAncestorAttribute<TAttribute>(bool)

    Declaration
    public TAttribute GetAncestorAttribute<TAttribute>(bool inherit = true) where TAttribute : Attribute
    Parameters
    Type Name Description
    bool inherit
    Returns
    Type Description
    TAttribute
    Type Parameters
    Name Description
    TAttribute

    GetAncestorAttributes(Type, bool)

    Declaration
    public IEnumerable<Attribute> GetAncestorAttributes(Type attributeType, bool inherit)
    Parameters
    Type Name Description
    Type attributeType
    bool inherit
    Returns
    Type Description
    IEnumerable<Attribute>

    GetAncestorAttributes<TAttribute>(bool)

    Declaration
    public IEnumerable<TAttribute> GetAncestorAttributes<TAttribute>(bool inherit = true) where TAttribute : Attribute
    Parameters
    Type Name Description
    bool inherit
    Returns
    Type Description
    IEnumerable<TAttribute>
    Type Parameters
    Name Description
    TAttribute

    GetCustomAttributes(bool)

    Declaration
    public abstract Attribute[] GetCustomAttributes(bool inherit = true)
    Parameters
    Type Name Description
    bool inherit
    Returns
    Type Description
    Attribute[]

    GetEnumerator()

    Declaration
    public IEnumerator GetEnumerator()
    Returns
    Type Description
    IEnumerator

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    object.GetHashCode()

    GetResizableList()

    Declaration
    protected IList GetResizableList()
    Returns
    Type Description
    IList

    Index(int)

    Declaration
    public IndexMetadata Index(int index)
    Parameters
    Type Name Description
    int index
    Returns
    Type Description
    IndexMetadata

    IndexOf(object)

    Declaration
    public int IndexOf(object value)
    Parameters
    Type Name Description
    object value
    Returns
    Type Description
    int

    Indexer(object)

    Declaration
    public IndexerMetadata Indexer(object indexer)
    Parameters
    Type Name Description
    object indexer
    Returns
    Type Description
    IndexerMetadata

    InferOwnerFromParent()

    Declaration
    public void InferOwnerFromParent()

    Insert(int, object)

    Declaration
    public void Insert(int index, object value)
    Parameters
    Type Name Description
    int index
    object value

    KeyMetadata(int)

    Declaration
    public Metadata KeyMetadata(int index)
    Parameters
    Type Name Description
    int index
    Returns
    Type Description
    Metadata

    MatchWithPrefab()

    Declaration
    public void MatchWithPrefab()

    Member(string, BindingFlags)

    Declaration
    public MemberMetadata Member(string name, BindingFlags bindingFlags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic)
    Parameters
    Type Name Description
    string name
    BindingFlags bindingFlags
    Returns
    Type Description
    MemberMetadata

    Move(int, int)

    Declaration
    public void Move(int sourceIndex, int destinationIndex)
    Parameters
    Type Name Description
    int sourceIndex
    int destinationIndex

    Object(string, object)

    Declaration
    public ObjectMetadata Object(string name, object @object)
    Parameters
    Type Name Description
    string name
    object object
    Returns
    Type Description
    ObjectMetadata

    Object(string, object, Type)

    Declaration
    public ObjectMetadata Object(string name, object @object, Type definedType)
    Parameters
    Type Name Description
    string name
    object object
    Type definedType
    Returns
    Type Description
    ObjectMetadata

    OnParentValueChange(object)

    Declaration
    protected virtual void OnParentValueChange(object previousValue)
    Parameters
    Type Name Description
    object previousValue

    OnParentValueTypeChange(Type)

    Declaration
    protected virtual void OnParentValueTypeChange(Type previousType)
    Parameters
    Type Name Description
    Type previousType

    OnValueChange(object)

    Declaration
    protected virtual void OnValueChange(object previousValue)
    Parameters
    Type Name Description
    object previousValue

    OnValueTypeChange(Type)

    Declaration
    protected virtual void OnValueTypeChange(Type previousType)
    Parameters
    Type Name Description
    Type previousType

    ProjectSetting(PluginConfiguration, MemberInfo)

    Declaration
    public ProjectSettingMetadata ProjectSetting(PluginConfiguration configuration, MemberInfo member)
    Parameters
    Type Name Description
    PluginConfiguration configuration
    MemberInfo member
    Returns
    Type Description
    ProjectSettingMetadata

    Proxy(object, Metadata)

    Declaration
    public ProxyMetadata Proxy(object subpath, Metadata binding)
    Parameters
    Type Name Description
    object subpath
    Metadata binding
    Returns
    Type Description
    ProxyMetadata

    RecordUndo()

    Declaration
    public void RecordUndo()

    RecordUndo(string)

    Declaration
    public void RecordUndo(string name)
    Parameters
    Type Name Description
    string name

    Remove(object)

    Declaration
    public void Remove(object value)
    Parameters
    Type Name Description
    object value

    RemoveAt(int)

    Declaration
    public void RemoveAt(int index)
    Parameters
    Type Name Description
    int index

    RevertToPrefab()

    Declaration
    public void RevertToPrefab()

    Root()

    Declaration
    public static Metadata Root()
    Returns
    Type Description
    Metadata

    StaticObject(object)

    Declaration
    public ObjectMetadata StaticObject(object @object)
    Parameters
    Type Name Description
    object object
    Returns
    Type Description
    ObjectMetadata

    StaticObject(object, Type)

    Declaration
    public ObjectMetadata StaticObject(object @object, Type definedType)
    Parameters
    Type Name Description
    object object
    Type definedType
    Returns
    Type Description
    ObjectMetadata

    SubpathToString()

    Declaration
    protected virtual string SubpathToString()
    Returns
    Type Description
    string

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()

    Unlink()

    Declaration
    public void Unlink()

    UnlinkChildren()

    Declaration
    public void UnlinkChildren()

    ValueMetadata(int)

    Declaration
    public Metadata ValueMetadata(int index)
    Parameters
    Type Name Description
    int index
    Returns
    Type Description
    Metadata

    Events

    valueChanged

    Declaration
    public event Action<object> valueChanged
    Event Type
    Type Description
    Action<object>

    valueTypeChanged

    Declaration
    public event Action<Type> valueTypeChanged
    Event Type
    Type Description
    Action<Type>

    Implements

    IAttributeProvider
    IList
    IDictionary
    ICollection
    IEnumerable

    Extension Methods

    Cloning.Clone(object, ICloner, bool)
    Cloning.Clone(object, ICloner, bool)
    Cloning.CloneViaFakeSerialization(object)
    Cloning.CloneViaFakeSerialization(object)
    ConversionUtility.ConvertTo(object, Type)
    ConversionUtility.ConvertTo(object, Type)
    ConversionUtility.ConvertTo<T>(object)
    ConversionUtility.ConvertTo<T>(object)
    ConversionUtility.IsConvertibleTo(object, Type, bool)
    ConversionUtility.IsConvertibleTo(object, Type, bool)
    ConversionUtility.IsConvertibleTo<T>(object, bool)
    ConversionUtility.IsConvertibleTo<T>(object, bool)
    Serialization.Serialize(object, bool)
    Serialization.Serialize(object, bool)
    TypeUtility.ToShortString(object, int)
    TypeUtility.ToShortString(object, int)
    UnityObjectUtility.IsUnityNull(object)
    UnityObjectUtility.IsUnityNull(object)
    UnityObjectUtility.ToSafeString(object)
    UnityObjectUtility.ToSafeString(object)
    XAnalyserProvider.Analyser(object, GraphReference)
    XAnalyserProvider.Analyser(object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(object, IGraphContext)
    XAnalyserProvider.Analysis(object, GraphReference)
    XAnalyserProvider.Analysis(object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(object, IGraphContext)
    XDescriptorProvider.Describe(object)
    XDescriptorProvider.Description(object)
    XDescriptorProvider.Description<TDescription>(object)
    XDescriptorProvider.Descriptor(object)
    XDescriptorProvider.Descriptor<TDescriptor>(object)
    XDescriptorProvider.HasDescriptor(object)
    Cloning.CloneViaFakeSerialization<T>(T)
    Cloning.CloneViaFakeSerialization<T>(T)
    Cloning.Clone<T>(T, ICloner, bool)
    Cloning.Clone<T>(T, ICloner, bool)
    LinqUtility.Yield<T>(T)
    LinqUtility.Yield<T>(T)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, bool)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, bool)
    Serialization.CloneViaSerialization<T>(T, bool)
    Serialization.CloneViaSerialization<T>(T, bool)
    XEditorProvider.Editor(Metadata)
    XEditorProvider.Editor<TInspector>(Metadata)
    XEditorProvider.HasEditor(Metadata)
    XInspectorProvider.HasInspector(Metadata)
    XInspectorProvider.Inspector(Metadata)
    XInspectorProvider.Inspector<TInspector>(Metadata)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)