接口 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

interface ISimpleToolRailOptions {
    icon: string;
    onActivate?: ((component: ISimpleToolRailComponent) => void);
    onDeactivate?: ((component: ISimpleToolRailComponent) => void);
    onFinalize?: ((component: ISimpleToolRailComponent) => void);
    onTeardown?: ((component: ISimpleToolRailComponent) => void);
    title: string;
    tooltip: string;
}

属性

icon onActivate? onDeactivate? onFinalize? onTeardown? title tooltip

属性

实验性icon

icon: string

备注

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

可选onActivate

onActivate?: ((component: ISimpleToolRailComponent) => void)

可选onDeactivate

onDeactivate?: ((component: ISimpleToolRailComponent) => void)

可选onFinalize

onFinalize?: ((component: ISimpleToolRailComponent) => void)

可选onTeardown

onTeardown?: ((component: ISimpleToolRailComponent) => void)

实验性title

title: string

备注

The text for the tool title

实验性tooltip

tooltip: string

备注

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.

显示设置

成员可见性

目录

属性