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

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/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
      */
@@ -117,12 +120,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

@@ -10,7 +10,7 @@ declare global {
          * 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/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,6 @@
 import MolangParser from "molangjs";
 import tinycolor from "tinycolor2";
-export declare const BarItems: Record<string, BarItem>;
+export declare const BarItems: any;
 type SubKeybind = {
     name: string;
     keybind?: Keybind;
@@ -580,7 +580,7 @@ declare const global: {
         structure: {};
         save(): void;
     };
-    BarItems: Record<string, import("./actions").BarItem>;
+    BarItems: any;
 };
 declare global {
     type BarItem = import('./actions').BarItem;
@@ -605,6 +605,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/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/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 {};

package/generated/io/project.d.ts

@@ -112,7 +112,7 @@ export declare class ModelProject {
     get nodes_3d(): Record<UUID, THREE.Object3D>;
     getDisplayName(with_extension?: boolean): string;
     getFileExtension(): string;
-    getProjectMemory(): RecentProjectData;
+    getProjectMemory(): import("../desktop").RecentProjectData;
     getMultiFileRuleset(): MultiFileRuleset | undefined;
     getUVWidth(texture?: Texture): number;
     getUVHeight(texture?: Texture): number;
@@ -158,5 +158,13 @@ declare global {
     const updateTabBarVisibility: typeof global.updateTabBarVisibility;
     const updateProjectResolution: typeof global.updateProjectResolution;
     const setStartScreen: typeof global.setStartScreen;
+    interface BarItemRegistry {
+        project_window: Action;
+        close_project: Action;
+        duplicate_project: Action;
+        convert_project: Action;
+        switch_tabs: Action;
+        tab_overview: Action;
+    }
 }
 export {};

package/generated/lib/CanvasFrame.d.ts

@@ -3,6 +3,7 @@ export declare class CanvasFrame {
     ctx: CanvasRenderingContext2D;
     constructor();
     constructor(width: number, height: number);
+    constructor(source: HTMLCanvasElement | HTMLImageElement);
     get width(): number;
     get height(): number;
     createCanvas(width: number, height: number): void;

package/generated/main.d.ts

@@ -40,7 +40,7 @@ import "./interface/about";
 import "./interface/action_control";
 import "./copy_paste";
 import "./undo";
-import './desktop.js';
+import './desktop.ts';
 import "./interface/setup_settings";
 import "./interface/settings_window";
 import "./edit_sessions";

package/generated/modeling/mesh/proportional_edit.d.ts

@@ -1,15 +1,17 @@
-declare global {
-    const ProportionalEdit: {
-        vertex_weights: {};
-        config: {
-            enabled: boolean;
-            range: number;
-            falloff: string;
-            selection: string;
-        };
-        calculateWeights(mesh: Mesh): void;
-        editVertices(mesh: Mesh, per_vertex: (vkey: string, blend: number) => void): void;
+export declare const ProportionalEdit: {
+    vertex_weights: {};
+    config: {
+        enabled: boolean;
+        range: number;
+        falloff: string;
+        selection: string;
     };
+    calculateWeights(mesh: Mesh): void;
+    editVertices(mesh: Mesh, per_vertex: (vkey: string, blend: number) => void): void;
+};
+declare global {
+    interface BarItemRegistry {
+        proportional_editing_range: NumSlider;
+        proportional_editing: Toggle;
+    }
 }
-
-export {};

package/generated/modeling/mirror_modeling.d.ts

@@ -58,5 +58,9 @@ declare const global: {
 };
 declare global {
     const MirrorModeling: typeof global.MirrorModeling;
+    interface BarItemRegistry {
+        mirror_modeling: Toggle;
+        apply_mirror_modeling: Action;
+    }
 }
 export {};

package/generated/modeling/weight_paint.d.ts

@@ -0,0 +1,11 @@
+declare global {
+    interface BarItemRegistry {
+        opacity_slider: NumSlider;
+        weight_brush: Tool;
+        slider_weight_brush_size: NumSlider;
+        slider_weight_brush_limit: NumSlider;
+        weight_brush_xray: Toggle;
+        weight_brush_blend_mode: BarSelect;
+    }
+}
+export {};

package/generated/texturing/layers.d.ts

@@ -0,0 +1,140 @@
+import { Property } from "../util/property";
+interface TextureLayerData {
+    name?: string;
+    in_limbo?: boolean;
+    offset?: ArrayVector2;
+    scale?: ArrayVector2;
+    width?: number;
+    height?: number;
+    opacity?: number;
+    visible?: boolean;
+    blend_mode?: LayerBlendMode;
+    image_data?: ImageData;
+    data_url?: string;
+}
+type LayerBlendMode = 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'darken' | 'lighten' | 'screen' | 'overlay' | 'difference' | 'alpha_mask';
+/**
+ * Texture layers always belong to a texture and represent the layers of the texture. Each layer has its own HTML canvas and canvas context
+ */
+export declare class TextureLayer {
+    name: string;
+    uuid: UUID;
+    texture: Texture;
+    canvas: HTMLCanvasElement;
+    ctx: CanvasRenderingContext2D;
+    in_limbo: boolean;
+    img: HTMLImageElement;
+    menu?: Menu;
+    /**
+     * Layer offset from the top left corner of the texture to the top left corner of the layer
+     */
+    offset: ArrayVector2;
+    /**
+     * Layer scale. This is only used by the layer transform tool and should be applied and reset to 1x1 before doing further changes
+     */
+    scale: ArrayVector2;
+    opacity: number;
+    visible: boolean;
+    blend_mode: LayerBlendMode;
+    static properties: Record<string, Property<any>>;
+    constructor(data: TextureLayerData, texture?: Texture, uuid?: UUID);
+    get width(): number;
+    get height(): number;
+    get scaled_width(): number;
+    get scaled_height(): number;
+    get size(): number[];
+    get selected(): boolean;
+    extend(data: TextureLayerData): void;
+    /**
+     * Selects the layer
+     */
+    select(): void;
+    clickSelect(event: any): void;
+    showContextMenu(event: MouseEvent): void;
+    /**
+     * Remove the layer
+     * @param undo Create an undo point and update the texture
+     */
+    remove(undo?: boolean): void;
+    getUndoCopy(image_data: boolean): any;
+    getSaveCopy(): any;
+    /**
+     * Set the layer into a limbo state, where clicking Place or clicking next to the layer will place it on the layer below
+     */
+    setLimbo(): void;
+    /**
+     * Resolves the limbo state by turning the limbo layer into a full layer, or merging it into the layer below
+     * @param keep_separate If true, the layer is kept as a separate layer
+     */
+    resolveLimbo(keep_separate: boolean): void;
+    /**
+     * Set the layer size. This resizes the canvas, which discards the layer content
+     */
+    setSize(width: number, height: number): this;
+    /**
+     * Toggle layer visibility. This creates an undo point
+     */
+    toggleVisibility(): this;
+    /**
+     * Scroll the layer panel list to
+     */
+    scrollTo(): this;
+    /**
+     * Add the layer to the associated texture above the previously selected layer, select this layer, and scroll the layer panel list to it
+     */
+    addForEditing(): this;
+    /**
+     * Merge this texture onto the texture below
+     * @param undo Create an undo entry
+     */
+    mergeDown(undo?: boolean): void;
+    /**
+     * Expand the layer to include the listed pixels
+     * @param points
+     */
+    expandTo(...points: ArrayVector2[]): void;
+    /**
+     * Flip the texture along an axis
+     * @param axis Flip axis, where 0 is X and 1 is Y
+     * @param undo Create an undo entry
+     */
+    flip(axis: 0 | 1, undo: boolean): void;
+    /**
+     * Rotate the layer around itself in 90 degree steps
+     * @param angle Angle in degrees
+     * @param undo Create an undo entry
+     */
+    rotate(angle: number, undo: boolean): void;
+    /**
+     * Centers the layer on the texture
+     */
+    center(): void;
+    /**
+     * Open the properties dialog
+     */
+    propertiesDialog(): void;
+    /**
+     * Get all layers of the active texture
+     */
+    static all: TextureLayer[];
+    /**
+     * Get the selected layer
+     */
+    static selected: TextureLayer | null;
+}
+declare global {
+    interface BarItemRegistry {
+        layer_opacity: NumSlider;
+        layer_blend_mode: BarSelect;
+        selection_tool: Tool;
+        create_empty_layer: Action;
+        import_layer: Action;
+        enable_texture_layers: Action;
+        disable_texture_layers: Action;
+        layer_to_texture_size: Action;
+        merge_layer_down: Action;
+        crop_layer_to_selection: Action;
+        opacity_slider: NumSlider;
+    }
+}
+export {};

package/generated/util/state_memory.d.ts

@@ -20,5 +20,5 @@ declare const global: {
     };
 };
 declare global {
-    const StateMemory: typeof global.StateMemory;
+    const StateMemory: (typeof global.StateMemory) & Record<string, any>;
 }

package/index.d.ts

@@ -1,2 +1,2 @@
-/// <reference types="./custom/blockbench"/>
-/// <reference types="./generated/main"/>
+/// <reference types="./custom/blockbench"/>
+/// <reference types="./generated/main"/>

package/package.json

@@ -1,39 +1,39 @@
-{
-	"name": "blockbench-types",
-	"version": "5.1.0",
-	"description": "Blockbench typescript types",
-	"main": "",
-	"types": "./index.d.ts",
-	"typeScriptVersion": "5.8",
-	"keywords": [
-		"blockbench"
-	],
-	"author": "JannisX11",
-	"bugs": {
-		"url": "https://github.com/JannisX11/blockbench/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/JannisX11/blockbench"
-	},
-	"homepage": "https://blockbench.net",
-	"dependencies": {
-		"@babel/types": "^7.20.7",
-		"@types/dompurify": "^3.0.5",
-		"@types/jquery": "^3.5.32",
-		"@types/prismjs": "^1.26.0",
-		"@types/three": "^0.129.2",
-		"@types/tinycolor2": "^1.4.6",
-		"dompurify": "^3.0.1",
-		"electron": "^40.8.0",
-		"prismjs": "^1.29.0",
-		"tinycolor2": "^1.6.0",
-		"typescript": "^5.8.3",
-		"vue": "2.7.14",
-		"wintersky": "^1.3.0"
-	},
-	"devDependencies": {
-		"@types/node": "^18.14.6",
-		"prettier": "^2.8.3"
-	}
-}
+{
+	"name": "blockbench-types",
+	"version": "5.2.0-beta.0-next.1",
+	"description": "Blockbench typescript types",
+	"main": "",
+	"types": "./index.d.ts",
+	"typeScriptVersion": "5.8",
+	"keywords": [
+		"blockbench"
+	],
+	"author": "JannisX11",
+	"bugs": {
+		"url": "https://github.com/JannisX11/blockbench/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/JannisX11/blockbench"
+	},
+	"homepage": "https://blockbench.net",
+	"dependencies": {
+		"@babel/types": "^7.20.7",
+		"@types/dompurify": "^3.0.5",
+		"@types/jquery": "^3.5.32",
+		"@types/prismjs": "^1.26.0",
+		"@types/three": "^0.129.2",
+		"@types/tinycolor2": "^1.4.6",
+		"dompurify": "^3.0.1",
+		"electron": "^40.8.0",
+		"prismjs": "^1.29.0",
+		"tinycolor2": "^1.6.0",
+		"typescript": "^5.8.3",
+		"vue": "2.7.14",
+		"wintersky": "^1.3.0"
+	},
+	"devDependencies": {
+		"@types/node": "^18.14.6",
+		"prettier": "^2.8.3"
+	}
+}

package/tsconfig.json

@@ -1,19 +1,19 @@
-{
-	"include": [
-		"custom/**/*",
-		"generated/**/*",
-	],
-  "compilerOptions": {
-    "target": "ES2022",
-    "useDefineForClassFields": true,
-    "module": "ES2022",
-    "moduleResolution": "Node",
-    "jsx": "preserve",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "esModuleInterop": true,
-    "lib": ["ES2023", "DOM", "DOM.Iterable"],
-    "skipLibCheck": true,
-    "noEmit": true
-  }
-}
+{
+	"include": [
+		"custom/**/*",
+		"generated/**/*",
+	],
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "module": "ES2022",
+    "moduleResolution": "Node",
+    "jsx": "preserve",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ES2023", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+    "noEmit": true
+  }
+}