ToolState

The active tool and its current state code.

Retrieve the active tool with model.tools.getActive(), or subscribe to changes with model.tools.observeToolChanges().

The state number is tool-specific — its meaning varies per tool and is not consistent across the SketchUp toolset.

Example

let model = await SketchUpApi.getActiveModel();

// React to tool state changes
model.tools.observeToolChanges(change => {
  if (change.event === 'StateChange') {
    console.log(change.state.tool.name);
    console.log(change.state.state);
  }
});

See

Tool
SketchupTools.getActive
SketchupTools.observeToolChanges

Since

SDK 1.19.0 protocol 1.16.0

Properties

state

readonly state: number

A numeric code representing the tool’s current state. The meaning varies per tool and is not standardized.

tool

readonly tool: Tool

The tool that is currently active.

Methods

toString()

toString(): string

Returns

string