s&box docs

public sealed struct Sandbox.DisplayInfo

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

Broader workflow and conceptual references connected to this API.

Methods

Showing 6 methods

public static Sandbox.DisplayInfo For(object t, bool inherit = True)

Retrieves display info about a given objects type.

Parameters

  • 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. Default: True

Returns

The display info. Will contain empty fields on failure.

public static Sandbox.DisplayInfo ForMember(System.Reflection.MemberInfo t, bool inherit = True)

Retrieves display info about a given member or type.

Parameters

  • t: The member to look up display info for.
  • inherit: If member given is a `System.Type`, loads in base type's display info first, then overrides all possible fields with given type's information. Default: True

Returns

The display info. Will contain empty fields on failure.

public static Sandbox.DisplayInfo ForType(System.Type t, bool inherit = True)

Retrieves display info about a given type.

Parameters

  • 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. Default: True

Returns

The display info. Will contain empty fields on failure.

public bool HasTag(string t)

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

Parameters

  • t: The tag to test.

Returns

Whether the tag is present or not

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Reflection
Doc IDT:Sandbox.DisplayInfo

On this page