Variable BlockbenchConst

Type Declaration

• addDragHandler: typeof Filesystem.addDragHandler

• argv: string[]

• drag_handlers: {}

• events: {}

• export: typeof Filesystem.exportFile

• exportFile: typeof Filesystem.exportFile

• findFileFromContent: typeof Filesystem.findFileFromContent

• flags: any[]

• Format: ModelFormat | number

• import: typeof Filesystem.importFile

• importFile: typeof Filesystem.importFile

• isLandscape: boolean

• isMobile: boolean

• isPWA: boolean

• isTouch: boolean

• isWeb: boolean

• ModelFormat: typeof ModelFormat

• openTime: Date

• operating_system: string

• pickDirectory: typeof Filesystem.pickDirectory

• platform: string

• Project: ModelProject | number

• queries: {}

• read: typeof Filesystem.readFile

• readFile: typeof Filesystem.readFile

• removeDragHandler: typeof Filesystem.removeDragHandler

• Setting: any

• settings: any

• Settings: any

• SettingsProfile: any

• setup_successful: null | true

• Undo: UndoSystem

• version: string

• writeFile: typeof Filesystem.writeFile

• addCSS: function

  • addCSS(css: string, layer?: string): Deletable

    Parameters

    • css: string
    • Optionallayer: string

    Returns Deletable

• addFlag: function

  • addFlag(flag: string): void

    Parameters

    • flag: string

    Returns void

• addListener: function

  • addListener(event_name: EventName, cb: any): any

    Parameters

    • event_name: EventName
    • cb: any

    Returns any

• addMenuEntry: function

  • addMenuEntry(name: string, icon: string, click: any): void

    Parameters

    • name: string
    • icon: string
    • click: any

    Returns void

• dispatchEvent: function

  • dispatchEvent(event_name: EventName, data: any): any[]

    Parameters

    • event_name: EventName
    • data: any

    Returns any[]

• edit: function

  • edit(aspects: UndoAspects, cb: () => void): void

    Parameters

    • aspects: UndoAspects
    • cb: () => void

    Returns void

    Deprecated

    Use Undo.initEdit and Undo.finishEdit instead

• getIconNode: function

  • getIconNode(
        icon:
            | string
            | boolean
            | HTMLElement
            | (() => string | boolean | HTMLElement),
        color?: string,
    ): any

    Parameters

    • icon: string | boolean | HTMLElement | (() => string | boolean | HTMLElement)
    • Optionalcolor: string

    Returns any

• hasFlag: function

  • hasFlag(flag: string): boolean

    Parameters

    • flag: string

    Returns boolean

• isNewerThan: function

  • isNewerThan(version: string): boolean

    Parameters

    • version: string

    Returns boolean

• isOlderThan: function

  • isOlderThan(version: string): boolean

    Parameters

    • version: string

    Returns boolean

• notification: function

  • notification(title: string, text: string, icon?: string): void

    Parameters

    • title: string
    • text: string
    • Optionalicon: string

    Returns void

• on: function

  • on(event_name: EventName, cb: any): any

    Parameters

    • event_name: EventName
    • cb: any

    Returns any

• once: function

  • once(event_name: EventName, cb: any): any

    Parameters

    • event_name: EventName
    • cb: any

    Returns any

• onUpdateTo: function

  • onUpdateTo(version: any, callback: any): void

    Parameters

    • version: any
    • callback: any

    Returns void

• openLink: function

  • openLink(link: string): void

    Parameters

    • link: string

    Returns void

• registerEdit: function

  • registerEdit(): void

    Returns void

• reload: function

  • reload(): void

    Returns void

• removeFlag: function

  • removeFlag(flag: string): void

    Parameters

    • flag: string

    Returns void

• removeListener: function

  • removeListener(event_name: EventName, cb: any): any

    Parameters

    • event_name: EventName
    • cb: any

    Returns any

• removeMenuEntry: function

  • removeMenuEntry(name: string): void

    Parameters

    • name: string

    Returns void

• setCursorTooltip: function

  • setCursorTooltip(text?: string): void

    Parameters

    • Optionaltext: string

    Returns void

• setProgress: function

  • setProgress(progress: number, time?: number, bar?: string): void

    Parameters

    • progress: number
    • Optionaltime: number
    • Optionalbar: string

    Returns void

• setStatusBarText: function

  • setStatusBarText(text?: string): void

    Parameters

    • Optionaltext: string

    Returns void

• showMessage: function

  • showMessage(message: any, location: any): void

    Parameters

    • message: any
    • location: any

    Returns void

• showMessageBox: function

  • showMessageBox(
        options: MessageBoxOptions,
        cb?: (
            button: string | number,
            result?: Record<string, boolean>,
            event?: Event,
        ) => void,
    ): any

    Parameters

    • options: MessageBoxOptions
    • Optionalcb: (
          button: string | number,
          result?: Record<string, boolean>,
          event?: Event,
      ) => void

    Returns any

• showQuickMessage: function

  • showQuickMessage(message: any, time?: number): void

    Parameters

    • message: any
    • Optionaltime: number

    Returns void

• showStatusMessage: function

  • showStatusMessage(message: string, time?: number): void

    Parameters

    • message: string
    • Optionaltime: number

    Returns void

• showToastNotification: function

  • showToastNotification(options: ToastNotificationOptions): any

    Parameters

    • options: ToastNotificationOptions

    Returns any

• textPrompt: function

  • textPrompt(
        title: string,
        value: string,
        callback: (text: string) => void,
        options?: { description?: string; info?: string; placeholder?: string },
    ): Promise<unknown>

    Parameters

    • title: string
    • value: string
    • callback: (text: string) => void
    • Optionaloptions: { description?: string; info?: string; placeholder?: string }

      Options

      • Optionaldescription?: string

        Description for the text input

      • Optionalinfo?: string

        Info text

      • Optionalplaceholder?: string

    Returns Promise<unknown>

    Input value