Blockbench Reference Docs
    Preparing search index...

    Interface Window

    A window containing a DOM document; the document property points to the DOM document loaded in that window.

    MDN Reference

    interface Window {
        Blockbench: {
            addDragHandler: any;
            argv: string[];
            browser: string;
            drag_handlers: {};
            events: {};
            export: any;
            exportFile: any;
            findFileFromContent: any;
            flags: any[];
            Format: number | ModelFormat;
            import: any;
            importFile: any;
            isLandscape: boolean;
            isMobile: boolean;
            isPWA: boolean;
            isTouch: boolean;
            isWeb: boolean;
            openTime: Date;
            operating_system: string;
            pickDirectory: any;
            platform: string;
            Project: number | ModelProject;
            queries: Record<string, string | boolean>;
            read: any;
            readFile: any;
            removeDragHandler: any;
            setup_successful: true;
            startup_count: number;
            Undo: UndoSystem;
            version: string;
            writeFile: any;
            addCSS(css: string, layer?: string): Deletable;
            addFlag(flag: string): void;
            addListener<T extends keyof BlockbenchEventMap, D extends any>(
                event_name: T,
                cb: (data: D) => any,
            ): Deletable;
            addMenuEntry(name: string, icon: IconString, click: any): void;
            dispatchEvent<T extends keyof BlockbenchEventMap, D extends any>(
                event_name: T,
                data: D,
            ): any[];
            edit(aspects: UndoAspects, cb: () => void): void;
            getIconNode(
                icon: boolean | IconString | (() => boolean | IconString),
                color?: string,
            ): HTMLElement;
            hasFlag(flag: string): boolean;
            isNewerThan(version: string): boolean;
            isOlderThan(version: string): boolean;
            notification(title: string, text: string, icon?: string): void;
            on<T extends keyof BlockbenchEventMap, D extends any>(
                event_name: T,
                cb: (data: D) => any,
            ): Deletable;
            once<T extends keyof BlockbenchEventMap, D extends any>(
                event_name: T,
                cb: (data: D) => any,
            ): Deletable;
            onUpdateTo(
                version: string,
                callback: (previous_version: string) => void,
            ): void;
            openLink(link: string): void;
            registerEdit(): void;
            reload(): void;
            removeFlag(flag: string): void;
            removeListener<T extends keyof BlockbenchEventMap, D extends any>(
                event_name: T,
                cb: (data: D) => any,
            ): void;
            removeMenuEntry(name: string): void;
            setCursorTooltip(text?: string): void;
            setProgress(progress: number, time?: number, bar?: string): void;
            setStatusBarText(text?: string): void;
            showMessage(message: any, location: any): void;
            showMessageBox(
                options: MessageBoxOptions,
                cb?: (
                    button: string | number,
                    result?: Record<string, boolean>,
                    event?: Event,
                ) => void,
            ): MessageBox;
            showQuickMessage(message: any, time?: number): void;
            showStatusMessage(message: string, time?: number): void;
            showToastNotification(options: ToastNotificationOptions): any;
            textPrompt(
                title: string,
                value: string,
                callback: (text: string) => void,
                options?: { description?: string; info?: string; placeholder?: string },
            ): Promise<unknown>;
        };
        open_menu: Menu;
        osfs: "\\"
        | "/";
        SystemInfo: {
            appdata_directory: string;
            arch: Architecture;
            desktop_directory: string;
            home_directory: string;
            os_version: string;
            platform: Platform;
            temp_directory: string;
            user_data_directory: string;
        };
        Toolbox: ToolboxToolbar;
        VersionUtil: typeof VersionUtil;
        [index: number]: Window;
    }

    Hierarchy

    • EventTarget
    • AnimationFrameProvider
    • GlobalEventHandlers
    • WindowEventHandlers
    • WindowLocalStorage
    • WindowOrWorkerGlobalScope
    • WindowSessionStorage
    • TrustedTypesWindow
      • Window

    Indexable

    Index

    Properties

    Blockbench open_menu osfs SystemInfo Toolbox VersionUtil

    Properties

    Blockbench: {
        addDragHandler: any;
        argv: string[];
        browser: string;
        drag_handlers: {};
        events: {};
        export: any;
        exportFile: any;
        findFileFromContent: any;
        flags: any[];
        Format: number | ModelFormat;
        import: any;
        importFile: any;
        isLandscape: boolean;
        isMobile: boolean;
        isPWA: boolean;
        isTouch: boolean;
        isWeb: boolean;
        openTime: Date;
        operating_system: string;
        pickDirectory: any;
        platform: string;
        Project: number | ModelProject;
        queries: Record<string, string | boolean>;
        read: any;
        readFile: any;
        removeDragHandler: any;
        setup_successful: true;
        startup_count: number;
        Undo: UndoSystem;
        version: string;
        writeFile: any;
        addCSS(css: string, layer?: string): Deletable;
        addFlag(flag: string): void;
        addListener<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): Deletable;
        addMenuEntry(name: string, icon: IconString, click: any): void;
        dispatchEvent<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            data: D,
        ): any[];
        edit(aspects: UndoAspects, cb: () => void): void;
        getIconNode(
            icon: boolean | IconString | (() => boolean | IconString),
            color?: string,
        ): HTMLElement;
        hasFlag(flag: string): boolean;
        isNewerThan(version: string): boolean;
        isOlderThan(version: string): boolean;
        notification(title: string, text: string, icon?: string): void;
        on<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): Deletable;
        once<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): Deletable;
        onUpdateTo(
            version: string,
            callback: (previous_version: string) => void,
        ): void;
        openLink(link: string): void;
        registerEdit(): void;
        reload(): void;
        removeFlag(flag: string): void;
        removeListener<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): void;
        removeMenuEntry(name: string): void;
        setCursorTooltip(text?: string): void;
        setProgress(progress: number, time?: number, bar?: string): void;
        setStatusBarText(text?: string): void;
        showMessage(message: any, location: any): void;
        showMessageBox(
            options: MessageBoxOptions,
            cb?: (
                button: string | number,
                result?: Record<string, boolean>,
                event?: Event,
            ) => void,
        ): MessageBox;
        showQuickMessage(message: any, time?: number): void;
        showStatusMessage(message: string, time?: number): void;
        showToastNotification(options: ToastNotificationOptions): any;
        textPrompt(
            title: string,
            value: string,
            callback: (text: string) => void,
            options?: { description?: string; info?: string; placeholder?: string },
        ): Promise<unknown>;
    }

    Type Declaration

    • addDragHandler: any
    • argv: string[]
    • browser: string
    • drag_handlers: {}
    • events: {}
    • export: any
    • exportFile: any
    • findFileFromContent: any
    • flags: any[]
    • Format: number | ModelFormat
    • import: any
    • importFile: any
    • isLandscape: boolean
    • isMobile: boolean
    • ReadonlyisPWA: boolean
    • isTouch: boolean
    • isWeb: boolean
    • openTime: Date
    • operating_system: string
    • pickDirectory: any
    • platform: string
    • Project: number | ModelProject
    • queries: Record<string, string | boolean>
    • read: any
    • readFile: any
    • removeDragHandler: any
    • setup_successful: true
    • startup_count: number
    • ReadonlyUndo: UndoSystem
    • version: string
    • writeFile: any
    • 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<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): Deletable

        Type Parameters

        Parameters

        • event_name: T
        • cb: (data: D) => any

        Returns Deletable

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

        Parameters

        Returns void

    • dispatchEvent: function
      • dispatchEvent<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            data: D,
        ): any[]

        Type Parameters

        Parameters

        • event_name: T
        • data: D

        Returns any[]

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

        Parameters

        Returns void

        Use Undo.initEdit and Undo.finishEdit instead

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

        Parameters

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

        Returns HTMLElement

    • 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<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): Deletable

        Type Parameters

        Parameters

        • event_name: T
        • cb: (data: D) => any

        Returns Deletable

    • once: function
      • once<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): Deletable

        Type Parameters

        Parameters

        • event_name: T
        • cb: (data: D) => any

        Returns Deletable

    • onUpdateTo: function
      • onUpdateTo(version: string, callback: (previous_version: string) => void): void

        Parameters

        • version: string
        • callback: (previous_version: string) => void

        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<T extends keyof BlockbenchEventMap, D extends any>(
            event_name: T,
            cb: (data: D) => any,
        ): void

        Type Parameters

        Parameters

        • event_name: T
        • cb: (data: D) => any

        Returns void

    • 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,
        ): MessageBox

        Parameters

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

        Returns MessageBox

    • 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
    • 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

    open_menu: Menu
    osfs: "\\" | "/"
    SystemInfo: {
        appdata_directory: string;
        arch: Architecture;
        desktop_directory: string;
        home_directory: string;
        os_version: string;
        platform: Platform;
        temp_directory: string;
        user_data_directory: string;
    }
    Toolbox: ToolboxToolbar
    VersionUtil: typeof VersionUtil

    Settings

    Member Visibility

    On This Page

    Properties