blockbench-types 4.9.0 → 4.10.0

package/types/outliner.d.ts

@@ -1,18 +1,21 @@
+/// <reference path="./blockbench.d.ts"/>
 type ArrayVector4 = [number, number, number, number]
 type ArrayVector3 = [number, number, number]
 type ArrayVector2 = [number, number]
 
-
+declare const elements: OutlinerNode[]
 /**
  * @private
  */
 declare class OutlinerNode {
-	constructor ()
-	uuid: UUID
+	static properties: Record<string, Property<any>>
+	constructor(uuid: UUID)
 	name: string
+	uuid: UUID
 	export: boolean
 	locked: boolean
-	parent: Group | 'root'
+	parent?: Group | 'root'
+	menu?: Menu
 	/**
 	 * Initializes the node. This should always be called when creating nodes that will be used in the outliner.
 	 */
@@ -39,21 +42,23 @@ declare class OutlinerNode {
 	/**
 	 * Saves the changed name of the element by creating an undo point and making the name unique if necessary.
 	 */
-	saveName(): this
+	saveName(save?: boolean): this
 	/**
 	 * Create a unique name for the group or element by adding a number at the end or increasing it.
 	 */
-	createUniqueName(): this
+	createUniqueName(others?: OutlinerNode[]): this
 	/**
 	 * Checks of the group or element is a child of `group`.
 	 * @param max_levels The maximum number of generations that can be between the element and the group
 	 */
-	isChildOf( group: Group, max_levels: number ): boolean
+	isChildOf(group: Group, max_levels: number): boolean
 	/**
 	 * Displays the context menu of the element
 	 * @param event Mouse event, determines where the context menu spawns.
 	 */
 	showContexnu(event: Event | HTMLElement): this
+	getSaveCopy?(project?: boolean): OutlinerNode
+	sanitizeName(): string
 
 	static uuids: {
 		[uuid: UUID]: OutlinerNode
@@ -64,23 +69,29 @@ declare class OutlinerNode {
  * @private
  */
 declare class OutlinerElement extends OutlinerNode {
-	constructor ()
+	static animator?: BoneAnimator
+	constructor(data: any, uuid: string)
 	selected: boolean
-	readonly mesh: THREE.Object3D | THREE.Mesh
-	getMesh(): THREE.Object3D | THREE.Mesh
-	static fromSave: (data: object, keep_uuid?: boolean) => OutlinerElement
+	mesh: THREE.Object3D | THREE.Mesh
+	static fromSave(data: any, keep_uuid?: boolean): OutlinerElement
 	static isParent: false
+	static types: Record<string, typeof OutlinerElement>
+	static all: OutlinerElement[]
+	static selected: OutlinerElement[]
+	static registerType(constructor: any, id: string): void
+	select(event?: any, isOutlinerClick?: boolean): this | void
+	unselect(...args: any[]): this | void
 }
 
 interface LocatorOptions {
 	name: string
 	from: ArrayVector3
-
 }
 declare class Locator extends OutlinerElement {
-	constructor (options: Partial<LocatorOptions>, uuid?: string)
+	constructor(options: Partial<LocatorOptions>, uuid?: string)
+	name: string
 
-	extend(options: Partial<LocatorOptions>)
+	extend(options: Partial<LocatorOptions>): void
 	flip(axis: number, center: number): this
 	getWorldCenter(): THREE.Vector3
 
@@ -92,21 +103,19 @@ declare class Locator extends OutlinerElement {
 	static hasSelected: () => boolean
 }
 
-
 interface NullObjectOptions {
 	name?: string
 	position?: ArrayVector3
 	ik_target?: string
 	lock_ik_target_rotation?: boolean
-
 }
 declare class NullObject extends OutlinerElement {
-	constructor (options: Partial<NullObjectOptions>, uuid?: string)
+	constructor(options: Partial<NullObjectOptions>, uuid?: string)
 	position: ArrayVector3
 	ik_target: string
 	lock_ik_target_rotation: boolean
 
-	extend(options: Partial<NullObjectOptions>)
+	extend(options: Partial<NullObjectOptions>): void
 	flip(axis: number, center: number): this
 	getWorldCenter(): THREE.Vector3
 
@@ -118,7 +127,6 @@ declare class NullObject extends OutlinerElement {
 	static hasSelected: () => boolean
 }
 
-
 interface TextureMeshOptions {
 	name?: string
 	texture_name?: string
@@ -128,12 +136,12 @@ interface TextureMeshOptions {
 	scale?: ArrayVector3
 }
 declare class TextureMesh extends OutlinerElement {
-	constructor (options: Partial<TextureMeshOptions>, uuid?: string)
+	constructor(options: Partial<TextureMeshOptions>, uuid?: string)
 	texture_name: string
 	local_pivot: ArrayVector3
 	scale: ArrayVector3
 
-	extend(options: Partial<TextureMeshOptions>)
+	extend(options: Partial<TextureMeshOptions>): void
 	flip(axis: number, center: number): this
 	getWorldCenter(): THREE.Vector3
 	moveVector(offset: ArrayVector3 | THREE.Vector3, axis: number, update?: boolean): void
@@ -142,12 +150,19 @@ declare class TextureMesh extends OutlinerElement {
 	static selected: TextureMesh[]
 }
 
-
-
 declare namespace Outliner {
 	const root: OutlinerNode[]
 	const elements: OutlinerElement[]
 	const selected: OutlinerElement[]
+	let control_menu_group: MenuItem[]
+	const buttons: {
+		autouv: any
+		export: any
+		locked: any
+		mirror_uv: any
+		shade: any
+		visibility: any
+	}
 }
 
 declare const markerColors: {
@@ -155,3 +170,7 @@ declare const markerColors: {
 	standard: string
 	name: string
 }[]
+
+declare function compileGroups(undo: boolean, lut?: { [index: number]: number }): any[]
+
+declare function parseGroups(array: any[], import_reference?: any, startIndex?: number): void

package/types/painter.d.ts

@@ -1,31 +1,69 @@
+/// <reference path="./blockbench.d.ts"/>
 /**
  * A global namespace containing various functionality for Blockbench's 2D and 3D paint tools and texture editor
  */
 declare namespace Painter {
 	const currentPixel: ArrayVector2
 	const brushChanges: boolean
-	const current: object
-	const selection: object
+	const current: any
+	const selection: any
 	const mirror_painting: boolean
 	const lock_alpha: boolean
 	const erase_mode: boolean
-	const default_brush_presets: object[]
+	const default_brush_presets: any[]
 
-	function edit(texture: Texture, callback: (canvas: HTMLCanvasElement) => void, options: TextureEditOptions): void
+	function edit(
+		texture: Texture,
+		callback: (canvas: HTMLCanvasElement) => void,
+		options: TextureEditOptions
+	): void
 	function setAlphaMatrix(texture: Texture, x: number, y: number, val: number): void
 	function getAlphaMatrix(texture: Texture, x: number, y: number): number
 
 	function combineColors(base: RGBAColor, added: RGBAColor, opacity: number): RGBAColor
-	function blendColors(base: RGBAColor, added: RGBAColor, opacity: number, blend_mode: string): RGBAColor
+	function blendColors(
+		base: RGBAColor,
+		added: RGBAColor,
+		opacity: number,
+		blend_mode: string
+	): RGBAColor
 	function getMirrorElement(element: OutlinerElement, symmetry_axes: number[]): void
 	function updateNslideValues(): void
 	function getBlendModeCompositeOperation(): string
 	function getCanvas(texture: Texture): HTMLCanvasElement
-	function scanCanvas(ctx: CanvasRenderingContext2D, x: number, y: number, w: number, h: number, cb: () => void): void
+	function scanCanvas(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		w: number,
+		h: number,
+		cb: () => void
+	): void
 	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): void
-	function modifyCanvasSection(ctx: CanvasRenderingContext2D, x: number, y: number, w: number, h: number, cb: () => void): void
-	function editCircle(ctx: CanvasRenderingContext2D, x: number, y: number, r: number, softness: number, editPx: (RGBAColor, opacity: number, px: number, py: number) => RGBAColor): void
-	function editSquare(ctx: CanvasRenderingContext2D, x: number, y: number, r: number, softness: number, editPx: (RGBAColor, opacity: number, px: number, py: number) => RGBAColor): void
+	function modifyCanvasSection(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		w: number,
+		h: number,
+		cb: () => void
+	): void
+	function editCircle(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		r: number,
+		softness: number,
+		editPx: (RGBAColor: any, opacity: number, px: number, py: number) => RGBAColor
+	): void
+	function editSquare(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		r: number,
+		softness: number,
+		editPx: (RGBAColor: any, opacity: number, px: number, py: number) => RGBAColor
+	): void
 	function openBrushOptions(): void
-	function loadBrushPreset(preset: object): void
-}
+	function loadBrushPreset(preset: any): void
+}

package/types/panel.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="./blockbench.d.ts"/>
+/// <reference path="./vue.d.ts"/>
 type PanelSlot = 'left_bar' | 'right_bar' | 'top' | 'bottom' | 'float'
 
 interface PanelOptions {
@@ -5,27 +7,47 @@ interface PanelOptions {
 	name: string
 	icon: string
 	menu?: any
+	/**
+	 * If true, the panel can automatically become smaller or larger than its initial size in the sidebar
+	 */
 	growable?: boolean
+	/**
+	 * When true, the height of the panel can be adjusted in the sidebar
+	 */
+	resizable?: true
 	selection_only?: boolean
 	condition?: ConditionResolvable
 	display_condition?: ConditionResolvable
+	/**
+	 * Adds a button to the panel that allows users to pop-out and expand the panel on click
+	 */
 	expand_button: boolean
-	toolbars: {
-		[id: string]: Toolbar
-	} | Toolbar[]
-	default_position: {
-		slot: PanelSlot
-		float_position: [number, number]
-		float_size: [number, number]
-		height: number
-		folded: boolean
-	}
-	component: Vue.Component
+	toolbars?:
+		| {
+				[id: string]: Toolbar
+		  }
+		| Toolbar[]
+	default_position?:
+		| {
+				slot: PanelSlot
+				float_position: [number, number]
+				float_size: [number, number]
+				height: number
+				folded: boolean
+		  }
+		| number
+	component?: Vue.Component
 	default_side: 'right' | 'left'
-	insert_before: string
-	insert_after: string
-	onResize(): void
-	onFold(): void
+	/**
+	 * Identifier of another panel to insert this one above
+	 */
+	insert_before?: string
+	/**
+	 * Identifier of another panel to insert this one below
+	 */
+	insert_after?: string
+	onResize?(): void
+	onFold?(): void
 }
 type PanelEvent = 'drag' | 'fold' | 'change_zindex' | 'move_to' | 'moved_to' | 'update'
 
@@ -33,16 +55,18 @@ type PanelEvent = 'drag' | 'fold' | 'change_zindex' | 'move_to' | 'moved_to' | '
  * Panels are interface sections in Blockbench, that are always visible (in a specific format and mode), and can be added to the sidebars, above or below the 3D viewport, or used as free floating above the UI. Examples are the Outliner or the UV editor.
  */
 declare class Panel {
-	constructor (id: string, options: PanelOptions)
-	constructor (options: PanelOptions)
+	constructor(id: string, options: PanelOptions)
+	constructor(options: PanelOptions)
 	isVisible(): boolean
 	isInSidebar(): boolean
 	slot: PanelSlot
 	folded: boolean
 	inside_vue: Vue
-
+	resizable: boolean
 
 	fold(state?: boolean): this
+	vue: Vue.Component
+	menu: Menu
 	/**
 	 * If the panel is floating, move it up to the front
 	 */
@@ -53,17 +77,21 @@ declare class Panel {
 	/**
 	 * Add an event listener
 	 */
-	on(event_name: PanelEvent, callback: (data?) => void): void
+	on(event_name: PanelEvent, callback: (data?: any) => void): void
 	/**
 	 * Adds a single-use event listener
 	 */
-	once(event_name: PanelEvent, callback: (data?) => void): void
+	once(event_name: PanelEvent, callback: (data?: any) => void): void
 	/**
 	 * Removes an event listener
 	 */
-	removeListener(event_name: PanelEvent, callback: (data?) => void): void
+	removeListener(event_name: PanelEvent, callback: (data?: any) => void): void
 	delete(): void
 }
 
+declare const Panels: {
+	[id: string]: Panel
+}
+
 declare function updateInterfacePanels(): void
 declare function setActivePanel(panel_id: string): void

package/types/plugin.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./blockbench.d.ts"/>
 interface PluginOptions {
 	title: string
 	author: string
@@ -9,6 +10,10 @@ interface PluginOptions {
 	 * The about text appears when the user unfolds the plugin in the plugin browser. It can contain additional information and usage instructions
 	 */
 	about?: string
+	/**
+	 * The version of the plugin.
+	 */
+	version?: string
 	icon: string
 	/**
 	 * Plugin tags that will show up in the plugin store. You can provide up to 3 tags.
@@ -34,6 +39,17 @@ interface PluginOptions {
 	 * Use the new repository format where plugin, iron, and about are stored in a separate folder
 	 */
 	new_repository_format?: boolean
+	/**
+	 * Can be used to specify which features a plugin adds. This allows Blockbench to be aware of and suggest even plugins that are not installed.
+	 */
+	contributes?: {
+		formats: string[]
+	}
+	has_changelog?: boolean
+	/**
+	 * In combination with a "Deprecated" tag, this can be used to provide context on why a plugin is deprecated
+	 */
+	deprecation_note?: string
 	/**
 	 * Runs when the plugin loads
 	 */
@@ -74,9 +90,21 @@ declare class BBPlugin {
 	about: string
 	icon: string
 	variant: 'both' | 'desktop' | 'web'
+	version: string
 	min_version: string
 	max_version: string
 	tags: string[]
+	/**
+	 * Can be used to specify which features a plugin adds. This allows Blockbench to be aware of and suggest even plugins that are not installed.
+	 */
+	contributes?: {
+		formats: string[]
+	}
+	has_changelog: boolean
+	/**
+	 * In combination with a "Deprecated" tag, this can be used to provide context on why a plugin is deprecated
+	 */
+	deprecation_note?: string
 	onload(): void
 	onunload(): void
 	oninstall(): void

package/types/preview.d.ts

@@ -1,89 +1,91 @@
+/// <reference path="./blockbench.d.ts"/>
 interface AnglePreset {
-    position: ArrayVector3
-    target?: ArrayVector3
-    rotation?: ArrayVector3
-    projection: 'unset' | 'orthographic' | 'perspective'
-    zoom?: number
-    focal_length?: number
-    lockedAngle?: number
+	position: ArrayVector3
+	target?: ArrayVector3
+	rotation?: ArrayVector3
+	projection: 'unset' | 'orthographic' | 'perspective'
+	zoom?: number
+	focal_length?: number
+	lockedAngle?: number
 }
 
 interface PreviewOptions {
-    id: string
-    antialias?: boolean
+	id: string
+	antialias?: boolean
 }
 
 type RaycastResult = {
-    type: 'keyframe' | 'vertex' | 'cube'
-    event: Event
-    cube?: Cube
-    intersects?: object[]
-    face?: string
-    vertex: any
-    keyframe: _Keyframe
+	type: 'keyframe' | 'vertex' | 'cube'
+	event: Event
+	cube?: Cube
+	intersects?: any[]
+	face?: string
+	vertex: any
+	keyframe: _Keyframe
 }
 
 /**
  * Previews are 3D viewports, that can either be used as a viewport for the user, or as an offscreen view to record media.
  */
 declare class Preview extends Deletable {
-    constructor(options: PreviewOptions)
+	constructor(options: PreviewOptions)
 
-    id: string
-    canvas: HTMLCanvasElement
-    height: number
-    width: number
-    node: HTMLElement
-    /**
-     * True if the preview is in orthographic camera mode
-     */
-    isOrtho: boolean
-    /**
-     * Angle, when in a specific side view
-     */
-    angle: null | number
-    readonly camera: THREE.PerspectiveCamera | THREE.OrthographicCamera
-    camPers: THREE.PerspectiveCamera
-    camOrtho: THREE.OrthographicCamera
-    controls: object
-    annotations: object
-    renderer: THREE.WebGLRenderer
-    background: {
-        name: string
-        image: any
-        size: number
-        x: number
-        y: number
-        lock: boolean
-    }
-    raycaster: THREE.Raycaster
+	id: string
+	canvas: HTMLCanvasElement
+	height: number
+	width: number
+	node: HTMLElement
+	/**
+	 * True if the preview is in orthographic camera mode
+	 */
+	isOrtho: boolean
+	/**
+	 * Angle, when in a specific side view
+	 */
+	angle: null | number
+	readonly camera: THREE.PerspectiveCamera | THREE.OrthographicCamera
+	camPers: THREE.PerspectiveCamera
+	camOrtho: THREE.OrthographicCamera
+	controls: any
+	annotations: any
+	renderer: THREE.WebGLRenderer
+	background: {
+		name: string
+		image: any
+		size: number
+		x: number
+		y: number
+		lock: boolean
+	}
+	raycaster: THREE.Raycaster
 
-    raycast(event: MouseEvent): false | RaycastResult
-    render(): void
-    setProjectionMode(orthographic: boolean): this
-    setFOV(fov: number): void
-    setLockedAngle(angle: number): this
+	raycast(event: MouseEvent): false | RaycastResult
+	render(): void
+	setProjectionMode(orthographic: boolean): this
+	setFOV(fov: number): void
+	setLockedAngle(angle: number): this
 
-    loadAnglePreset(angle_preset: AnglePreset): this
-    /**
-     * Opens a dialog to create and save a new angle preset
-     */
-    newAnglePreset(): this
+	loadAnglePreset(angle_preset: AnglePreset): this
+	/**
+	 * Opens a dialog to create and save a new angle preset
+	 */
+	newAnglePreset(): this
 
-    getFacingDirection(): 'north' | 'south' | 'east' | 'west'
-    getFacingHeight(): 'up' | 'middle' | 'down'
+	getFacingDirection(): 'north' | 'south' | 'east' | 'west'
+	getFacingHeight(): 'up' | 'middle' | 'down'
 
-    occupyTransformer(): this
-    showContextMenu(event: Event | HTMLElement): this
+	occupyTransformer(): this
+	showContextMenu(event: Event | HTMLElement): this
+	loadBackground(): void
 
-
-
-    /**
-     * List of all previews
-     */
-    static all: Preview[]
-    /**
-     * The last used preview
-     */
-    static selected: Preview
+	/**
+	 * List of all previews
+	 */
+	static all: Preview[]
+	/**
+	 * The last used preview
+	 */
+	static selected: Preview
 }
+
+declare function animate(): void

package/types/preview_scene.d.ts

@@ -1,15 +1,16 @@
+/// <reference path="./blockbench.d.ts"/>
 interface PreviewModelCubeTemplate {
 	position: ArrayVector3
 	size: ArrayVector3
 	origin?: ArrayVector3
 	rotation?: ArrayVector3
 	faces: {
-		north?: {uv: ArrayVector4}
-		east?: {uv: ArrayVector4}
-		west?: {uv: ArrayVector4}
-		south?: {uv: ArrayVector4}
-		up?: {uv: ArrayVector4}
-		down?: {uv: ArrayVector4}
+		north?: { uv: ArrayVector4 }
+		east?: { uv: ArrayVector4 }
+		west?: { uv: ArrayVector4 }
+		south?: { uv: ArrayVector4 }
+		up?: { uv: ArrayVector4 }
+		down?: { uv: ArrayVector4 }
 	}
 }
 
@@ -38,12 +39,12 @@ interface PreviewModelOptions {
 
 declare class PreviewModel extends Deletable {
 	constructor(id: string, options: PreviewModelOptions)
-	
+
 	static models: {
 		(id: string): PreviewModel
 	}
 	static getActiveModels(): PreviewModel[]
-	
+
 	id: string
 	model_3d: THREE.Object3D
 	cubes: PreviewModelCubeTemplate[]
@@ -52,7 +53,7 @@ declare class PreviewModel extends Deletable {
 	shading: boolean
 	render_side: number
 	texture_size: [number, number]
-	onUpdate?:() => void
+	onUpdate?: () => void
 	/**
 	 * Enables the model in the preview
 	 */
@@ -68,8 +69,6 @@ declare class PreviewModel extends Deletable {
 	buildModel(): void
 }
 
-
-
 interface PreviewSceneOptions {
 	name?: string
 	description?: string
@@ -89,7 +88,7 @@ declare class PreviewScene extends Deletable {
 	select_options: {
 		(id: string): string
 	}
-	
+
 	id: string
 	name: string
 	description: string