docs.unity3d.com
    Show / Hide Table of Contents

    Class Descriptor<TTarget>

    Inheritance
    Object
    Descriptor<TTarget>
    BoltClassEventDescriptor
    BoltClassEventParameterDescriptor
    BoltClassVariableDescriptor
    BoltEnumElementDescriptor
    BoltTypeShellDescriptor<TShell>
    ControlConnectionDescriptor
    FlowGraphVariableDescriptor
    GraphDescriptor<TGraph>
    GraphRootDescriptor<TRoot>
    StateDescriptor<TState>
    StateTransitionDescriptor<TStateTransition>
    UnitDescriptor<TUnit>
    UnitPortDescriptor<TPort>
    BoltTypeDescriptor<TType>
    EnumDescriptor
    UnityObjectDescriptor<T>
    Namespace: Ludiq
    Syntax
    public class Descriptor<TTarget> : IDescriptor, IDisposable
    Type Parameters
    Name Description
    TTarget

    Constructors

    Descriptor(TTarget)

    Declaration
    public Descriptor(TTarget target)
    Parameters
    Type Name Description
    TTarget target

    Fields

    _icon

    Declaration
    protected Reactive<EditorTexture> _icon
    Field Value
    Type Description
    Reactive<EditorTexture>

    _summary

    Declaration
    protected Reactive<string> _summary
    Field Value
    Type Description
    Reactive<String>

    _title

    Declaration
    protected Reactive<string> _title
    Field Value
    Type Description
    Reactive<String>

    _warnings

    Declaration
    protected Reactive<IReadOnlyList<Warning>> _warnings
    Field Value
    Type Description
    Reactive<IReadOnlyList<Warning>>

    Properties

    icon

    Declaration
    public EditorTexture icon { get; }
    Property Value
    Type Description
    EditorTexture
    Implements
    IDescriptor.icon

    summary

    Declaration
    public string summary { get; }
    Property Value
    Type Description
    String
    Implements
    IDescriptor.summary

    target

    Declaration
    public TTarget target { get; }
    Property Value
    Type Description
    TTarget

    title

    Declaration
    public string title { get; }
    Property Value
    Type Description
    String
    Implements
    IDescriptor.title

    warnings

    Declaration
    public IReadOnlyList<Warning> warnings { get; }
    Property Value
    Type Description
    IReadOnlyList<Warning>
    Implements
    IDescriptor.warnings

    Methods

    Dispose()

    Declaration
    public void Dispose()

    Icon()

    Declaration
    protected virtual EditorTexture Icon()
    Returns
    Type Description
    EditorTexture

    OnChange(Object, PropertyChangedEventArgs)

    Declaration
    protected virtual void OnChange(object sender, PropertyChangedEventArgs e)
    Parameters
    Type Name Description
    Object sender
    PropertyChangedEventArgs e

    Property<T>(Func<T>, Boolean, Boolean)

    Declaration
    protected Reactive<T> Property<T>(Func<T> fetch, bool requiresConstantFetch = false, bool requiresUnityApi = false)
    Parameters
    Type Name Description
    Func<T> fetch
    Boolean requiresConstantFetch
    Boolean requiresUnityApi
    Returns
    Type Description
    Reactive<T>
    Type Parameters
    Name Description
    T

    Property<T>(Func<IEnumerable<T>>, Boolean, Boolean)

    Declaration
    protected Reactive<IReadOnlyList<T>> Property<T>(Func<IEnumerable<T>> fetch, bool requiresConstantFetch = false, bool requiresUnityApi = false)
    Parameters
    Type Name Description
    Func<IEnumerable<T>> fetch
    Boolean requiresConstantFetch
    Boolean requiresUnityApi
    Returns
    Type Description
    Reactive<IReadOnlyList<T>>
    Type Parameters
    Name Description
    T

    RegisterProperties()

    Declaration
    protected virtual void RegisterProperties()

    RegisterProperty(IReactive)

    Declaration
    protected void RegisterProperty(IReactive property)
    Parameters
    Type Name Description
    IReactive property

    SetDirty()

    Declaration
    public void SetDirty()
    Implements
    IDescriptor.SetDirty()

    StartWatching()

    Declaration
    protected virtual void StartWatching()

    StopWatching()

    Declaration
    protected virtual void StopWatching()

    Summary()

    Declaration
    protected virtual string Summary()
    Returns
    Type Description
    String

    Title()

    Declaration
    protected virtual string Title()
    Returns
    Type Description
    String

    Unwatch(INotifyPropertyChanged)

    Declaration
    protected void Unwatch(INotifyPropertyChanged target)
    Parameters
    Type Name Description
    INotifyPropertyChanged target

    Validate()

    Declaration
    public void Validate()
    Implements
    IDescriptor.Validate()

    Warnings()

    Declaration
    protected virtual IEnumerable<Warning> Warnings()
    Returns
    Type Description
    IEnumerable<Warning>

    Watch(INotifyPropertyChanged)

    Declaration
    protected void Watch(INotifyPropertyChanged target)
    Parameters
    Type Name Description
    INotifyPropertyChanged target

    Events

    propertyChanged

    Declaration
    public event Action propertyChanged
    Event Type
    Type Description
    Action
    Implements
    IDescriptor.propertyChanged

    Explicit Interface Implementations

    IDescriptor.target

    Declaration
    object IDescriptor.target { get; }
    Returns
    Type Description
    Object
    Implements
    IDescriptor.target

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptor.ToGUIContent(IDescriptor, Int32)
    LiteralUtility.ToLiteralString(Object)
    LiteralUtility.ToLiteralStringOrDefault(Object)
    LiteralUtility.TryToLiteralString(Object, out String)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone(Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy(Object)
    Cloning.CloneViaSerializationPolicy(Object, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy<T>(T)
    Cloning.CloneViaSerializationPolicy<T>(T, out Dictionary<Object, Object>)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneValueType(Object)
    ConversionUtility.ConvertTo<TSource>(TSource, Type)
    ConversionUtility.IsLateConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsLateConvertibleTo<T>(Object, Boolean)
    ConversionUtility.LateConvertTo(Object, Type)
    ConversionUtility.LateConvertTo<T>(Object)
    ConversionUtility.TryLateConvertTo(Object, Type, out Object, Boolean)
    ConversionUtility.TryLateConvertTo<T>(Object, out T, Boolean)
    TypeUtility.ToShortString(Object, Int32)
    TypeUtility.CastTo<T>(Object)
    Serialization.FullSerialize(Object, Boolean)
    Serialization.OdinSerialize<T>(T, DataFormat)
    Serialization.OdinSerialize<T>(T, ref SerializationData, DataFormat)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(Object)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    BoltGenerationUtility.GenerateLiteral(Object, IGeneration)
    XGeneratorProvider.Generator(Object, IGeneration)
    XGeneratorProvider.Generator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.HasGenerator(Object, IGeneration)
    XGeneratorProvider.HasGenerator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.TryGetGenerator(Object, out IGenerator, IGeneration)
    XGeneratorProvider.TryGetGenerator<TGenerator>(Object, IGeneration, out TGenerator)
    HybridConversionUtility.ConvertTo(Object, HybridType, HybridType)
    HybridConversionUtility.IsLateConvertibleTo(Object, HybridType, Boolean)
    HybridConversionUtility.LateConvertTo(Object, HybridType)
    HybridConversionUtility.TryLateConvertTo(Object, HybridType, out Object, Boolean)
    HybridTypeUtility.GetHybridType(Object)
    IsUtility.Is<TO, TC>(TO, out TC)
    PrivateReflectionUsingDynamicExtensions.AsDynamic(Object)
    JsonWriter.ToJson(Object)
    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