Interface ISimpleToolRailOptionsBeta

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 {
    displayAltText: string;
    displayStringId?: string;
    icon: string;
    onActivate?: (component: ISimpleToolRailComponent) => void;
    onDeactivate?: (component: ISimpleToolRailComponent) => void;
    onFinalize?: (component: ISimpleToolRailComponent) => void;
    onTeardown?: (component: ISimpleToolRailComponent) => void;
    tooltipAltText: string;
    tooltipStringId?: string;
}

Properties

displayAltText displayStringId? icon onActivate? onDeactivate? onFinalize? onTeardown? tooltipAltText tooltipStringId?

Properties

BetadisplayAltText

displayAltText: string

Optional BetadisplayStringId

displayStringId?: string

Betaicon

icon: string

OptionalonActivate

onActivate?: (component: ISimpleToolRailComponent) => void

OptionalonDeactivate

onDeactivate?: (component: ISimpleToolRailComponent) => void

OptionalonFinalize

onFinalize?: (component: ISimpleToolRailComponent) => void

OptionalonTeardown

onTeardown?: (component: ISimpleToolRailComponent) => void

BetatooltipAltText

tooltipAltText: string

Optional BetatooltipStringId

tooltipStringId?: string

Settings

Member Visibility

On This Page

Properties