blockbench-types 4.9.0 → 4.11.0

package/types/cube.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./blockbench.d.ts"/>
 interface CubeOptions {
 	name: string
 	autouv: 0 | 1 | 2
@@ -15,8 +16,12 @@ interface CubeOptions {
 	 */
 	uv_offset: ArrayVector2
 }
+
 declare class Cube extends OutlinerElement {
-	constructor (options: Partial<CubeOptions>, uuid?: string)
+	constructor(options: Partial<CubeOptions>, uuid?: string)
+	name: string
+	uuid: string
+	color: any
 	/**
 	 * Auto UV setting, saved as an integer, where 0 means disabled, 1 means enabled, and 2 means relative auto UV (cube position affects UV)
 	 */
@@ -44,19 +49,27 @@ declare class Cube extends OutlinerElement {
 	faces: {
 		[fkey: string]: CubeFace
 	}
+	rescale?: boolean
+	rotation_axis: 'x' | 'y' | 'z'
 	/**
 	 * UV position for box UV mode
 	 */
 	uv_offset: ArrayVector2
+	mesh: THREE.Mesh & {
+		outline: THREE.Mesh
+		geometry: THREE.BufferGeometry & {
+			faces: string[]
+		}
+	}
 
 	extend(options: Partial<CubeOptions>): this
 	/**
 	 * Calculates and returns the size of a cube across a certain axis. If the axis argument is omitted, it returns all sizes as an array vector.
 	 */
 	size(axis?: number, floored?: boolean): number | ArrayVector3
-	rotationAxis(): void
-	getUndoCopy(aspects?: object): void
-	getSaveCopy(project?: boolean): void
+	rotationAxis(): string
+	getUndoCopy(aspects?: any): void
+	getSaveCopy(project?: boolean): Cube
 	/**
 	 * Rotate the cube around axis in 90 degree steps
 	 * @param axis Axis index
@@ -76,7 +89,13 @@ declare class Cube extends OutlinerElement {
 	applyTexture(texture: Texture, faces: true | undefined | CubeFaceDirection[]): void
 	mapAutoUV(): void
 	moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
-	resize(value: number, axis: number, negative: boolean, allow_negative?: boolean, bidirectional?: boolean): void
+	resize(
+		value: number,
+		axis: number,
+		negative: boolean,
+		allow_negative?: boolean,
+		bidirectional?: boolean
+	): void
 
 	static all: Cube[]
 	static selected: Cube[]
@@ -84,6 +103,8 @@ declare class Cube extends OutlinerElement {
 	static hasAny: () => boolean
 	/**Check if any elements of the type are currently selected */
 	static hasSelected: () => boolean
+	preview_controller: NodePreviewController
+	static preview_controller: NodePreviewController
 }
 
 interface FaceOptions {
@@ -91,18 +112,18 @@ interface FaceOptions {
 }
 declare class Face {
 	constructor()
-	texture: string | false | null
+	texture: UUID | false | undefined
 
-	getTexture(): Texture | null
+	getTexture(): Texture | undefined
 	/**
 	 * Returns a 2D rectangle around the UV face
 	 */
-	getBoundingRect(): object
+	getBoundingRect(): any
 	reset(): void
 	/**
 	 * Returns a save copy of the face, ready for serialization. Set project to true to save for a bbmodel project file
 	 */
-	getSaveCopy(project?: boolean): object
+	getSaveCopy(project?: boolean): any
 	/**
 	 * Get a copy for undo tracking
 	 */
@@ -129,7 +150,7 @@ declare class CubeFace extends Face {
 	cullface: CubeFaceDirection | ''
 	material_name: string
 	enabled: boolean
-	
-	extend(data: CubeFaceOptions)
+
+	extend(data: CubeFaceOptions): void
 	getVertexIndices(): [number, number, number, number]
 }

package/types/desktop.d.ts

@@ -0,0 +1,14 @@
+declare function initializeDesktopApp(): void
+declare function loadOpenWithBlockbenchFile(): void
+declare function updateRecentProjects(): void
+declare function addRecentProject(data: any): void
+declare function updateRecentProjectData(): void
+declare function updateRecentProjectThumbnail(): Promise<void>
+declare function loadDataFromModelMemory(): void
+declare function updateWindowState(e: any, type: any): void
+declare function changeImageEditor(texture: any, from_settings: any): void
+declare function selectImageEditorFile(texture: any): void
+declare function openDefaultTexturePath(): void
+declare function findExistingFile(paths: string[]): any
+declare function createBackup(init: any): void
+declare function closeBlockbenchWindow(): any

package/types/dialog.d.ts

@@ -1,8 +1,33 @@
+
+
 interface DialogFormElement {
-	type: 'text' | 'number' | 'range' | 'checkbox' | 'select' | 'inline_select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info' | 'buttons'
 	label?: string
+	/**
+	 * Detailed description of the field, available behind the questionmark icon or on mouse hover
+	 */
 	description?: string
+	type:
+		| 'text'
+		| 'number'
+		| 'range'
+		| 'checkbox'
+		| 'select'
+		| 'radio'
+		| 'textarea'
+		| 'vector'
+		| 'color'
+		| 'file'
+		| 'folder'
+		| 'save'
+		| 'info'
+		| 'buttons'
+	/**
+	 * If true, the label will be displayed without colon at the end
+	 */
 	nocolon?: boolean
+	/**
+	 * Stretch the input field across the whole width of the form
+	 */
 	full_width?: boolean
 	/** Set the input to read-only */
 	readonly?: boolean
@@ -26,11 +51,30 @@ interface DialogFormElement {
 	 */
 	editable_range_label?: boolean
 	colorpicker?: any
+	/**
+	 * On numeric inputs, the minimum possible value
+	 */
 	min?: number
+	/**
+	 * On numeric inputs, the maximum possible value
+	 */
 	max?: number
+	/**
+	 * The step in which the value can be increased / decreased
+	 */
 	step?: number
+	/**
+	 * If enabled, the value is forced to multiples of the "step" value. This can be used to create integer-only inputs etc.
+	 */
+	force_step?: boolean
+	/**
+	 * The height of the input on textareas, in pixels
+	 */
 	height?: number
-	options?: object
+	/**
+	 * Available options on select or inline_select inputs
+	 */
+	options?: {[key: string]: string | {name: string}}
 	buttons?: string[]
 	/**
 	 * Allow users to toggle the entire option on or off
@@ -40,21 +84,30 @@ interface DialogFormElement {
 	 * Set whether the setting is toggled on or off by default. Requires 'toggle_enabled' field to be set to true
 	 */
 	toggle_default?: boolean
+	/**
+	 * Runs when any of the buttons is pressed
+	 * @param button_index Index of the clicked button in the buttons list
+	 */
 	click?: (button_index: number) => void
 }
 
-type FormResultValue = string|number|boolean|[]
+type FormResultValue = string | number | boolean | []
 
 interface ActionInterface {
 	name: string
 	description?: string
-	icon: string,
-	click: (event: Event) => void
+	icon: string
+	click(event: Event): void
 	condition: ConditionResolvable
 }
 interface DialogOptions {
 	title: string
-	id: string
+	id?: string
+	width?: number
+	/**
+	 * Unless set to false, clicking on the darkened area outside of the dialog will cancel the dialog.
+	 */
+	cancel_on_click_outside?: boolean
 	/**
 	 * Default button to press to confirm the dialog. Defaults to the first button.
 	 */
@@ -63,10 +116,14 @@ interface DialogOptions {
 	 * Default button to press to cancel the dialog. Defaults to the last button.
 	 */
 	cancelIndex?: number
+	/**
+	 * Function to execute when the dialog is opened
+	 */
+	onOpen?(): void
 	/**
 	 *  Function to execute when the user confirms the dialog
 	 */
-	onConfirm?: (formResult: object) => void
+	onConfirm?(formResult: any): void
 	/**
 	 * Function to execute when the user cancels the dialog
 	 */
@@ -74,15 +131,24 @@ interface DialogOptions {
 	/**
 	 * Triggered when the user presses a specific button
 	 */
-	onButton?: (button_index: number, event?: Event) => void
+	onButton?(button_index: number, event?: Event): void
 	/**
 	 * Function to run when anything in the form is changed
 	 */
-	onFormChange?: (form_result: {[key: string]: FormResultValue}) => void
+	onFormChange?(form_result: { [key: string]: FormResultValue }): void
 	/**
-	 * Array of HTML object strings for each line of content in the dialog.
+	 * Array of HTML any strings for each line of content in the dialog.
 	 */
-	lines?: (HTMLElement | {label?: string, widget?: Widget|(() => Widget), nocolon?: boolean} | string)[]
+	lines?: (
+		| HTMLElement
+		| Comment
+		| {
+				label?: string
+				widget?: Widget | (() => Widget)
+				nocolon?: boolean
+		  }
+		| string
+	)[]
 	/**
 	 * Creates a form in the dialog
 	 */
@@ -106,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
 	 */
@@ -115,10 +190,41 @@ interface DialogOptions {
 	 */
 	buttons?: string[]
 	/**
-	 * Unless set to false, clicking on the darkened area outside of the dialog will cancel the dialog.
+	 * A list of keyboard shortcuts that only work inside the dialog
 	 */
-	cancel_on_click_outside?: boolean
-	width?: number
+	keyboard_actions?: {
+		[id: string]: {
+			keybind: Keybind
+			run: (event: KeyboardEvent) => void
+			condition?: ConditionResolvable
+		}
+	}
+	/**
+	 * Select on which axes the dialog can be resized. None by default
+	 */
+	resizable?: 'x' | 'y' | 'xy' | boolean
+}
+
+interface DialogSidebarOptions {
+	pages?: {
+		[key: string]: string | { label: string; icon: IconString; color?: string }
+	}
+	page?: string
+	actions?: (Action | ActionInterface | string)[]
+	onPageSwitch?(page: string): void
+}
+declare class DialogSidebar {
+	constructor(options: DialogSidebarOptions)
+
+	pages: {
+		[key: string]: string
+	}
+	page: string
+	actions: (Action | string)[]
+	onPageSwitch(page: string): void
+	build(): void
+	toggle(state?: boolean): void
+	setPage(page: string): void
 }
 
 declare class Dialog {
@@ -129,7 +235,24 @@ 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
 
 	show(): this
 	hide(): this
@@ -151,12 +274,40 @@ declare class Dialog {
 	getFormResult(): {
 		[key: string]: FormResultValue
 	}
+	/**
+	 * Function to execute when the dialog is opened
+	 */
+	onOpen?(): void
+	/**
+	 *  Function to execute when the user confirms the dialog
+	 */
+	onConfirm?(formResult: any): void
+	/**
+	 * Function to execute when the user cancels the dialog
+	 */
+	onCancel?(): void
+	/**
+	 * Triggered when the user presses a specific button
+	 */
+	onButton?(button_index: number, event?: Event): void
+	/**
+	 * Function to run when anything in the form is changed
+	 */
+	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
 	/**
-	 * Delete the dialog object, causing it to be re-build from scratch on next open
+	 * 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
 	 */
 	delete(): void
 
@@ -180,7 +331,7 @@ interface ShapelessDialogOptions {
 	/**
 	 *  Function to execute when the user confirms the dialog
 	 */
-	onConfirm?: (formResult: object) => void
+	onConfirm?(formResult: any): void
 	/**
 	 * Function to execute when the user cancels the dialog
 	 */
@@ -188,7 +339,7 @@ interface ShapelessDialogOptions {
 	/**
 	 * Triggered when the user presses a specific button
 	 */
-	onClose?: (button_index: number, event?: Event) => void
+	onClose?(button_index: number, event?: Event): void
 	/**
 	 * Vue component
 	 */
@@ -199,12 +350,11 @@ interface ShapelessDialogOptions {
 	cancel_on_click_outside?: boolean
 }
 declare class ShapelessDialog extends Dialog {
-	constructor (id: string, options: ShapelessDialogOptions)
+	constructor(id: string, options: ShapelessDialogOptions)
 
 	id: string
 	component: Vue.Component
 
-
 	show(): this
 	hide(): this
 	/**
@@ -228,31 +378,18 @@ declare class ShapelessDialog extends Dialog {
 	/**
 	 * Set the values of the dialog form inputs
 	 */
-	setFormValues(values: {[key: string]: FormResultValue}): void
+	setFormValues(values: { [key: string]: FormResultValue }): void
 	/**
-	 * Delete the dialog object, causing it to be re-build from scratch on next open
+	 * Delete the dialog any, causing it to be re-build from scratch on next open
 	 */
 	delete(): void
 }
 
 interface DialogSidebarOptions {
 	pages?: {
-		[key: string]: string | {label: string, icon: IconString, color?: string}
+		[key: string]: string | { label: string; icon: IconString; color?: string }
 	}
 	page?: string
-	actions?: (Action|ActionInterface|string)[],
-	onPageSwitch?: (page: string) => void
-}
-declare class DialogSidebar {
-	constructor(options: DialogSidebarOptions)
-
-	pages: {
-		[key: string]: string
-	}
-	page: string
-	actions: (Action|string)[]
-	onPageSwitch(page: string): void
-	build(): void
-	toggle(state?: boolean): void
-	setPage(page: string): void
+	actions?: (Action | ActionInterface | string)[]
+	onPageSwitch?(page: string): void
 }

package/types/display_mode.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./blockbench.d.ts"/>
 declare const DisplayMode: {
 	slots: string[]
 }
@@ -6,6 +7,8 @@ interface DisplaySlotOptions {
 	rotation?: ArrayVector3
 	translation?: ArrayVector3
 	scale?: ArrayVector3
+	rotation_pivot?: ArrayVector3
+	scale_pivot?: ArrayVector3
 	mirror?: [boolean, boolean, boolean]
 }
 
@@ -17,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
@@ -27,18 +32,24 @@ declare class DisplaySlot {
 		rotation: ArrayVector3
 		translation: ArrayVector3
 		scale: ArrayVector3
+		rotation_pivot: ArrayVector3
+		scale_pivot: ArrayVector3
 		mirror: [boolean, boolean, boolean]
 	}
 	/**
 	 * Generate the values of the slot for export
 	 */
-	export(): {
-		rotation: ArrayVector3
-		translation: ArrayVector3
-		scale: ArrayVector3
-	} | undefined
+	export():
+		| {
+				rotation: ArrayVector3
+				translation: ArrayVector3
+				scale: ArrayVector3
+				rotation_pivot?: ArrayVector3
+				scale_pivot?: ArrayVector3
+		  }
+		| undefined
 	/**
 	 * Visually update the UI with the data from this slot if selected
 	 */
 	update(): this
-}
+}

package/types/file_system.d.ts

@@ -0,0 +1,159 @@
+/// <reference path="./blockbench.d.ts"/>
+
+declare namespace Blockbench {
+	/**
+	 * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
+	 */
+	type ResourceID =
+		| string
+		| 'texture'
+		| 'minecraft_skin'
+		| 'dev_plugin'
+		| 'animation'
+		| 'animation_particle'
+		| 'animation_audio'
+		| 'theme'
+		| 'model'
+		| 'gltf'
+		| 'obj'
+		| 'preview_background'
+		| 'screenshot'
+		| 'palette'
+
+	interface FileResult {
+		name: string
+		path: string
+		content: string | ArrayBuffer
+	}
+	type ReadType = 'buffer' | 'binary' | 'text' | 'image'
+	interface ReadOptions {
+		readtype?: ReadType | ((file: string) => ReadType)
+		errorbox?: boolean
+	}
+	/**
+	 * Reads the content from the specified files. Desktop app only.
+	 */
+	export function read(
+		files: string[],
+		options?: ReadOptions,
+		callback?: (files: FileResult[]) => void
+	): void
+	/**
+	 * Reads the content from the specified files. Desktop app only.
+	 */
+	export function readFile(
+		files: string[],
+		options?: ReadOptions,
+		callback?: (files: FileResult[]) => void
+	): void
+
+	type WriteType = 'buffer' | 'text' | 'zip' | 'image'
+	interface WriteOptions {
+		content?: string | ArrayBuffer
+		savetype?: WriteType | ((file: string) => WriteType)
+		custom_writer?: (content: string | ArrayBuffer, file_path: string) => void
+	}
+	/**
+	 * Writes a file to the file system. Desktop app only.
+	 */
+	export function writeFile(
+		file_path: string,
+		options: WriteOptions,
+		callback?: (file_path: string) => void
+	): void
+
+	interface PickDirOptions {
+		/**Location where the file dialog starts off
+		 */
+		startpath?: string
+		/** The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
+		 */
+		resource_id?: ResourceID
+		/** Window title for the file picker
+		 */
+		title?: string
+	}
+	/**
+	 * Pick a directory. Desktop app only.
+	 */
+	export function pickDirectory(options: PickDirOptions): string | undefined
+
+	interface ImportOptions extends ReadOptions {
+		/** Name of the file type
+		 */
+		type: string
+		/** File Extensions
+		 */
+		extensions: string[]
+		/** Allow selection of multiple elements
+		 */
+		multiple?: boolean
+		/** File picker start path
+		 */
+		startpath?: string
+		/** The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
+		 */
+		resource_id?: ResourceID
+		/** Title of the file picker window
+		 */
+		title?: string
+		/**
+		 */
+	}
+	// @ts-ignore
+	function _import(options: ImportOptions, callback?: (files: FileResult[]) => void): any
+	export { _import as import }
+
+	interface ExportOptions extends WriteOptions {
+		/**
+		 * Name of the file type
+		 */
+		type: string
+		/**
+		 * File extensions
+		 */
+		extensions: string[]
+		/**
+		 * Suggested file name
+		 */
+		name?: string
+		/**
+		 * Location where the file dialog starts
+		 */
+		startpath?: string
+		/**
+		 * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
+		 */
+		resource_id?: string
+	}
+	function _export(options: ExportOptions, callback?: (file_path: string) => void): any
+	export { _export as export }
+
+	/**
+	 * Adds a drag handler that handles dragging and dropping files into Blockbench
+	 */
+	interface DragHandlerOptions extends ReadOptions {
+		/**
+		 * Allowed file extensions
+		 */
+		extensions: string[] | (() => string[])
+		/**
+		 * Whether or not to enable the drag handler
+		 */
+		condition?: ConditionResolvable
+		/**
+		 * Drop target element
+		 */
+		element?: string | HTMLElement | (() => string | HTMLElement)
+		/**
+		 * If true, the drop will work on all child elements of the specified element
+		 */
+		propagate?: boolean
+	}
+	export function addDragHandler(
+		id: string,
+		options: DragHandlerOptions,
+		callback?: () => void
+	): Deletable
+	export function removeDragHandler(id: string): void
+}