Api Sandbox DisplayInfo
struct

DisplayInfo

public sealed struct DisplayInfo

Collects all the relevant info (such as description, name, icon, etc) from attributes and other sources about a type or type member.

Methods

Boolean HasTag(String t)

Returns whether this type or member has given tag. (TagAttribute)

t — The tag to test.
returns — Whether the tag is present or not
static DisplayInfo ForType(Type t, Boolean inherit = True)

Retrieves display info about a given type.

t — The type to look up display info for.
inherit — Whether to load in base type's display info first, then overrides all possible fields with given type's information.
returns — The display info. Will contain empty fields on failure.
static DisplayInfo For(Object t, Boolean inherit = True)

Retrieves display info about a given objects type.

t — The type to look up display info for.
inherit — Whether to load in base type's display info first, then overrides all possible fields with given type's information.
returns — The display info. Will contain empty fields on failure.
static DisplayInfo ForMember(MemberInfo t, Boolean inherit = True)

Retrieves display info about a given member or type.

t — The member to look up display info for.
inherit — If member given is a Type, loads in base type's display info first, then overrides all possible fields with given type's information.
returns — The display info. Will contain empty fields on failure.
static DisplayInfo[] ForEnumValues(Type t)

Returns display info for each member of an enumeration type.

static ValueTuple<T, DisplayInfo>[] ForEnumValues()

Returns display info for each member of an enumeration type.

Fields

Name Type Description
ClassName String "Internal" class name of this type or member. This typically should be all lowercase and without weird symbols or whitespace.
Namespace String Namespace of this type
Fullname String Namespace.ParentClass.Class.Member
Name String The name of this type or member.
Description String The summary or description of this type or member.
Group String Group or category of this type or member. (CategoryAttribute)
ReadOnly Boolean This is marked as ReadOnly
Icon String Material icon of this type or member. (IconAttribute)
Order Int32 Order of this member for UI ordering purposes. (OrderAttribute)
Browsable Boolean Whether this member should be visible in a properties sheet (HideInEditorAttribute)
Placeholder String Placeholder text for string type properties. (PlaceholderAttribute) Placeholder text is displayed in UI when input text field is empty.
Alias String[] Possible aliases for this type or member, if any. (AliasAttribute)
Tags String[] Tags of this type or member. (TagAttribute)
Assembly: Sandbox.Reflection Namespace: Sandbox Full Name: Sandbox.DisplayInfo