blockbench-types 4.10.0 → 4.11.0

package/README.md

@@ -1,3 +1,3 @@
-# blockbench-types
+# Blockbench Types [![npm version](https://img.shields.io/npm/v/blockbench-types)](https://www.npmjs.com/package/blockbench-types)
 
-Blockbench typescript types
+Blockbench typescript types!

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "blockbench-types",
-	"version": "4.10.0",
+	"version": "4.11.0",
 	"description": "Blockbench typescript types",
 	"main": "",
 	"types": "types/index.d.ts",
@@ -30,7 +30,7 @@
 		"@types/three": "^0.129.2",
 		"@types/tinycolor2": "^1.4.6",
 		"dompurify": "^3.0.1",
-		"electron": "^30.0.2",
+		"electron": "^31.4.0",
 		"prismjs": "^1.29.0",
 		"tinycolor2": "^1.6.0",
 		"typescript": "^4.9.5",

package/types/dialog.d.ts

@@ -172,6 +172,15 @@ interface DialogOptions {
 	 * Menu in the handle bar
 	 */
 	title_menu?: Menu
+	/**
+	 * Display a progress bar in the dialog
+	 */
+	progress_bar?: {
+		/**
+		 * A progress value between 0 and 1
+		 */
+		progress?: number
+	}
 	/**
 	 * If true, the dialog will only have one button to close it
 	 */
@@ -226,6 +235,21 @@ declare class Dialog {
 	component: Vue.Component
 	sidebar: DialogSidebar | null
 	content_vue: Vue | null
+	progress_bar?: {
+		/**
+		 * The current progress
+		 */
+		progress?: number
+		/**
+		 * Set the progress displayed in the progress bar
+		 * @param value A progress value between 0 and 1
+		 */
+		setProgress(value: number): void
+		/**
+		 * The progress bar HTML node
+		 */
+		node?: HTMLDivElement
+	}
 
 	confirmIndex: number
 	cancelIndex: number
@@ -272,8 +296,16 @@ declare class Dialog {
 	onFormChange?(form_result: { [key: string]: FormResultValue }): void
 	/**
 	 * Set the values of the dialog form inputs
+	 * @param values The values to set, by form input key
+	 * @param update Whether to update the dialog (call onFormChange) after setting the values. Default is true. Set to false when called from onFormChange
 	 */
-	setFormValues(values: { [key: string]: FormResultValue }): void
+	setFormValues(values: { [key: string]: FormResultValue }, update: boolean): void
+	/**
+	 * Set whether the dialog form inputs are toggled on or off. See "toggle_enabled"
+	 * @param values 
+	 * @param update Whether to update the dialog (call onFormChange) after setting the values. Default is true. Set to false when called from onFormChange
+	 */
+	setFormToggles(values: { [key: string]: boolean }, update: boolean): void
 	/**
 	 * Delete the dialog any, causing it to be re-build from scratch on next open
 	 */

package/types/display_mode.d.ts

@@ -7,6 +7,8 @@ interface DisplaySlotOptions {
 	rotation?: ArrayVector3
 	translation?: ArrayVector3
 	scale?: ArrayVector3
+	rotation_pivot?: ArrayVector3
+	scale_pivot?: ArrayVector3
 	mirror?: [boolean, boolean, boolean]
 }
 
@@ -18,6 +20,8 @@ declare class DisplaySlot {
 	rotation: ArrayVector3
 	translation: ArrayVector3
 	scale: ArrayVector3
+	rotation_pivot: ArrayVector3
+	scale_pivot: ArrayVector3
 	mirror: [boolean, boolean, boolean]
 	/**
 	 * Reset slot to default values
@@ -28,6 +32,8 @@ declare class DisplaySlot {
 		rotation: ArrayVector3
 		translation: ArrayVector3
 		scale: ArrayVector3
+		rotation_pivot: ArrayVector3
+		scale_pivot: ArrayVector3
 		mirror: [boolean, boolean, boolean]
 	}
 	/**
@@ -38,6 +44,8 @@ declare class DisplaySlot {
 				rotation: ArrayVector3
 				translation: ArrayVector3
 				scale: ArrayVector3
+				rotation_pivot?: ArrayVector3
+				scale_pivot?: ArrayVector3
 		  }
 		| undefined
 	/**

package/types/format.d.ts

@@ -96,7 +96,10 @@ interface FormatOptions {
 	animation_mode?: boolean
 	pose_mode?: boolean
 	animation_controllers?: boolean
-	render_sides?: 'front'
+	box_uv_float_size: boolean
+	java_cube_shading_properties: boolean
+	cullfaces: boolean
+	render_sides?: 'front' | 'double' | 'back' | (() => ('front' | 'double' | 'back'))
 
 	cube_size_limiter?: CubeSizeLimiter
 
@@ -157,6 +160,12 @@ declare class ModelFormat extends Deletable {
 	display_mode: boolean
 	animation_mode: boolean
 	pose_mode: boolean
+	box_uv_float_size: boolean
+	java_cube_shading_properties: boolean
+	cullfaces: boolean
+	animation_controllers: boolean
+	render_sides: 'front' | 'double' | 'back' | (() => ('front' | 'double' | 'back'))
+	
 
 	codec?: Codec
 

package/types/menu.d.ts

@@ -58,7 +58,7 @@ declare class Menu extends Deletable {
 	 *
 	 * @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): void
+	removeAction(path: string | Action): void
 	structure: MenuItem[]
 }
 

package/types/plugin.d.ts

@@ -50,6 +50,18 @@ interface PluginOptions {
 	 * In combination with a "Deprecated" tag, this can be used to provide context on why a plugin is deprecated
 	 */
 	deprecation_note?: string
+	/*
+	 * Link to the plugin's website
+	 */
+	website?: string
+	/*
+	 * Link to the repository that contains the source for the plugin
+	 */
+	repository?: string
+	/*
+	 * Link to where users can report issues with the plugin
+	 */
+	bug_tracker?: string
 	/**
 	 * Runs when the plugin loads
 	 */
@@ -105,6 +117,18 @@ declare class BBPlugin {
 	 * In combination with a "Deprecated" tag, this can be used to provide context on why a plugin is deprecated
 	 */
 	deprecation_note?: string
+	website?: string
+	/*
+	 * Link to the plugin's website
+	 */
+	repository?: string
+	/*
+	 * Link to the repository that contains the source for the plugin
+	 */
+	bug_tracker?: string
+	/*
+	 * Link to where users can report issues with the plugin
+	 */
 	onload(): void
 	onunload(): void
 	oninstall(): void

package/types/preview_scene.d.ts

@@ -81,12 +81,22 @@ interface PreviewSceneOptions {
 declare class PreviewScene extends Deletable {
 	constructor(id: string, options: PreviewSceneOptions)
 
-	static scenes: {
-		(id: string): PreviewScene
-	}
+	/**
+	 * All preview scenes, listed by ID
+	 */
+	static scenes: Record<string, PreviewScene>
+	/**
+	 * The currently active scene
+	 */
 	static active: PreviewScene | null
-	select_options: {
-		(id: string): string
+	/**
+	 * The URL to the source repository that scenes are pulled from
+	 */
+	static source_repository: string
+	static menu_categories: {
+		[category_id: string]: {
+			[id: string]: string
+		}
 	}
 
 	id: string

package/types/undo.d.ts

@@ -120,8 +120,8 @@ declare class UndoSystem {
 ```javascript
 Undo.initEdit({elements: []});
 
-var new_cube = new Cube({name: 'kevin'}).init();
-var other_cube = new Cube({name: 'lars'}).init();
+let new_cube = new Cube({name: 'kevin'}).init();
+let other_cube = new Cube({name: 'lars'}).init();
 
 Undo.finishEdit('add new cubes', {elements: [new_cube, other_cube]});
 ```

package/types/util.d.ts

@@ -114,7 +114,7 @@ declare function getAverageRGB(
 declare function stringifyLargeInt(int: any): any
 declare function intersectLines(p1: any, p2: any, p3: any, p4: any): boolean
 declare function pointInRectangle(point: any, rect_start: any, rect_end: any): boolean
-declare function lineIntersectsReactangle(p1: any, p2: any, rect_start: any, rect_end: any): boolean
+declare function lineIntersectsRectangle(p1: any, p2: any, rect_start: any, rect_end: any): boolean
 declare function cameraTargetToRotation(position: any, target: any): any[]
 declare function cameraRotationToTarget(position: any, rotation: any): any