blockbench-types 5.1.0-beta.3-next.2 → 5.1.0

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/global_types.d.ts

@@ -0,0 +1,47 @@
+import { ModelFormat as _ModelFormat } from "./io/format";
+declare global {
+    const ModelFormat: typeof _ModelFormat;
+    const Format: _ModelFormat;
+    const Formats: Record<string, _ModelFormat>;
+    namespace Blockbench {
+        const ModelFormat: typeof _ModelFormat;
+        const Format: _ModelFormat;
+    }
+}
+import { settings as _settings, Setting as _Setting, SettingsProfile as _SettingsProfile, Settings as _Settings } from './interface/settings';
+declare global {
+    const settings: typeof _settings;
+    const Setting: typeof _Setting;
+    const SettingsProfile: typeof _SettingsProfile;
+    const Settings: typeof _Settings;
+    namespace Blockbench {
+        const settings: typeof _settings;
+        const Setting: typeof _Setting;
+        const SettingsProfile: typeof _SettingsProfile;
+        const Settings: typeof _Settings;
+    }
+}
+import { Modes as _Modes, Mode as _Mode } from './modes';
+declare global {
+    const Modes: typeof _Modes;
+    const Mode: typeof _Mode;
+}
+import { Dialog as _Dialog, ConfigDialog as _ConfigDialog, DialogSidebar as _DialogSidebar, MessageBox as _MessageBox, ShapelessDialog as _ShapelessDialog, ToolConfig as _ToolConfig } from './interface/dialog';
+declare global {
+    const Dialog: typeof _Dialog;
+    const ConfigDialog: typeof _ConfigDialog;
+    const DialogSidebar: typeof _DialogSidebar;
+    const MessageBox: typeof _MessageBox;
+    const ShapelessDialog: typeof _ShapelessDialog;
+    const ToolConfig: typeof _ToolConfig;
+}
+import { Property as _Property } from './util/property';
+declare global {
+    const Property: typeof _Property;
+}
+import { Language as _Language, tl as _tl } from './languages';
+declare global {
+    const Language: typeof _Language;
+    const tl: typeof _tl;
+}
+export {};

package/generated/io/formats/bedrock.d.ts

@@ -0,0 +1,4 @@
+declare global {
+    function calculateVisibleBox(): any;
+}
+export {};

package/generated/io/formats/bedrock_old.d.ts

@@ -0,0 +1,4 @@
+declare global {
+    function parseGeometry(data: any, args: any): void;
+}
+export {};

package/generated/io/formats/collada.d.ts

@@ -0,0 +1,4 @@
+declare global {
+    function compileXML(object: any): string;
+}
+export {};

package/generated/io/formats/fbx.d.ts

@@ -0,0 +1,17 @@
+type TNumType = 'I' | 'D' | 'F' | 'L' | 'C' | 'Y';
+type TNumVal = {
+    type: TNumType;
+    value: number | BigInt;
+    isTNum: true;
+    toString: () => string;
+};
+type FBXNode = {
+    _key?: string;
+    _values: (string | number | TNumVal)[];
+    [key: string]: any;
+};
+declare global {
+    function compileBinaryFBXModel(top_level_object: any): Uint8Array<ArrayBufferLike>;
+    function compileASCIIFBXSection(object: FBXNode): string;
+}
+export {};

package/generated/io/formats/gltf.d.ts

@@ -0,0 +1,6 @@
+declare global {
+    function buildAnimationTracks(export_scale?: string | number | boolean, do_quaternions?: boolean): any[];
+    function buildSkinnedMeshFromGroup(root_group: any): import("three").SkinnedMesh<import("three").BufferGeometry, any>;
+    function buildSkinnedMesh(armature: any, scale: any): import("three").SkinnedMesh<any, any>;
+}
+export {};

package/generated/io/formats/java_block.d.ts

@@ -0,0 +1,4 @@
+declare let item_parents: string[];
+declare var codec: Codec;
+declare var format: import("../format").ModelFormat;
+export {};

package/generated/io/formats/modded_entity.d.ts

