Blockbench Reference Docs
    Preparing search index...

    Interface ToolOptions

    interface ToolOptions {
        allowed_view_modes?: ViewMode;
        alt_tool?: string;
        animation_channel?: string;
        brush?: BrushOptions;
        category?: string;
        children?: any[] | (() => any[]);
        color?: string;
        condition?: any;
        description?: string;
        icon?: string;
        keybind?: Keybind;
        label?: boolean;
        modes?: string[];
        name?: string;
        paintTool?: boolean;
        selectElements?: boolean;
        selectFace?: boolean;
        side_menu?: Menu;
        tool_config?: ToolConfig;
        toolbar?: string;
        transformerMode?: "" | "translate";
        variations?: { [key: string]: { description?: string; name: string } };
        click(event?: Event): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowed_view_modes? alt_tool? animation_channel? brush? category? children? color? condition? description? icon? keybind? label? modes? name? paintTool? selectElements? selectFace? side_menu? tool_config? toolbar? transformerMode? variations?

    Methods

    click

    Properties

    allowed_view_modes?: ViewMode
    alt_tool?: string
    animation_channel?: string
    brush?: BrushOptions
    category?: string
    children?: any[] | (() => any[])
    color?: string

    Icon color. Can be a CSS color string, or an axis letter to use an axis color.

    condition?: any
    description?: string
    icon?: string
    keybind?: Keybind
    label?: boolean

    Show the full label in toolbars

    modes?: string[]
    name?: string
    paintTool?: boolean
    selectElements?: boolean
    selectFace?: boolean
    side_menu?: Menu

    Provide a menu that belongs to the action, and gets displayed as a small arrow next to it in toolbars.

    tool_config?: ToolConfig

    Provide a window with additional configutation related to the action

    toolbar?: string
    transformerMode?: "" | "translate"
    variations?: { [key: string]: { description?: string; name: string } }

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods