blockbench-types 5.1.0 → 5.2.0-beta.0-next.2

package/documentation.md

@@ -1,12 +1,12 @@
-
-Welcome to the reference documentation for Blockbench!
-
-This documentation is automatically generated from the comments and typescript types of the latest Blockbench release.
-
-The documentation is mainly intended for plugin creators. You can find guides on how to get started with plugin development on the Blockbench wiki: [Creating a Plugin - Blockbench Wiki](https://www.blockbench.net/wiki/docs/plugin)
-
-### Navigation
-
-The documentation in the sidebar is divided into two categories: `custom` and `generated`. This separation is mostly irrelevant when reading types, it just stems from the fact that some code is written directly in Typescript, while other code is still written in Javascript with custom types. In some cases, there may be duplicated references between the two, in that case you can usually reference the one in `custom`.
-
-You should be able to find any class and variable via the search function.
+
+Welcome to the reference documentation for Blockbench!
+
+This documentation is automatically generated from the comments and typescript types of the latest Blockbench release.
+
+The documentation is mainly intended for plugin creators. You can find guides on how to get started with plugin development on the Blockbench wiki: [Creating a Plugin - Blockbench Wiki](https://www.blockbench.net/wiki/docs/plugin)
+
+### Navigation
+
+The documentation in the sidebar is divided into two categories: `custom` and `generated`. This separation is mostly irrelevant when reading types, it just stems from the fact that some code is written directly in Typescript, while other code is still written in Javascript with custom types. In some cases, there may be duplicated references between the two, in that case you can usually reference the one in `custom`.
+
+You should be able to find any class and variable via the search function.

package/generated/animations/mirror_animating.d.ts

@@ -0,0 +1,7 @@
+declare global {
+    interface BarItemRegistry {
+        mirror_animating: Toggle;
+        flip_animation: Action;
+    }
+}
+export {};

package/generated/animations/timeline_animators.d.ts

@@ -69,7 +69,7 @@ declare global {
                 max_data_points: number;
             };
         };
-        menu: Menu;
+        menu: import("../interface/menu").Menu;
     }
     class NullObjectAnimator extends BoneAnimator {
         solver: any;

package/generated/api.d.ts

@@ -34,12 +34,15 @@ export declare const Blockbench: {
     version: string;
     operating_system: string;
     platform: string;
+    browser: string;
     flags: any[];
     drag_handlers: {};
     events: {};
     openTime: Date;
     setup_successful: null | true;
     argv: string[];
+    queries: Record<string, string | boolean>;
+    startup_count: number;
     /**
      * @deprecated Use Undo.initEdit and Undo.finishEdit instead
      */
@@ -102,8 +105,9 @@ export declare const Blockbench: {
     removeDragHandler: typeof Filesystem.removeDragHandler;
 };
 declare global {
-    interface window {
+    interface Window {
         Blockbench: typeof Blockbench;
+        osfs: '/' | '\\';
     }
 }
 declare const global: {
@@ -117,12 +121,15 @@ declare const global: {
         version: string;
         operating_system: string;
         platform: string;
+        browser: string;
         flags: any[];
         drag_handlers: {};
         events: {};
         openTime: Date;
         setup_successful: null | true;
         argv: string[];
+        queries: Record<string, string | boolean>;
+        startup_count: number;
         /**
          * @deprecated Use Undo.initEdit and Undo.finishEdit instead
          */

package/generated/file_system.d.ts

@@ -5,12 +5,13 @@ declare global {
             path: string;
             content?: string | ArrayBuffer;
             browser_file?: File;
+            no_file?: boolean;
         };
         /**
          * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
          */
         export type ResourceID = string | 'texture' | 'minecraft_skin' | 'dev_plugin' | 'animation' | 'animation_particle' | 'animation_audio' | 'theme' | 'model' | 'gltf' | 'obj' | 'preview_background' | 'screenshot' | 'palette';
-        type ReadType = 'buffer' | 'binary' | 'text' | 'image' | 'none';
+        export type ReadType = 'buffer' | 'binary' | 'text' | 'image' | 'none';
         export interface ReadOptions {
             readtype?: ReadType | ((file: string) => ReadType);
             errorbox?: boolean;

package/generated/find_replace.d.ts

@@ -0,0 +1,6 @@
+import { Action } from './interface/actions';
+declare global {
+    interface BarItemRegistry {
+        find_replace: Action;
+    }
+}

package/generated/formats/standards/obj.d.ts

@@ -1,13 +1,11 @@
-declare global {
-    function getMtlFace(obj: any, index: any): string | false;
-    namespace cube_face_normals {
-        let north: number[];
-        let east: number[];
-        let south: number[];
-        let west: number[];
-        let up: number[];
-        let down: number[];
-    }
+declare var _obj_export: any;
+declare namespace cube_face_normals {
+    let north: number[];
+    let east: number[];
+    let south: number[];
+    let west: number[];
+    let up: number[];
+    let down: number[];
 }
-
+declare var codec: Codec;
 export {};

package/generated/interface/actions.d.ts

@@ -1,6 +1,8 @@
 import MolangParser from "molangjs";
 import tinycolor from "tinycolor2";
-export declare const BarItems: Record<string, BarItem>;
+import { RaycastResult } from "../preview/preview";
+import { MenuItem } from "./menu";
+export declare const BarItems: any;
 type SubKeybind = {
     name: string;
     keybind?: Keybind;
@@ -8,6 +10,7 @@ type SubKeybind = {
     trigger: (event: Event) => void;
 };
 export interface KeybindItemOptions {
+    id?: string;
     name?: string;
     description?: string;
     category?: string;
@@ -52,7 +55,7 @@ export declare abstract class BarItem extends EventSystem {
     id: string;
     name: string;
     description: string;
-    icon?: IconString | (() => IconString);
+    icon?: IconString | ((context?: any) => IconString);
     category?: string;
     color?: string;
     condition: ConditionResolvable;
@@ -112,9 +115,7 @@ export declare class KeybindItem {
             description?: string;
         };
     };
-    constructor(id: string, data: KeybindItemOptions & {
-        id: string;
-    });
+    constructor(id: string, data: KeybindItemOptions);
     delete(): void;
 }
 export interface ActionOptions extends BarItemOptions {
@@ -312,7 +313,7 @@ export interface BrushOptions {
 interface ToolSpecificOptions {
     selectFace?: boolean;
     selectElements?: boolean;
-    transformerMode?: 'translate' | 'hidden' | '';
+    transformerMode?: 'translate' | 'scale' | 'rotate' | 'stretch' | 'hidden' | '';
     cursor?: string;
     animation_channel?: string;
     toolbar?: string;
@@ -329,7 +330,7 @@ interface ToolSpecificOptions {
     onCanvasClick?(raycast_data: RaycastResult): void;
     onSelect?(): void;
     onUnselect?(): void;
-    onCanvasMouseMove?(raycast_data: RaycastResult): any;
+    onCanvasMouseMove?(raycast_data: RaycastResult | false): any;
     onCanvasRightClick?(raycast_data: RaycastResult): any;
     onTextureEditorClick?(raycast_data: RaycastResult): any;
 }
@@ -393,13 +394,13 @@ interface WidgetOptions extends BarItemOptions {
 export declare abstract class Widget extends BarItem {
     constructor(id: string, data: WidgetOptions);
 }
-type NumSliderOptions = WidgetOptions & {
+export type NumSliderOptions = WidgetOptions & {
     private?: boolean;
     settings?: {
         default?: number;
         min?: number;
         max?: number;
-        interval?: number;
+        interval?: number | (() => number);
         step?: number;
         show_bar?: boolean;
         limit?: boolean;
@@ -502,7 +503,7 @@ export declare class BarSlider extends Widget {
 type BarSelectPropertyFormat = string | boolean | {
     name: string | true;
     condition?: ConditionResolvable;
-    icon?: string;
+    icon?: IconString;
 };
 interface BarSelectOptions extends WidgetOptions {
     value?: string;
@@ -580,7 +581,7 @@ declare const global: {
         structure: {};
         save(): void;
     };
-    BarItems: Record<string, import("./actions").BarItem>;
+    BarItems: any;
 };
 declare global {
     type BarItem = import('./actions').BarItem;
@@ -605,6 +606,9 @@ declare global {
     const BarText: typeof global.BarText;
     type ColorPicker = import('./actions').ColorPicker;
     const ColorPicker: typeof global.ColorPicker;
-    const BarItems: typeof global.BarItems;
+    const BarItems: BarItemRegistry;
+    interface BarItemRegistry {
+        [key: string]: BarItem;
+    }
 }
 export {};

package/generated/interface/form.d.ts

@@ -1,5 +1,6 @@
+import { Filesystem } from "../file_system";
 import { EventSystem } from "../util/event_system";
-type ReadType = 'buffer' | 'binary' | 'text' | 'image';
+type ReadType = Filesystem.ReadType;
 export declare enum FormInputType {
     Text = "text",
     Password = "password",

package/generated/interface/main_tools.d.ts

@@ -0,0 +1,23 @@
+declare global {
+    interface BarItemRegistry {
+        move_tool: Tool;
+        resize_tool: Tool;
+        rotate_tool: Tool;
+        pivot_tool: Tool;
+        vertex_snap_tool: Tool;
+        stretch_tool: Tool;
+        swap_tools: Action;
+        set_element_marker_color: Action;
+        randomize_marker_colors: Action;
+        new_window: Action;
+        open_model_folder: Action;
+        reload: Action;
+        open_dev_tools: Action;
+        fullscreen: Action;
+        zoom_in: Action;
+        zoom_out: Action;
+        zoom_reset: Action;
+        toggle_sidebars: Action;
+    }
+}
+export {};

package/generated/interface/menu.d.ts

@@ -0,0 +1,141 @@
+/**
+ * The menu class lets you create content menus. Context menus can contain custom menu items, and a number of existing UI elements, including Actions, Tools, etc.
+ *
+ * ## Example
+ * ```
+ * document.addEventListener('contextmenu', event => {
+ *   let items = [
+ *     'open_model',
+ *     {
+ *       name: 'Example',
+ *       icon: 'house',
+ *       click() {
+ *         console.log('Hello World')
+ *       }
+ *     }
+ *   ];
+ *   new Menu(items).open(event);
+ * })
+ * ```
+ * @module
+ */
+export interface CustomMenuItem {
+    name: string;
+    id?: string;
+    icon: IconString | boolean | ((context: any) => (IconString | boolean));
+    color?: string;
+    description?: string;
+    condition?: ConditionResolvable;
+    /**
+     * Keybind or string to display in the menu, won't work as an actual keybinding by default
+     */
+    keybind?: Keybind | string;
+    /**
+     * If true, mark the menu item as the selected one (underlined text in default theme)
+     */
+    marked?: boolean | ((context: any) => boolean);
+    /**
+     * Adds a search bar to the menu or submenu
+     */
+    searchable?: boolean;
+    children?: MenuItem[] | ((context: any) => MenuItem[]);
+    click?(context?: any, event?: Event): void;
+}
+export type MenuItem = CustomMenuItem | Action | BarSelect | MenuSeparator | string | ((context: any) => MenuItem);
+type MenuOpenPositionAnchor = MouseEvent | HTMLElement | 'mouse';
+export interface MenuOptions {
+    onOpen?(position: MenuOpenPositionAnchor, context?: any): void;
+    onClose?(): void;
+    keep_open?: boolean;
+    searchable?: boolean;
+    class?: string | string[];
+}
+export declare class MenuSeparator {
+    id: string;
+    label?: string;
+    menu_node: HTMLLIElement;
+    constructor(id?: string, label?: string);
+}
+/**
+ * Use the Menu class to create a context menu. Menus can contain custom entries and hierarchy, or existing actions and tools.
+ */
+export declare class Menu implements Deletable {
+    id: string;
+    children: [];
+    structure: MenuItem[] | ((context: any) => MenuItem[]);
+    options?: MenuOptions;
+    condition?: ConditionResolvable;
+    onOpen?(position: MenuOpenPositionAnchor, context?: any): void;
+    onClose?(): void;
+    node: HTMLUListElement;
+    highlight_action?: MenuItem;
+    type: string;
+    /**
+     * Creates a new context menu
+     */
+    constructor(template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions);
+    constructor(id: string, template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions);
+    hover(node: HTMLElement, event?: Event, expand?: boolean): void;
+    /**
+     * Trigger keyboard navigation
+     * @param e Event
+     * @returns True if the input was used for navigation
+     * @private
+     */
+    keyNavigate(e: KeyboardEvent): boolean;
+    /**
+     * Opens the menu somewhere
+     * @param position Position where to open the menu. Can be a mouse event, or a node that the menu is spawned below.
+     * @param context Context for the click events inside the menu
+     */
+    open(position?: MenuOpenPositionAnchor, context?: any): this;
+    /**
+     * Alias for .open()
+     */
+    show(position?: MenuOpenPositionAnchor, context?: any): this;
+    /**
+     * Closes the menu if it's open
+     */
+    hide(): this;
+    /**
+     * @deprecated
+     */
+    conditionMet(): boolean;
+    /**
+     * Adds an action to the menu structure
+     * @param action Action to add
+     * @param path Path pointing to the location. Use the ID of each level of the menu, or index within a level, separated by a point. For example, `export.0` places the action at the top position of the Export submenu.
+     */
+    addAction(action: Action | CustomMenuItem | '_', path?: string | number): void;
+    /**
+     * Remove an action or menu item from the menu
+     * @param path Path pointing to the location. Use the ID of each level of the menu, or index within a level, or item ID, separated by a point. For example, `export.export_special_format` removes the action "Export Special Format" from the Export submenu.
+     */
+    removeAction(path: string | Action): void;
+    /**
+     * @deprecated Use removeAction instead
+     */
+    deleteItem(rm_item: Action): void;
+    delete(): void;
+    static open: Menu | null;
+    static closed_in_this_click?: string;
+}
+export declare function preventContextMenu(): void;
+declare const global: {
+    MenuSeparator: typeof import("./menu").MenuSeparator;
+    Menu: typeof import("./menu").Menu;
+    preventContextMenu: typeof import("./menu").preventContextMenu;
+    open_menu: any;
+};
+declare global {
+    type Menu = import('./menu').Menu;
+    const Menu: typeof global.Menu;
+    type MenuSeparator = import('./menu').MenuSeparator;
+    const MenuSeparator: typeof global.MenuSeparator;
+    function preventContextMenu(): void;
+    let open_menu: Menu | null;
+    interface Window {
+        open_menu: Menu | null;
+    }
+}
+export {};

package/generated/interface/menu_bar.d.ts

@@ -1,7 +1,6 @@
 declare global {
     class BarMenu extends Menu {
         constructor(id: any, structure: any, options?: {});
-        type: string;
         id: any;
         children: any[];
         condition: any;
@@ -9,7 +8,7 @@ declare global {
         name: string;
         label: HTMLElement;
         structure: any;
-        highlight_action: any;
+        highlight_action: import("./menu").MenuItem;
         open(...args: any[]): void;
         hide(): this;
         highlight(action: any): void;
@@ -27,5 +26,5 @@ declare global {
         function removeAction(path: any): void;
     }
 }
-
+import { Menu } from "./menu";
 export {};

package/generated/interface/resize_lines.d.ts

@@ -9,6 +9,7 @@ interface ResizeLineOptions {
     horizontal?: boolean;
     condition: ConditionResolvable;
     width?: number;
+    parent_element?: HTMLElement;
     get: (this: ResizeLine) => number;
     set: (this: ResizeLine, original: number, difference: number) => void;
     reset?: (this: ResizeLine) => void;
@@ -19,6 +20,7 @@ export interface ResizeLine extends ResizeLineOptions {
 export declare class ResizeLine implements ResizeLineOptions {
     before?: number;
     node: HTMLDivElement;
+    parent_element: HTMLElement;
     constructor(id: string, data: ResizeLineOptions);
     update(): void;
     setPosition(data: ResizeLinePositionData): void;

package/generated/interface/settings.d.ts

@@ -118,7 +118,9 @@ export declare const Settings: {
         open: boolean;
         items: Record<string, Setting>;
     }>;
-    stored: Record<string, SettingsValue>;
+    stored: Record<string, {
+        value: SettingsValue;
+    }>;
     dialog: Dialog | null;
     addCategory(id: string, data: {
         name?: string;
@@ -157,7 +159,9 @@ declare const globals: {
             open: boolean;
             items: Record<string, import("./settings").Setting>;
         }>;
-        stored: Record<string, SettingsValue>;
+        stored: Record<string, {
+            value: SettingsValue;
+        }>;
         dialog: Dialog | null;
         addCategory(id: string, data: {
             name?: string;

package/generated/interface/shared_actions.d.ts

@@ -6,6 +6,7 @@
  * Handlers can be added for existing actions like this:
 
 ### Example:
+* @example
 ```javascript
     // Duplicate layers when using "Duplicate" in the layers panel
     SharedActions.add('duplicate', {
@@ -23,6 +24,10 @@
         }
     })
 ```
+* @module
+ */
+/**
+ * Global Shared Actions namespace to access any functionality related to Shared Actions
  */
 export declare const SharedActions: {
     /**

package/generated/interface/start_screen.d.ts

@@ -1,47 +1,67 @@
-declare global {
+export declare const StartScreen: {
+    loaders: {};
+    vue: null | (Vue & any);
+    open(): void;
+    updateThumbnails(model_paths?: string[]): void;
+    addSection: typeof addStartScreenSection;
+};
+interface StartScreenTextSegment {
+    text: string;
+    type?: string;
+    list?: string[];
+    click?: () => void;
+}
+interface StartScreenFeature {
+    image: string;
+    title: string;
     /**
-     *
-     * @param {string} id Identifier
-     * @param {object} data
-     * @param {object} data.graphic
-     * @param {'icon'|string} data.graphic.type
-     * @param {string} [data.graphic.icon]
-     * @param {string} [data.graphic.source]
-     * @param {number} [data.graphic.width]
-     * @param {number} [data.graphic.height]
-     * @param {number} [data.graphic.aspect_ratio] Section aspect ratio
-     * @param {string} [data.graphic.description] Markdown string
-     * @param {string} [data.graphic.text_color]
-     * @param {Array.<{text: String, {type}: [String], [list]: Array.String, {click}: [Function]}>} data.text
-     * @param {'vertical'|'horizontal'} data.layout
-     * @param {Array} data.features
-     * @param {boolean} data.closable
-     * @param {Function} data.click
-     * @param {string} data.color
-     * @param {string} data.text_color
-     * @param {boolean} data.last
-     * @param {string} data.insert_after
-     * @param {string} data.insert_before
-     * @returns
+     * Markdown supported text
      */
-    function addStartScreenSection(id: string, data: {
-        graphic: {
-            type: "icon" | string;
-            icon?: string;
-            source?: string;
-            width?: number;
-            height?: number;
-            aspect_ratio?: number;
-            description?: string;
-            text_color?: string;
-        };
-    }): {
-        delete(): void;
+    text: string;
+}
+export interface StartScreenSection {
+    graphic?: {
+        type: 'icon' | string;
+        icon?: string;
+        source?: string;
+        width?: number;
+        height?: number;
+        aspect_ratio?: number;
+        /**
+         * Markdown string
+         */
+        description?: string;
+        text_color?: string;
     };
-    namespace StartScreen {
-        let loaders: {};
-        function open(): void;
-    }
+    text?: StartScreenTextSegment[];
+    layout?: 'vertical' | 'horizontal';
+    features?: StartScreenFeature[];
+    closable?: boolean;
+    click?: Function;
+    color?: string;
+    text_color?: string;
+    last?: boolean;
+    insert_after?: string;
+    insert_before?: string;
+}
+/**
+ * Adds a section to the start screen
+ */
+export declare function addStartScreenSection(id: string, data: StartScreenSection): {
+    delete(): void;
+};
+declare const global: {
+    StartScreen: {
+        loaders: {};
+        vue: null | (Vue & any);
+        open(): void;
+        updateThumbnails(model_paths?: string[]): void;
+        addSection: typeof import("./start_screen").addStartScreenSection;
+    };
+    addStartScreenSection: typeof import("./start_screen").addStartScreenSection;
+};
+declare global {
+    const StartScreen: typeof global.StartScreen;
+    const addStartScreenSection: typeof global.addStartScreenSection;
 }
-
 export {};