Interface ISimpleToolRailOptions

The tool rail component allows the tool to register an icon and button (and dynamic tooltip) in the tool rail on the left side of the display. Adding a tool rail component to a tool will cause the tool to be considered a modal tool, and only one single modal tool can be active at any one time. Modal tools are generally tools which take focus and control of the cursor (e.g. selection, clipboards, entity selection, etc) Global tools (tools which do not have a tool rail) are generally things like property pages, settings, etc - things that do not require an active cursor or gameplay interaction

Hierarchy

  • ISimpleToolRailOptions

Properties

icon onActivate? onDeactivate? onFinalize? onTeardown? title tooltip

Properties

icon

icon: string

Remarks

The icon for the tool rail button. This is generally a URL to an image file in the editor extension resource pack e.g. pack://textures/my-tool-icon.png

Optional onActivate

onActivate?: ((component) => void)

Type declaration

Optional onDeactivate

onDeactivate?: ((component) => void)

Type declaration

Optional onFinalize

onFinalize?: ((component) => void)

Type declaration

Optional onTeardown

onTeardown?: ((component) => void)

Type declaration

title

title: string

Remarks

The text for the tool title

tooltip

tooltip: string

Remarks

The tooltip description for the tool. Note: if an activation key binding was added to ISimpleToolOptions, then the key binding will be appended to the tooltip string.

Settings

Member Visibility

Theme

On This Page