C/C++ SDK / C ABI · Editor / KroysCommandDesc

KroysCommandDesc

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

Kindstruct

Headerkroys/kroys_plugin.h

Members10

DECLARATION

Declaration

Declared in kroys/kroys_plugin.h.

kroys_plugin.h

typedef struct KroysCommandDesc { ... } KroysCommandDesc;

REFERENCE

Members

Fields

#uint32_t structSize;

Size of this struct as the writer compiled it (sizeof); the reader uses it to detect members appended by later minor versions.

field

#int32_t toolbar;

nonzero: also a button on the plugin toolbar strip

field

#const char* id;

local id; editor command id is "<plugin id>.<id>"

field

#const char* label;

Menu and palette label; null: id.

field

#const char* category;

palette group; null: plugin name

field

#const char* description;

Command palette description.

field

#const char* keywords;

Extra command palette search words.

field

#const char* menu;

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

field

#const char* icon;

Lucide icon name

field

#const char* shortcut;

"Ctrl+Shift+H" (Scene context); null: none

fieldsince 2.1

Members

uint32_t structSize;
int32_t toolbar;
const char* id;
const char* label;
const char* category;
const char* description;
const char* keywords;
const char* menu;
const char* icon;
const char* shortcut;

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