PLUGIN SDK / Registration options / ComponentTypeOptions

ComponentTypeOptions

A plugin component type (capability "components").

Kindrecord

NamespaceKroys.Plugins

Members8

SourceOptions.cs

DECLARATION

Declaration

Namespace Kroys.Plugins, assembly KroysPlugins.Sdk.dll.

Declaration

public sealed record ComponentTypeOptions(string Name, IReadOnlyList<ComponentField> Fields)

REFERENCE

Members

Constructors

#public ComponentTypeOptions(string Name, IReadOnlyList<ComponentField> Fields)

A plugin component type (capability "components").

Name: Local name; the engine type is "<plugin id>.<Name>".
Fields: The reflected fields.

constructor

Properties

#public string Name { get; init; }

Local name; the engine type is "<plugin id>.<Name>".

property

#public IReadOnlyList<ComponentField> Fields { get; init; }

The reflected fields.

property

#public string? DisplayName { get; init; }

Inspector name.

property

#public string? Category { get; init; }

Add Component group (null: "Plugins").

property

#public string? Description { get; init; }

Description.

property

#public uint SchemaVersion { get; init; }

Schema version (>= 1).

property

#public uint Flags { get; init; }

KROYS_COMPONENT_* flags.

property

Signatures

public ComponentTypeOptions(string Name, IReadOnlyList<ComponentField> Fields)
public string Name { get; init; }
public IReadOnlyList<ComponentField> Fields { get; init; }
public string? DisplayName { get; init; }
public string? Category { get; init; }
public string? Description { get; init; }
public uint SchemaVersion { get; init; }
public uint Flags { get; init; }

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.