C/C++ SDK / C++ layer · Registration options / kroys::CommandOptions

kroys::CommandOptions

Options of Host::AddCommand (KroysCommandDesc).

Kindstruct

Headerkroys/plugin.hpp

Members9

DECLARATION

Declaration

Declared in kroys/plugin.hpp.

plugin.hpp

struct CommandOptions

REFERENCE

Members

Fields

#std::string id;

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

fieldwraps KroysCommandDesc::id

#std::string label;

Menu and palette label; null: id.

fieldwraps KroysCommandDesc::label

#std::string description;

Command palette description.

fieldwraps KroysCommandDesc::description

#std::string keywords;

Extra command palette search words.

fieldwraps KroysCommandDesc::keywords

#std::string category;

palette group; null: plugin name

fieldwraps KroysCommandDesc::category

#std::string menu;

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

fieldwraps KroysCommandDesc::menu

#std::string icon;

Lucide icon name

fieldwraps KroysCommandDesc::icon

#std::string shortcut;

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

fieldwraps KroysCommandDesc::shortcut

#bool toolbar = false;

nonzero: also a button on the plugin toolbar strip

fieldwraps KroysCommandDesc::toolbar

Signatures

std::string id;
std::string label;
std::string description;
std::string keywords;
std::string category;
std::string menu;
std::string icon;
std::string shortcut;
bool toolbar = false;

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