PLUGIN SDK / Registration options / CommandOptions

CommandOptions

A command (command palette, Tools > Plugins menu, optional toolbar button and shortcut).

Kindrecord

NamespaceKroys.Plugins

Members10

SourceOptions.cs

DECLARATION

Declaration

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

Declaration

public sealed record CommandOptions(string Id, string Label)

REFERENCE

Members

Constructors

#public CommandOptions(string Id, string Label)

A command (command palette, Tools > Plugins menu, optional toolbar button and shortcut).

Id: Local id; the editor command id is "<plugin id>.<Id>".
Label: Menu and palette label.

constructor

Properties

#public string Id { get; init; }

Local id; the editor command id is "<plugin id>.<Id>".

property

#public string Label { get; init; }

Menu and palette label.

property

#public string? Category { get; init; }

Palette group (null: the plugin name).

property

#public string? Description { get; init; }

Palette description.

property

#public string? Keywords { get; init; }

Extra search words.

property

#public string? Menu { get; init; }

Submenu path under Tools > Plugins ("A/B"); null: the plugin name.

property

#public string? Icon { get; init; }

Lucide icon name ("plug", "play", "folder" ...).

property

#public bool Toolbar { get; init; }

Also a button on the plugin toolbar of the viewport.

property

#public string? Shortcut { get; init; }

Shortcut such as "Ctrl+Shift+H" (Scene context).

property

Signatures

public CommandOptions(string Id, string Label)
public string Id { get; init; }
public string Label { get; init; }
public string? Category { get; init; }
public string? Description { get; init; }
public string? Keywords { get; init; }
public string? Menu { get; init; }
public string? Icon { get; init; }
public bool Toolbar { get; init; }
public string? Shortcut { get; init; }

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