Blockbench Reference Docs
    Preparing search index...

    Class Tool

    A tool, such as move tool, vertex snap tool, or paint brush

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    allowed_view_modes? alt_tool? animation_channel? brush? category? children? click color? condition cursor? default_keybind? description events icon? icon_node id keybind menu_node menus modes? name node nodes onClick paintTool? plugin? raycast_options? searchable? selectElements? selectFace? side_menu? sub_keybinds? tool_config? tool_settings toolbar? toolbars transform_toolbar? transformerMode? type uniqueNode? variations? work_in_dialog? all constructing selected

    Methods

    addLabel addListener addSubKeybind conditionMet delete dispatchEvent getNode on onCanvasClick? onCanvasMouseMove? onCanvasRightClick? once onSelect? onTextureEditorClick? onUnselect? pushToolbar removeListener select setIcon setName switchModeAndSelect toElement trigger updateKeybindingLabel

    Constructors

    Properties

    allowed_view_modes?: ViewMode
    alt_tool?: string
    animation_channel?: string
    brush?: BrushOptions
    category?: string
    children?: any[] | ((context: any) => any[])
    click: (event?: Event) => void
    color?: string
    condition: ConditionResolvable
    cursor?: string
    default_keybind?: Keybind
    description: string
    events: Record<string, EventListener[]>
    icon?: string | (() => string)
    icon_node: HTMLElement
    id: string
    keybind: Keybind
    menu_node: HTMLElement
    menus: { menu: Menu; path: string }[]
    modes?: string[]
    name: string
    node: HTMLElement
    nodes: HTMLElement[]
    onClick: any
    paintTool?: boolean
    plugin?: string

    The plugin that this was added by

    raycast_options?: { edges?: boolean; vertices?: boolean }
    searchable?: boolean
    selectElements?: boolean
    selectFace?: boolean
    side_menu?: Menu | Dialog | ToolConfig

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

    sub_keybinds?: Record<string, SubKeybind>
    tool_config?: ToolConfig

    Provide a window with additional configutation related to the action

    tool_settings: Record<string, any>
    toolbar?: string
    toolbars: Toolbar[]
    transform_toolbar?: string
    transformerMode?: "" | "translate" | "hidden"
    type: string
    uniqueNode?: boolean
    variations?: { [key: string]: { description?: string; name: string } }
    work_in_dialog?: boolean
    all: Tool[]
    constructing: BarItem
    selected: Tool

    Methods

    • Adds a label to the HTML element of the bar item

      Parameters

      • Optionalin_bar: boolean

        Set to true to generate an in-bar label, as opposed to a regular on-hover label

      • Optionalaction: any

        Provide the action to generate the label. This defaults to self and is only needed in special cases

      Returns void

    • Parameters

      • id: string
      • name: string
      • default_keybind: Keybind
      • trigger: any

      Returns void

    • Returns boolean

    • Returns void

    • Parameters

      • event_name: string
      • data: any

      Returns any

    • Gets a copy of the elements HTML node that is not yet in use.

      Parameters

      • ignore_disconnected: any

      Returns HTMLElement

    • Parameters

      Returns void

    • Returns this

    • Change the icon of the action

      Parameters

      • icon: string

      Returns void

    • Change the name of the action

      Parameters

      • name: string

      Returns void

    • Returns boolean

    • Appends the bar item to a HTML element

      Parameters

      • destination: string | HTMLElement

      Returns this

    • Trigger to run or select the action. This is the equivalent of clicking or using a keybind to trigger it. Also checks if the condition is met.

      Parameters

      Returns boolean

    • Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods