Interface IModalToolContainer

interface IModalToolContainer {
    currentTools: IModalTool[];
    onSelectedToolChanged: EventSink<SelectedModalToolChangedEventPayload>;
    addTool(id: string, params: ModalToolCreationParameters): IModalTool;
    focusToolInputContext(): void;
    getSelectedToolId(): string;
    removeTool(id: string): void;
    setSelectedToolId(id: string): void;
}

Index

Properties

currentTools onSelectedToolChanged

Methods

addTool focusToolInputContext getSelectedToolId removeTool setSelectedToolId

Properties

`Readonly`currentTools

currentTools: IModalTool[]

Remarks

Tools within this container.

onSelectedToolChanged

onSelectedToolChanged: EventSink<SelectedModalToolChangedEventPayload>

Remarks

Provides events when the selected modal tool changes.

Methods

addTool

addTool(id: string, params: ModalToolCreationParameters): IModalTool
Parameters
- id: string
  Unique identifier for the tool
- params: ModalToolCreationParameters
  Construction parameters for the new tool
Returns IModalTool
Remarks
Create a new tool in the modal tool container represented via button on the tool rail.
- Defined in @minecraft/server-editor.d.ts:7757

focusToolInputContext

focusToolInputContext(): void
Returns void
Remarks
Activates input bindings for the selected tool by enabling viewport focus
- Defined in @minecraft/server-editor.d.ts:7764

getSelectedToolId

getSelectedToolId(): string
Returns string
Remarks
Returns identifier of the selected tool.
- Defined in @minecraft/server-editor.d.ts:7770

removeTool

removeTool(id: string): void
Parameters
- id: string
  Name of the tool to remove.
Returns void
Remarks
Remove an existing tool by id from the tool container
- Defined in @minecraft/server-editor.d.ts:7778

setSelectedToolId

setSelectedToolId(id: string): void
Parameters
- id: string
  Identifier of the tool
Returns void
Remarks
Selects a tool in the container.
- Defined in @minecraft/server-editor.d.ts:7786