blockbench-types 4.8.0 → 4.10.0

package/types/format.d.ts

@@ -1,31 +1,44 @@
+/// <reference path="./blockbench.d.ts"/>
+
 interface FormatPage {
 	component?: Vue.Component
-	content?: ({
-		type: 'image' | 'h2' | 'h3' | 'h4' | 'text' | 'label' | 'image' | ''
-		text?: string
-		source?: string
-		width?: number
-		height?: number
-	} | string)[]
+	content?: (
+		| {
+				type: 'image' | 'h2' | 'h3' | 'h4' | 'text' | 'label' | 'image' | ''
+				text?: string
+				source?: string
+				width?: number
+				height?: number
+		  }
+		| string
+	)[]
 	button_text?: string
 }
 interface CubeSizeLimiter {
 	/**
 	 * Test whether the cube with the optionally provided values violates the size restrictions
 	 */
-	test: (cube: Cube, values?: {from: ArrayVector3, to: ArrayVector3, inflate: number}) => boolean
+	test: (
+		cube: Cube,
+		values?: { from: ArrayVector3; to: ArrayVector3; inflate: number }
+	) => boolean
 	/**
 	 * Move the cube back into the restructions
 	 */
-	move: (cube: Cube, values?: {from: ArrayVector3, to: ArrayVector3, inflate: number}) => void
+	move(cube: Cube, values?: { from: ArrayVector3; to: ArrayVector3; inflate: number }): void
 	/**
 	 * Clamp the cube to fit into the restrictions. When an axis and direction is provided, clamp the element on that side to prevent wandering.
 	 */
-	clamp: (cube: Cube, values?: {from: ArrayVector3, to: ArrayVector3, inflate: number}, axis?: number, direction?: boolean | null) => void
+	clamp: (
+		cube: Cube,
+		values?: { from: ArrayVector3; to: ArrayVector3; inflate: number },
+		axis?: number,
+		direction?: boolean | null
+	) => void
 	/**
 	 * Set to true to tell Blockbench to check and adjust the cube limit after rotating a cube
 	 */
-	rotation_affected?: boolean,
+	rotation_affected?: boolean
 	/**
 	 * Optionally set the coordinate limits of cubes in local space
 	 */
@@ -45,11 +58,17 @@ interface FormatOptions {
 	format_page?: FormatPage
 	onFormatPage?(): void
 	onStart?(): void
+	onSetup?(project: ModelProject, newModel?: boolean): void
+	convertTo?(): void
 
 	box_uv?: boolean
 	optional_box_uv?: boolean
 	single_texture?: boolean
+	single_texture_default?: boolean
+	per_group_texture?: boolean
+	per_texture_uv_size?: boolean
 	model_identifier?: boolean
+	legacy_editable_file_name?: boolean
 	parent_model_id?: boolean
 	vertex_color_ambient_occlusion?: boolean
 	animated_textures?: boolean
@@ -62,9 +81,11 @@ interface FormatOptions {
 	texture_meshes?: boolean
 	locators?: boolean
 	rotation_limit?: boolean
+	rotation_snap?: boolean
 	uv_rotation?: boolean
 	java_face_properties?: boolean
 	select_texture_for_particles?: boolean
+	texture_mcmeta?: boolean
 	bone_binding_expression?: boolean
 	animation_files?: boolean
 	texture_folder?: boolean
@@ -74,6 +95,8 @@ interface FormatOptions {
 	display_mode?: boolean
 	animation_mode?: boolean
 	pose_mode?: boolean
+	animation_controllers?: boolean
+	render_sides?: 'front'
 
 	cube_size_limiter?: CubeSizeLimiter
 
@@ -98,11 +121,16 @@ declare class ModelFormat extends Deletable {
 	format_page?: FormatPage
 	onFormatPage?(): void
 	onStart?(): void
+	onSetup?(): void
 
 	box_uv: boolean
 	optional_box_uv: boolean
 	single_texture: boolean
+	single_texture_default?: boolean
+	per_group_texture?: boolean
+	per_texture_uv_size?: boolean
 	model_identifier: boolean
+	legacy_editable_file_name?: boolean
 	parent_model_id: boolean
 	vertex_color_ambient_occlusion: boolean
 	animated_textures: boolean
@@ -115,9 +143,11 @@ declare class ModelFormat extends Deletable {
 	texture_meshes: boolean
 	locators: boolean
 	rotation_limit: boolean
+	rotation_snap: boolean
 	uv_rotation: boolean
 	java_face_properties: boolean
 	select_texture_for_particles: boolean
+	texture_mcmeta: boolean
 	bone_binding_expression: boolean
 	animation_files: boolean
 	texture_folder: boolean
@@ -128,6 +158,8 @@ declare class ModelFormat extends Deletable {
 	animation_mode: boolean
 	pose_mode: boolean
 
+	codec?: Codec
+
 	cube_size_limiter?: CubeSizeLimiter
 	/**
 	 * Selects the format
@@ -147,7 +179,9 @@ declare class ModelFormat extends Deletable {
  * The current format
  */
 declare const Format: ModelFormat
-
+declare const Formats: {
+	[id: string]: ModelFormat
+}
 
 interface ModelLoaderOptions {
 	id?: string

package/types/global.d.ts

@@ -1,9 +1,50 @@
+/// <reference path="./blockbench.d.ts"/>
+
 declare global {
+	const THREE: typeof import('three')
+
+	const Prism: typeof import('prismjs')
+	const scene: THREE.Scene
+	const Transformer: any
+	const DOMPurify: typeof import('dompurify')
+	const electron: typeof import('electron')
+	const { clipboard, shell, nativeImage, ipcRenderer, dialog }: typeof electron
+
+	const main_preview: Preview
+	let open_interface: Dialog | undefined
+
+	function confirm(message: string, title: string): boolean
+
+	const PathModule: typeof import('path')
+	const fs: typeof import('fs')
+
+	const tinycolor: typeof import('tinycolor2')
+
+	let selected: OutlinerElement[]
+	const Toolbars: Record<string, Toolbar>
+
+	function rotateOnAxis(modify: OutlinerNode, axis: number, slider?: boolean): void
+	function afterRotateOnAxis(): void
+
+	// const Transformer: THREE.TransformControls
+	interface HTMLImageElement {
+		src: string
+		tex: THREE.Texture & {
+			magFilter: THREE.TextureFilter
+			minFilter: THREE.TextureFilter
+		}
+	}
 	interface Date {
 		/**
 		 * Returns a timestamp in the format 16:30
 		 */
 		getTimestamp(): string
+		getDateArray(): number[]
+		getDateString(): string
+		dayOfYear(): number
+	}
+	interface Number {
+		toDigitString(digits: number): string
 	}
 	interface Event {
 		readonly ctrlOrCmd: boolean
@@ -70,13 +111,18 @@ declare global {
 		 */
 		safePush(...items: any): boolean
 		equals(array: Array<any>): boolean
+		replace(items: T[]): boolean
+		allAre(callback: (item: T, index: number) => boolean): boolean
+		findInArray(key: string, value: any): number
+		positiveItems(): number
 		/**
 		 * Empties the array
 		 */
 		empty(): this
-		last(): any
-		allEqual(item: any): boolean
+		last(): T
+		allEqual(item: T): boolean
 		random(): T
+		toggle(item: T, state?: boolean): boolean
 		/**
 		 * Same as forEach, but in reverse order
 		 */
@@ -100,4 +146,4 @@ declare global {
 	}
 }
 
-export {}
+export {}

package/types/group.d.ts

@@ -20,9 +20,10 @@ interface GroupOptions {
 }
 
 declare class Group extends OutlinerNode {
-	constructor (options: Partial<GroupOptions>)
+	constructor(options: Partial<GroupOptions>)
 	static selected: Group
 	static all: Group[]
+	static animator: BoneAnimator
 	/**Check if any groups are in the project */
 	static hasAny: () => boolean
 
@@ -38,11 +39,21 @@ declare class Group extends OutlinerNode {
 	isOpen: boolean
 	ik_enabled: boolean
 	ik_chain_length: number
+	texture?: string
+	skin_original_origin?: ArrayVector3
+	bedrock_binding?: string
+	cem_animations?: any[]
+	cem_attach?: boolean
+	cem_scale?: number
+	mesh: THREE.Mesh
+
+	static preview_controller: NodePreviewController
 
 	extend(options: Partial<GroupOptions>): this
 	selectChildren(event: Event): this
 	selectLow(highlight: boolean): this
-	unselect(): this
+	select(event?: any, isOutlinerClick?: boolean): this | void
+	unselect(): this | void
 	matchesSelection(): boolean
 	/**
 	 * Opens the group and all of its ancestor groups.
@@ -69,8 +80,8 @@ declare class Group extends OutlinerNode {
 	 * Duplicate the group
 	 */
 	duplicate(): Group
-	getSaveCopy(): object
+	getSaveCopy(): any
 	getChildlessCopy(): Group
-	compile(undo: boolean): object
-	forEachChild(callback: (object: OutlinerNode) => void, type?: any, for_self?: boolean)
+	compile(undo: boolean): any
+	forEachChild(callback: (any: OutlinerNode) => void, type?: any, for_self?: boolean): void
 }

package/types/index.d.ts

@@ -0,0 +1 @@
+/// <reference path="./blockbench.d.ts"/>

package/types/interface.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="./blockbench.d.ts"/>
+
 interface ResizeLineOptions {
 	condition?: ConditionResolvable
 	horizontal?: boolean
@@ -16,11 +18,15 @@ declare class ResizeLine {
 	set(): void
 	node: HTMLElement
 	update(): void
-	setPosition(data: {top?: number, bottom?: number, left?: number, right?: number}): void
+	setPosition(data: { top?: number; bottom?: number; left?: number; right?: number }): void
 }
 
 declare namespace Interface {
-	function createElement(type: keyof HTMLElementTagNameMap, attributes?: {}, content?: string | HTMLElement | HTMLElement[]): HTMLElement
+	function createElement(
+		type: keyof HTMLElementTagNameMap,
+		attributes?: {},
+		content?: string | HTMLElement | HTMLElement[]
+	): HTMLElement
 
 	const data: {
 		left_bar_width: number
@@ -50,12 +56,12 @@ declare namespace Interface {
 	}
 	const status_bar: {
 		menu: Menu
-		vue: Vue
+		vue: Vue.Component
 	}
 	const Panels: {
-		(key: string): Panel
+		[key: string]: Panel
 	}
-	function toggleSidebar(side, status): void
+	function toggleSidebar(side: any, status: any): void
 
 	const text_edit_menu: Menu
 
@@ -70,12 +76,15 @@ declare namespace Interface {
 	const left_bar: HTMLElement
 
 	namespace CustomElements {
-		function SelectInput(id: string, options: {
-			value?: string
-			default?: string
-			options: {key: string, value: string}
-			onChange?(): void
-		}): HTMLElement
-		const ResizeLine;
+		function SelectInput(
+			id: string,
+			options: {
+				value?: string
+				default?: string
+				options: { [key: string]: string }
+				onChange?(): void
+			}
+		): HTMLElement
+		const ResizeLine: any
 	}
 }

package/types/io.d.ts

@@ -0,0 +1,2 @@
+declare function autoParseJSON(data: string, feedback?: boolean): any
+declare function autoStringifyJSON(data: any): string

package/types/keyframe.d.ts

@@ -1,68 +1,84 @@
+/// <reference path="./blockbench.d.ts"/>
+
 interface KeyframeDataPointData {
-    [key: string]: any
+	[key: string]: any
 }
-declare class KeyframeDataPoint {
-    constructor(keyframe: _Keyframe);
-    extend(data: KeyframeDataPointData): void;
-    getUndoCopy(): {
-        [key: string]: any
-    };
+declare class KeyframeDataPoint extends Object {
+	static properties: Record<string, Property<any>>
+	constructor(keyframe: _Keyframe)
+	extend(data: KeyframeDataPointData): void
+	getUndoCopy(): {
+		[key: string]: any
+	}
+	[key: string]: any
 }
 
 interface KeyframeOptions {
-    channel?: string
-    data_points: {}[]
-    time: number
-    color: number
-    uniform: boolean
-    interpolation: 'linear' | 'catmullrom' | 'bezier' | 'step' | string
-    bezier_linked: boolean
-    bezier_left_time: ArrayVector3
-    bezier_left_value: ArrayVector3
-    bezier_right_time: ArrayVector3
-    bezier_right_value: ArrayVector3
+	channel?: string
+	data_points: {}[]
+	time: number
+	color?: number
+	uniform?: boolean
+	interpolation?: 'linear' | 'catmullrom' | 'bezier' | 'step' | string
+	bezier_linked?: boolean
+	bezier_left_time?: ArrayVector3
+	bezier_left_value?: ArrayVector3
+	bezier_right_time?: ArrayVector3
+	bezier_right_value?: ArrayVector3
 }
 type axisLetter = 'x' | 'y' | 'z'
 
 declare class _Keyframe {
-    constructor(options: KeyframeOptions, uuid: any);
-
-    animator: GeneralAnimator;
-
-    channel: string
-    data_points: KeyframeDataPoint[]
-    time: number
-    color: number
-    uniform: boolean
-    interpolation: 'linear' | 'catmullrom' | 'bezier' | 'step' | string
-    bezier_linked: boolean
-    bezier_left_time: ArrayVector3;
-    bezier_right_time: ArrayVector3;
-    bezier_left_value: ArrayVector3;
-    bezier_right_value: ArrayVector3;
+	constructor(options: KeyframeOptions, uuid: any)
+	static selected: _Keyframe[]
+	data_points: KeyframeDataPoint[]
+	animator: GeneralAnimator
+	channel: string
+	time: number
+	uuid: string
+	color: number
+	uniform: boolean
+	interpolation: 'linear' | 'catmullrom' | 'bezier' | 'step'
+	cooldown?: boolean
+	bezier_linked: boolean
+	bezier_left_time: ArrayVector3
+	bezier_right_time: ArrayVector3
+	bezier_left_value: ArrayVector3
+	bezier_right_value: ArrayVector3
 
+	extend(data: KeyframeOptions): this
+	get(axis: axisLetter, data_point?: number): number | string
+	calc(axis: axisLetter, data_point?: number): number
+	set(axis: axisLetter, value: any, data_point?: number): this
+	offset(axis: axisLetter, amount: any, data_point?: number): void
+	flip(axis: axisLetter): this
+	getLerp(other: any, axis: axisLetter, amount: any, allow_expression?: boolean): number
+	getCatmullromLerp(
+		before_plus: _Keyframe,
+		before: _Keyframe,
+		after: _Keyframe,
+		after_plus: _Keyframe,
+		axis: axisLetter,
+		alpha: number
+	): number
+	getArray(data_point?: number): (number | string)[]
+	getFixed(
+		data_point?: number,
+		get_quaternion?: boolean
+	): THREE.Vector3 | THREE.Euler | THREE.Quaternion
+	getTimecodeString(): string
+	compileBedrockKeyframe(): any
+	replaceOthers(save: any): void
+	select(event?: any): this
+	callPlayhead(): this
+	showContextMenu(event: Event): this
+	remove(): void
+	forSelected(callback: (keyframe: _Keyframe) => void, undo_tag: any): this[]
+	getUndoCopy(save: any): {
+		animator: any
+		channel?: string | null
+		data_points: KeyframeDataPoint[]
+	}
+}
 
-    extend(data: KeyframeOptions): this;
-    get(axis: axisLetter, data_point?: number): number | string;
-    calc(axis: axisLetter, data_point?: number): number;
-    set(axis: axisLetter, value: any, data_point?: number): this;
-    offset(axis: axisLetter, amount: any, data_point?: number): void;
-    flip(axis: axisLetter): this;
-    getLerp(other: any, axis: axisLetter, amount: any, allow_expression?: boolean): number;
-    getCatmullromLerp(before_plus: _Keyframe, before: _Keyframe, after: _Keyframe, after_plus: _Keyframe, axis: axisLetter, alpha: number): number;
-    getArray(data_point?: number): (number | string)[];
-    getFixed(data_point?: number, get_quaternion?: boolean): THREE.Vector3 | THREE.Euler | THREE.Quaternion;
-    getTimecodeString(): string;
-    compileBedrockKeyframe(): object;
-    replaceOthers(save: any): void;
-    select(event: any): this;
-    callPlayhead(): this;
-    showContextMenu(event: Event): this;
-    remove(): void;
-    forSelected(callback: (keyframe: _Keyframe) => void, undo_tag: any): this[];
-    getUndoCopy(save: any): {
-        animator: any;
-        channel?: string | null;
-        data_points: object[];
-    };
-}
+declare function updateKeyframeSelection(): void

package/types/legacy.d.ts

@@ -1,5 +1,6 @@
+/// <reference path="./blockbench.d.ts"/>
 /**
  * Assign plugin information
  * @deprecated This way of defining plugins is deprecated and will not be supported in the future
  */
-declare var plugin_data: object
+declare var plugin_data: any

package/types/math_util.d.ts

@@ -0,0 +1 @@
+declare function guid(): string

package/types/menu.d.ts

@@ -1,96 +1,111 @@
+/// <reference path="./blockbench.d.ts"/>
 interface CustomMenuItem {
-    name: string
-    id: string
-    icon: IconString
-    color?: string
-    description?: string
-    /**
-     * Keybind or string to display in the menu, won't work as an actual keybinding by default
-     */
-    keybind?: Keybind | string
-    /**
-     * Adds a search bar to the menu or submenu
-     */
-    searchable?: boolean
-    children?: MenuItem[] | (() => MenuItem[])
-    click?: (context?: any, event?: Event) => void
+	name: string
+	id: string
+	icon: IconString
+	color?: string
+	description?: string
+	/**
+	 * Keybind or string to display in the menu, won't work as an actual keybinding by default
+	 */
+	keybind?: Keybind | string
+	/**
+	 * Adds a search bar to the menu or submenu
+	 */
+	searchable?: boolean
+	children?: MenuItem[] | (() => MenuItem[])
+	click?(context?: any, event?: Event): void
 }
-type MenuItem = CustomMenuItem | Action | BarSelect | string;
+type MenuItem = CustomMenuItem | Action | BarSelect | MenuSeparator | string
 interface MenuOptions {
-    onOpen?: (position: MouseEvent | HTMLElement, context?: any) => void
-    onClose?(): void
-    keep_open?: boolean
-    searchable?: boolean
+	onOpen?(position: MouseEvent | HTMLElement, context?: any): void
+	onClose?(): void
+	keep_open?: boolean
+	searchable?: boolean
+	class?: string
 }
 /**
  * Use the Menu class to create a context menu. Menus can contain custom entries and hierarchy, or existing actions and tools.
  */
 declare class Menu extends Deletable {
-    constructor(id: string, template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
-    constructor(template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
+	/**
+	 * Creates a new context menu
+	 */
+	constructor(
+		id: string,
+		template: MenuItem[] | ((context?: any) => MenuItem[]),
+		options?: MenuOptions
+	)
+	constructor(template: MenuItem[] | ((context?: any) => MenuItem[]), options?: MenuOptions)
 
-    /**
-     * 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: MouseEvent | HTMLElement, context?: any): this
-    /**
-     * Closes the menu if it's open
-     */
-    hide(): this
-    /**
-     * 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, path?: string): void
-    /**
-     * 
-     * @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
+	/**
+	 * 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: MouseEvent | HTMLElement, context?: any): this
+	/**
+	 * Closes the menu if it's open
+	 */
+	hide(): this
+	/**
+	 * 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, path?: string | number): void
+	/**
+	 *
+	 * @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
+	structure: MenuItem[]
 }
 
 /**
  * Creates a new menu in the menu bar
  */
 declare class BarMenu extends Menu {
-    constructor(id: string, structure: MenuItem[], condition?: ConditionResolvable)
-    /**
-     * Visually highlights an action within the menu, until the user opens the menu
-     */
-    highlight(action: Action): void
+	constructor(id: string, structure: MenuItem[], condition?: ConditionResolvable)
+	type: 'bar_menu'
+	id: string
+	condition?: ConditionResolvable
+	name: string
+	structure: MenuItem[]
+	/**
+	 * Visually highlights an action within the menu, until the user opens the menu
+	 */
+	highlight(action: Action): void
 }
 
 declare namespace MenuBar {
-    const menus: {
-        file: Menu
-        edit: Menu
-        transform: Menu
-        uv: Menu
-        texture: Menu
-        animation: Menu
-        keyframe: Menu
-        display: Menu
-        tools: Menu
-        view: Menu
-        help: Menu
-        [id: string]: Menu
-    }
-    /**
-     * 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 or group within a level, separated by a point. For example, `file.export.0` places the action at the top position of the Export submenu in the File menu.
-     */
-    function addAction(action: Action, path?: string): void
-    /**
-     * 
-     * @param path Path pointing to the location. Use the ID of each level of the menu, or index or group 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.
-     */
-    function removeAction(path: string)
-    /**
-     * Update the menu bar
-     */
-    function update(): void
-}
+	const menus: {
+		file: Menu
+		edit: Menu
+		transform: Menu
+		uv: Menu
+		texture: Menu
+		animation: Menu
+		keyframe: Menu
+		display: Menu
+		tools: Menu
+		view: Menu
+		help: Menu
+		[id: string]: Menu
+	}
+	/**
+	 * 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 or group within a level, separated by a point. For example, `file.export.0` places the action at the top position of the Export submenu in the File menu.
+	 */
+	function addAction(action: Action, path?: string): void
+	/**
+	 *
+	 * @param path Path pointing to the location. Use the ID of each level of the menu, or index or group 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.
+	 */
+	function removeAction(path: string): void
+	/**
+	 * Update the menu bar
+	 */
+	function update(): void
+}