SchemaType.md

May 21, 2024 · View on GitHub

Friflo.Engine.ECS

Friflo.Engine.ECS

SchemaType Class

Provide meta data for Script classes and IComponent / ITag structs.

public abstract class SchemaType

Inheritance System.Object 🡒 SchemaType

Derived
ComponentType
ScriptType
TagType

Fields
ComponentKeyIf Kind is a Component or a Script the key assigned with ComponentKeyAttribute.
If null the component is not serialized.
KindReturns the SchemaTypeKind of the type.
NameReturns the System.Type name of the struct / class.
SymbolColorA color used to symbolize a component, tag or script in a UI or CLI.
See ComponentSymbolAttribute
SymbolNameA string with 1, 2 or 3 characters used to symbolize a component, tag or script in a UI or CLI.
See ComponentSymbolAttribute
TypeIf Kind == Tag the type of a tag struct implementing ITag.
If Kind == Component the type of a component struct implementing IComponent.
If Kind == Script the type of a script class extending Script.