Blockbench Reference Docs
    Preparing search index...

    Interface ToolSpecificOptions

    interface ToolSpecificOptions {
        allowed_view_modes?: ViewMode;
        alt_tool?: string;
        animation_channel?: string;
        brush?: BrushOptions;
        cursor?: string;
        modes?: string[];
        paintTool?: boolean;
        raycast_options?: { edges?: boolean; vertices?: boolean };
        selectElements?: boolean;
        selectFace?: boolean;
        toolbar?: string;
        transform_toolbar?: string;
        transformerMode?: "" | "translate" | "hidden";
        onCanvasClick?(raycast_data: RaycastResult): void;
        onCanvasMouseMove?(raycast_data: RaycastResult): any;
        onCanvasRightClick?(raycast_data: RaycastResult): any;
        onSelect?(): void;
        onTextureEditorClick?(raycast_data: RaycastResult): any;
        onUnselect?(): void;
    }

    Hierarchy (View Summary)

    • ToolSpecificOptions

    Implemented by

    Index

    Properties

    allowed_view_modes? alt_tool? animation_channel? brush? cursor? modes? paintTool? raycast_options? selectElements? selectFace? toolbar? transform_toolbar? transformerMode?

    Methods

    onCanvasClick? onCanvasMouseMove? onCanvasRightClick? onSelect? onTextureEditorClick? onUnselect?

    Properties

    allowed_view_modes?: ViewMode
    alt_tool?: string
    animation_channel?: string
    brush?: BrushOptions
    cursor?: string
    modes?: string[]
    paintTool?: boolean
    raycast_options?: { edges?: boolean; vertices?: boolean }
    selectElements?: boolean
    selectFace?: boolean
    toolbar?: string
    transform_toolbar?: string
    transformerMode?: "" | "translate" | "hidden"

    Methods

    • Parameters

      Returns void

    • Parameters

      Returns any

    • Parameters

      Returns any

    • Returns void

    • Parameters

      Returns any

    • Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods