Class UnitDescriptor<TUnit>
Inheritance
UnitDescriptor<TUnit>
Syntax
[Descriptor(typeof(IUnit))]
public class UnitDescriptor<TUnit> : Descriptor<TUnit, UnitDescription>, IAssigner, IUnitDescriptor, IDescriptor where TUnit : class, IUnit
Type Parameters
Constructors
UnitDescriptor(TUnit)
Declaration
public UnitDescriptor(TUnit target)
Parameters
Type |
Name |
Description |
TUnit |
target |
|
Properties
reflectedDescription
Declaration
protected UnitDescription reflectedDescription { get; }
Property Value
unit
Declaration
public TUnit unit { get; }
Property Value
unitType
Declaration
protected Type unitType { get; }
Property Value
Methods
DefaultIcon()
Declaration
protected virtual EditorTexture DefaultIcon()
Returns
DefaultIcons()
Declaration
protected virtual IEnumerable<EditorTexture> DefaultIcons()
Returns
DefaultShortTitle()
Declaration
protected virtual string DefaultShortTitle()
Returns
DefaultSubtitle()
Declaration
protected virtual string DefaultSubtitle()
Returns
DefaultSummary()
Declaration
protected virtual string DefaultSummary()
Returns
DefaultSurtitle()
Declaration
protected virtual string DefaultSurtitle()
Returns
DefaultTitle()
Declaration
protected virtual string DefaultTitle()
Returns
DefinedIcon()
Declaration
protected virtual EditorTexture DefinedIcon()
Returns
DefinedIcons()
Declaration
protected virtual IEnumerable<EditorTexture> DefinedIcons()
Returns
DefinedPort(IUnitPort, UnitPortDescription)
Declaration
protected virtual void DefinedPort(IUnitPort port, UnitPortDescription description)
Parameters
DefinedShortTitle()
Declaration
protected virtual string DefinedShortTitle()
Returns
DefinedSubtitle()
Declaration
protected virtual string DefinedSubtitle()
Returns
DefinedSummary()
Declaration
protected virtual string DefinedSummary()
Returns
DefinedSurtitle()
Declaration
protected virtual string DefinedSurtitle()
Returns
DefinedTitle()
Declaration
protected virtual string DefinedTitle()
Returns
DescribePort(IUnitPort, UnitPortDescription)
Declaration
public void DescribePort(IUnitPort port, UnitPortDescription description)
Parameters
Implements
ErrorIcon(Exception)
Declaration
protected virtual EditorTexture ErrorIcon(Exception exception)
Parameters
Returns
ErrorIcons(Exception)
Declaration
protected virtual IEnumerable<EditorTexture> ErrorIcons(Exception exception)
Parameters
Returns
ErrorShortTitle(Exception)
Declaration
protected virtual string ErrorShortTitle(Exception exception)
Parameters
Returns
ErrorSubtitle(Exception)
Declaration
protected virtual string ErrorSubtitle(Exception exception)
Parameters
Returns
ErrorSummary(Exception)
Declaration
protected virtual string ErrorSummary(Exception exception)
Parameters
Returns
ErrorSurtitle(Exception)
Declaration
protected virtual string ErrorSurtitle(Exception exception)
Parameters
Returns
ErrorTitle(Exception)
Declaration
protected virtual string ErrorTitle(Exception exception)
Parameters
Returns
FreeReflectedDescriptions()
Declaration
public static void FreeReflectedDescriptions()
Icon()
Declaration
[Assigns]
[RequiresUnityAPI]
public sealed override EditorTexture Icon()
Returns
Overrides
Unity.VisualScripting.Descriptor<TUnit, Unity.VisualScripting.UnitDescription>.Icon()
Implements
Icons()
Declaration
[Assigns]
[RequiresUnityAPI]
public IEnumerable<EditorTexture> Icons()
Returns
ReflectedPortDescription(IUnitPort)
Declaration
protected UnitPortDescription ReflectedPortDescription(IUnitPort port)
Parameters
Returns
ShortTitle()
Declaration
[Assigns]
public string ShortTitle()
Returns
Implements
Subtitle()
Declaration
[Assigns]
public string Subtitle()
Returns
Implements
Summary()
Declaration
[Assigns]
public sealed override string Summary()
Returns
Overrides
Unity.VisualScripting.Descriptor<TUnit, Unity.VisualScripting.UnitDescription>.Summary()
Implements
Surtitle()
Declaration
[Assigns]
public string Surtitle()
Returns
Implements
Title()
Declaration
[Assigns]
public sealed override string Title()
Returns
Overrides
Unity.VisualScripting.Descriptor<TUnit, Unity.VisualScripting.UnitDescription>.Title()
Implements
Explicit Interface Implementations
IUnitDescriptor.unit
Declaration
IUnit IUnitDescriptor.unit { get; }
Returns
Implements
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.