@@ -0,0 +1,139 @@
+declare global {
+    const Templates: {
+        '1.12': {
+            name: string;
+            remember: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+        };
+        '1.14': {
+            name: string;
+            remember: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+        };
+        '1.14_mojmaps': {
+            name: string;
+            remember: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+        };
+        '1.15': {
+            name: string;
+            remember: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+        };
+        '1.15_mojmaps': {
+            name: string;
+            remember: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+        };
+        '1.17': {
+            name: string;
+            remember: boolean;
+            use_layer_definition: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            model_part: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+            animation_template: string;
+        };
+        '1.17_yarn': {
+            name: string;
+            remember: boolean;
+            integer_size: boolean;
+            file: string;
+            field: string;
+            model_part: string;
+            bone: string;
+            renderer: string;
+            cube: string;
+            animation_template: string;
+        };
+        get(key: any, version?: any): any;
+        keepLine(line: any): any;
+        getVariableRegex(name: any): RegExp;
+    };
+    namespace AnimationTemplates {
+        namespace mojang {
+            let name: string;
+            let file: string;
+            let animation: string;
+            let looping: string;
+            let channel: string;
+            let keyframe_rotation: string;
+            let keyframe_position: string;
+            let keyframe_scale: string;
+            namespace channel_types {
+                let rotation: string;
+                let position: string;
+                let scale: string;
+            }
+            namespace interpolations {
+                let linear: string;
+                let catmullrom: string;
+            }
+        }
+        namespace fabric {
+            let name_1: string;
+            export { name_1 as name };
+            let file_1: string;
+            export { file_1 as file };
+            let animation_1: string;
+            export { animation_1 as animation };
+            let looping_1: string;
+            export { looping_1 as looping };
+            let channel_1: string;
+            export { channel_1 as channel };
+            let keyframe_rotation_1: string;
+            export { keyframe_rotation_1 as keyframe_rotation };
+            let keyframe_position_1: string;
+            export { keyframe_position_1 as keyframe_position };
+            let keyframe_scale_1: string;
+            export { keyframe_scale_1 as keyframe_scale };
+            export namespace channel_types_1 {
+                let rotation_1: string;
+                export { rotation_1 as rotation };
+                let position_1: string;
+                export { position_1 as position };
+                let scale_1: string;
+                export { scale_1 as scale };
+            }
+            export { channel_types_1 as channel_types };
+            export namespace interpolations_1 {
+                let linear_1: string;
+                export { linear_1 as linear };
+                let catmullrom_1: string;
+                export { catmullrom_1 as catmullrom };
+            }
+            export { interpolations_1 as interpolations };
+        }
+        function get(key: any, version?: any): any;
+    }
+}
+export {};

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

@@ -0,0 +1,12 @@
+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[];
+    }
+}
+export {};

package/generated/io/formats/optifine_jem.d.ts

@@ -0,0 +1,3 @@
+declare var codec: Codec;
+declare var format: import("../format").ModelFormat;
+export {};

package/generated/io/formats/optifine_jpm.d.ts

@@ -0,0 +1,3 @@
+declare var part_codec: Codec;
+declare var part_format: import("../format").ModelFormat;
+export {};

package/generated/io/formats/skin.d.ts

@@ -0,0 +1,22 @@
+type SkinPreset = {
+    display_name: string;
+    pose?: boolean;
+    model?: string;
+    model_java?: string;
+    model_bedrock?: string;
+    variants?: {
+        [key: string]: {
+            name: string;
+            model: string;
+        };
+    };
+};
+declare global {
+    const skin_presets: Record<string, SkinPreset>;
+    const codec: Codec;
+    const format: import("../format").ModelFormat;
+    function generateTemplate(width: number, height: number, cubes: any, name: string, eyes: any, layer_template: any): Texture;
+    const model_options: Record<string, string>;
+    const skin_dialog: import("../../interface/dialog").Dialog;
+}
+export {};

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-beta.3-next.2",
-	"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.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"
+	}
+}

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
+  }
+}

package/type_config.json

@@ -1,47 +1,47 @@
-{
-	"exclude": [
-		"interface/action_control",
-		"animations/animation_controllers",
-		"animations/animation",
-		"animations/keyframe",
-		"animations/molang",
-		"animations/timeline",
-		"interface/menu",
-		"interface/setup_settings",
-		"desktop",
-		"util/math_util",
-		"display_mode/display_references",
-		"display_mode/display_mode",
-		"interface/interface",
-		"outliner/cube",
-		"outliner/group",
-		"outliner/locator",
-		"outliner/mesh",
-		"outliner/null_object",
-		"outliner/outliner",
-		"outliner/texture_mesh",
-		"preview/preview_scenes",
-		"preview/preview",
-		"preview/canvas",
-		"io/codec",
-		"io/io",
-		"preview/screenshot",
-		"texturing/painter",
-		"texturing/texture_groups",
-		"texturing/textures",
-		"texturing/layers",
-		"undo",
-		"web",
-		"copy_paste",
-		"uv/uv",
-		"validator",
-		"native_apis_web",
-		"util/util",
-		"lib/fik",
-		"lib/gif",
-		"lib/fik",
-		"lib/lzutf8",
-		"lib/VuePrismEditor",
-		"lib/VuePrismEditor.min"
-	]
+{
+	"exclude": [
+		"interface/action_control",
+		"animations/animation_controllers",
+		"animations/animation",
+		"animations/keyframe",
+		"animations/molang",
+		"animations/timeline",
+		"interface/menu",
+		"interface/setup_settings",
+		"desktop",
+		"util/math_util",
+		"display_mode/display_references",
+		"display_mode/display_mode",
+		"interface/interface",
+		"outliner/cube",
+		"outliner/group",
+		"outliner/locator",
+		"outliner/mesh",
+		"outliner/null_object",
+		"outliner/outliner",
+		"outliner/texture_mesh",
+		"preview/preview_scenes",
+		"preview/preview",
+		"preview/canvas",
+		"io/codec",
+		"io/io",
+		"preview/screenshot",
+		"texturing/painter",
+		"texturing/texture_groups",
+		"texturing/textures",
+		"texturing/layers",
+		"undo",
+		"web",
+		"copy_paste",
+		"uv/uv",
+		"validator",
+		"native_apis_web",
+		"util/util",
+		"lib/fik",
+		"lib/gif",
+		"lib/fik",
+		"lib/lzutf8",
+		"lib/VuePrismEditor",
+		"lib/VuePrismEditor.min"
+	]
 }