PLUGIN SDK / Registration options / ComponentField

ComponentField

A field of a plugin component type.

Kindrecord

NamespaceKroys.Plugins

Members9

SourceOptions.cs

DECLARATION

Declaration

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

Declaration

public sealed record ComponentField(string Name, KroysValueType Type)

REFERENCE

Members

Constructors

#public ComponentField(string Name, KroysValueType Type)

A field of a plugin component type.

Name: Field name: letters, digits and '_', starting with a letter.
Type: Value type (KROYS_VALUE_BOOL .. KROYS_VALUE_GUID).

constructor

Properties

#public string Name { get; init; }

Field name: letters, digits and '_', starting with a letter.

property

#public KroysValueType Type { get; init; }

Value type (KROYS_VALUE_BOOL .. KROYS_VALUE_GUID).

property

#public string? DisplayName { get; init; }

Inspector label.

property

#public string? Tooltip { get; init; }

Inspector tooltip.

property

#public uint Flags { get; init; }

KROYS_FIELD_* flags.

property

#public object? Default { get; init; }

Default value (bool, int, float, Vector2/3/4, string or Guid); null: zero.

property

#public float? Minimum { get; init; }

Inspector range (both set: a slider).

property

#public float? Maximum { get; init; }

Inspector range maximum.

property

Signatures

public ComponentField(string Name, KroysValueType Type)
public string Name { get; init; }
public KroysValueType Type { get; init; }
public string? DisplayName { get; init; }
public string? Tooltip { get; init; }
public uint Flags { get; init; }
public object? Default { get; init; }
public float? Minimum { get; init; }
public float? Maximum { get; init; }

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