blockbench-types 4.9.0 → 4.11.0

package/types/canvas.d.ts

@@ -1,260 +1,271 @@
+/// <reference path="./blockbench.d.ts"/>
 interface UpdateViewOptions {
-    /**
-     * List of elements to update
-     */
-    elements?: OutlinerElement[]
-    /**
-     * Which aspects of the elements to update
-     */
-    element_aspects?: {
-        /**
-         * Update visibility of elements
-         */
-        visibility?: boolean
-        /**
-         * Update the position and geometry
-         */
-        geometry?: boolean
-        /**
-         * Update the mesh faces
-         */
-        faces?: boolean
-        /**
-         * Update the UV mapping
-         */
-        uv?: boolean
-        /**
-         * Update the painting grid
-         */
-        painting_grid?: boolean
-    }
-    /**
-     * Groups to update
-     */
-    groups?: Group[]
-    /**
-     * Whether to update the selection (updates the selection outlines and interface)
-     */
-    selection?: boolean
+	/**
+	 * List of elements to update
+	 */
+	elements?: OutlinerElement[]
+	/**
+	 * Which aspects of the elements to update
+	 */
+	element_aspects?: {
+		/**
+		 * Update visibility of elements
+		 */
+		visibility?: boolean
+		/**
+		 * Update the position and geometry
+		 */
+		geometry?: boolean
+		/**
+		 * Update the mesh faces
+		 */
+		faces?: boolean
+		/**
+		 * Update the UV mapping
+		 */
+		uv?: boolean
+		/**
+		 * Update the painting grid
+		 */
+		painting_grid?: boolean
+		/**
+		 * Update the transform of elements
+		 */
+		transform?: boolean
+	}
+	/**
+	 * Groups to update
+	 */
+	groups?: Group[]
+	/**
+	 * Whether to update the selection (updates the selection outlines and interface)
+	 */
+	selection?: boolean
 }
 
 /**
  * A global namespace handling miscellaneous functionality related to the 3D preview
  */
 declare namespace Canvas {
-    const materials: {
-        [uuid: UUID]: THREE.Material
-    };
-    const meshes: {
-        [uuid: UUID]: THREE.Mesh
-    };
-    const bones: {
-        [uuid: UUID]: THREE.Object3D
-    };
-    /**
-     * Main scene, shared across all tabs
-     */
-    const scene: THREE.Scene
-    /**
-     * List of the gizmos (control and UI elements) in the 3D scene
-     */
-    const gizmos: []
-    /**
-     * The material used for all selection outlines
-     */
-    const outlineMaterial: THREE.LineBasicMaterial;
-    const meshOutlineMaterial: THREE.LineBasicMaterial;
-    /**
-     * The material used for the wireframe view
-     */
-    const wireframeMaterial: THREE.MeshBasicMaterial;
-    const solidMaterial: THREE.ShaderMaterial;
-    const normalHelperMaterial: THREE.ShaderMaterial;
-    const uvHelperMaterial: THREE.ShaderMaterial;
-    const meshVertexMaterial: THREE.PointsMaterial;
-    /**
-     * The material used for the grids
-     */
-    const gridMaterial: THREE.LineBasicMaterial;
+	const materials: {
+		[uuid: UUID]: THREE.Material
+	}
+	const emptyMaterials: {
+		[uuid: UUID]: THREE.Material
+	}
+	const meshes: {
+		[uuid: UUID]: THREE.Mesh
+	}
+	const bones: {
+		[uuid: UUID]: THREE.Object3D
+	}
+	/**
+	 * Main scene, shared across all tabs
+	 */
+	const scene: THREE.Scene
+	/**
+	 * List of the gizmos (control and UI elements) in the 3D scene
+	 */
+	const gizmos: []
+	/**
+	 * The material used for all selection outlines
+	 */
+	const outlineMaterial: THREE.LineBasicMaterial
+	const meshOutlineMaterial: THREE.LineBasicMaterial
+	const onionSkinEarlierMaterial: THREE.LineBasicMaterial
+	const onionSkinLaterMaterial: THREE.LineBasicMaterial
+	/**
+	 * The material used for the wireframe view
+	 */
+	const wireframeMaterial: THREE.MeshBasicMaterial
+	const solidMaterial: THREE.ShaderMaterial
+	const normalHelperMaterial: THREE.ShaderMaterial
+	const uvHelperMaterial: THREE.ShaderMaterial
+	const meshVertexMaterial: THREE.PointsMaterial
+	const transparentMaterial: THREE.MeshBasicMaterial
+	/**
+	 * The material used for the grids
+	 */
+	const gridMaterial: THREE.LineBasicMaterial
 
-    const pivot_marker: THREE.Object3D
+	const pivot_marker: THREE.Object3D
 
-    const global_light_color: THREE.Color
-    const global_light_side: number
+	const global_light_color: THREE.Color
+	const global_light_side: number
 
-    const face_order: string[];
+	const face_order: string[]
+
+	/**
+	 * Raycast on the currently selected preview
+	 */
+	function raycast(event: MouseEvent): any
+	/**
+	 * Execute the callback function without any gizmos, grids and helpers visible
+	 */
+	function withoutGizmos(cb: () => void): void
+	/**
+	 * Clear all elements from the scene
+	 */
+	function clear(): void
+	function buildGrid(): void
+	function updateShading(): void
+	/**
+	 * Updates selected aspects of the preview
+	 * @param options
+	 */
+	function updateView(options: UpdateViewOptions): void
+	/**
+	 * Regenerate all elements in the scene. Very unoptimized, use with care
+	 */
+	function updateAll(): void
+	/**
+	 * Update the position and shape of all elements
+	 */
+	function updateAllPositions(): void
+	/**
+	 * Update the visibility of all elements
+	 */
+	function updateVisibility(): void
+	/**
+	 * Update all faces in the scene
+	 * @param texture Texture filter. If specified, only faces with this texture will be updated
+	 */
+	function updateAllFaces(texture?: Texture): void
+	/**
+	 * Update all UV maps in the scene
+	 */
+	function updateAllUVs(): void
+	/**
+	 * Returns the three.js render sides based on the current settings and state
+	 */
+	function getRenderSide(): number
+	/**
+	 * Update render sides of all materials
+	 */
+	function updateRenderSides(): void
+	/**
+	 * Redraw the selected elements in the scene
+	 * @param arr Optionally specify an array of elements to update
+	 */
 
-    /**
-     * Raycast on the currently selected preview
-     */
-    function raycast(event: MouseEvent): any;
-    /**
-     * Execute the callback function without any gizmos, grids and helpers visible
-     */
-    function withoutGizmos(cb: () => void): void;
-    /**
-     * Clear all elements from the scene
-     */
-    function clear(): void;
-    function buildGrid(): void;
-    function updateShading(): void;
-    /**
-     * Updates selected aspects of the preview
-     * @param options 
-     */
-    function updateView(options: UpdateViewOptions): void; 
-    /**
-     * Regenerate all elements in the scene. Very unoptimized, use with care
-     */
-    function updateAll(): void;
-    /**
-     * Update the position and shape of all elements
-     */
-    function updateAllPositions(): void;
-    /**
-     * Update the visibility of all elements
-     */
-    function updateVisibility(): void;
-    /**
-     * Update all faces in the scene
-     * @param texture Texture filter. If specified, only faces with this texture will be updated
-     */
-    function updateAllFaces(texture: Texture): void;
-    /**
-     * Update all UV maps in the scene
-     */
-    function updateAllUVs(): void;
-    /**
-     * Returns the three.js render sides based on the current settings and state
-     */
-    function getRenderSide(): number;
-    /**
-     * Update render sides of all materials
-     */
-    function updateRenderSides(): void;
-    /**
-     * Redraw the selected elements in the scene
-     * @param arr Optionally specify an array of elements to update
-     */
-    
-    function updateSelected(arr: any): void;
-    /**
-     * Update positions and shapes of the selected elements
-     */
-    function updatePositions(y): void;
-    /**
-     * Update the faces of all selected elements (material, UV map)
-     */
-    function updateSelectedFaces(): void;
-    /**
-     * Update the UV maps of all selected elements
-     */
-    function updateUVs(): void;
-    /**
-     * Update the hierarchy and position of all bones
-     */
-    function updateAllBones(): void;
-    /**
-     * Update the position of the origin / pivot point gizmo
-     */
-    function updateOrigin(): boolean;
-    /**
-     * Update the position and shape of the specified cube
-     * @param cube Cube to update
-     * @param mesh Mesh instance of the cube
-     */
-    function adaptObjectPosition(cube: Cube, mesh?: THREE.Mesh): void;
-    /**
-     * Update the geometry faces of the specified cube
-     * @param cube Cube to update
-     */
-    function adaptObjectFaceGeo(cube: any): void;
-    /**
-     * Update the faces (material) of the specified cube
-     * @param cube Cube to update
-     * @param mesh Mesh instance of the cube
-     */
-    function adaptObjectFaces(cube: any, mesh: any): void;
-    /**
-     * Update the layered or not layered material of all elements
-     */
-    function updateLayeredTextures(): void;
-    /**
-     * Update the UV map of the specified cube
-     * @param cube Cube to update
-     * @param animation Whether to display the current animated texture frame
-     */
-    function updateUV(cube: Cube, animation?: boolean): any;
-    /**
-     * Update the materials of marker colors if new colors were added
-     */
-    function updateMarkerColorMaterials(): void;
-    /**
-     * Create an additional outline around the specified cubes
-     * @param arr List of cubes to outline
-     */
-    function outlineObjects(arr: Cube[]): void;
-    /**
-     * Calculate the size of the model, in the currently displayed shape. Returns [width, height] in blockbench units
-     */
-    function getModelSize(): [number, number];
+	function updateSelected(arr: any): void
+	/**
+	 * Update positions and shapes of the selected elements
+	 */
+	function updatePositions(y: number): void
+	/**
+	 * Update the faces of all selected elements (material, UV map)
+	 */
+	function updateSelectedFaces(): void
+	/**
+	 * Update the UV maps of all selected elements
+	 */
+	function updateUVs(): void
+	/**
+	 * Update the hierarchy and position of all bones
+	 */
+	function updateAllBones(): void
+	/**
+	 * Update the position of the origin / pivot point gizmo
+	 */
+	function updateOrigin(): boolean
+	/**
+	 * Update the position and shape of the specified cube
+	 * @param cube Cube to update
+	 * @param mesh Mesh instance of the cube
+	 */
+	function adaptObjectPosition(cube: Cube, mesh?: THREE.Mesh): void
+	/**
+	 * Update the geometry faces of the specified cube
+	 * @param cube Cube to update
+	 */
+	function adaptObjectFaceGeo(cube: any): void
+	/**
+	 * Update the faces (material) of the specified cube
+	 * @param cube Cube to update
+	 * @param mesh Mesh instance of the cube
+	 */
+	function adaptObjectFaces(cube: any, mesh: any): void
+	/**
+	 * Update the layered or not layered material of all elements
+	 */
+	function updateLayeredTextures(): void
+	/**
+	 * Update the UV map of the specified cube
+	 * @param cube Cube to update
+	 * @param animation Whether to display the current animated texture frame
+	 */
+	function updateUV(cube: Cube, animation?: boolean): any
+	/**
+	 * Update the materials of marker colors if new colors were added
+	 */
+	function updateMarkerColorMaterials(): void
+	/**
+	 * Create an additional outline around the specified cubes
+	 * @param arr List of cubes to outline
+	 */
+	function outlineObjects(arr: Cube[]): void
+	/**
+	 * Calculate the size of the model, in the currently displayed shape. Returns [width, height] in blockbench units
+	 */
+	function getModelSize(): [number, number]
 }
 
 /**
  * Marks a specific aspect of the interface to be updated in the next tick. Useful to avoid an update function getting called multiple times in the same task.
  */
 declare namespace TickUpdates {
-    const outliner: undefined | true
-    const selection: undefined | true
-    const main_uv: undefined | true
-    const texture_list: undefined | true
-    const keyframes: undefined | true
-    const keyframe_selection: undefined | true
-    const keybind_conflicts: undefined | true
+	const outliner: undefined | true
+	const selection: undefined | true
+	const main_uv: undefined | true
+	const texture_list: undefined | true
+	const keyframes: undefined | true
+	const keyframe_selection: undefined | true
+	const keybind_conflicts: undefined | true
 }
 
 interface NodePreviewControllerOptions {
-    setup?(element: OutlinerNode): void
-    remove?(element: OutlinerNode): void
-    updateAll?(element: OutlinerNode): void
-    updateTransform?(element: OutlinerNode): void
-    updateVisibility?(element: OutlinerNode): void
-    updateSelection?(element: OutlinerNode): void
-    updateGeometry?(element: OutlinerNode): void
-    updateUV?(element: OutlinerNode): void
-    updateFaces?(element: OutlinerNode): void
-    updatePaintingGrid?(element: OutlinerNode): void
-    updateHighlight?(element: OutlinerNode): void
+	setup?(element: OutlinerNode): void
+	remove?(element: OutlinerNode): void
+	updateAll?(element: OutlinerNode): void
+	updateTransform?(element: OutlinerNode): void
+	updateVisibility?(element: OutlinerNode): void
+	updateSelection?(element: OutlinerNode): void
+	updateGeometry?(element: OutlinerNode): void
+	updateUV?(element: OutlinerNode): void
+	updateFaces?(element: OutlinerNode): void
+	updatePaintingGrid?(element: OutlinerNode): void
+	updateHighlight?(element: OutlinerNode): void
 }
 declare class NodePreviewController {
-    constructor(type: typeof OutlinerNode, options: NodePreviewControllerOptions)
-    type: typeof OutlinerNode
-    events: {
-        [event_name: string]: ((data) => void)[]
-    }
-    dispatchEvent(event_name: string, data: object)
+	constructor(type: typeof OutlinerNode, options: NodePreviewControllerOptions)
+	type: typeof OutlinerNode
+	events: {
+		[event_name: string]: ((data: any) => void)[]
+	}
+	dispatchEvent(event_name: string, data: Record<string, any>): void
 	/**
 	 * Adds an event listener
 	 */
-    on(event_name: string, cb: (data) => void)
+	on(event_name: string, cb: (data: any) => void): void
 	/**
 	 * Adds a single-use event listener
 	 */
-    once(event_name: string, cb: (data) => void)
+	once(event_name: string, cb: (data: any) => void): void
 	/**
 	 * Removes an event listener
 	 */
-    removeListener(event_name: string, cb: (data) => void)
+	removeListener(event_name: string, cb: (data: any) => void): void
 
-    setup(element: OutlinerNode): void
-    remove(element: OutlinerNode): void
-    updateAll(element: OutlinerNode): void
-    updateTransform(element: OutlinerNode): void
-    updateVisibility(element: OutlinerNode): void
-    updateSelection(element: OutlinerNode): void
-    updateGeometry(instance: OutlinerNode): void
-    updateUV(instance: OutlinerNode): void
-    updateFaces(instance: OutlinerNode): void
-    updatePaintingGrid(instance: OutlinerNode): void
-    updateHighlight(instance: OutlinerNode): void
-}
+	setup(element: OutlinerNode): void
+	remove(element: OutlinerNode): void
+	updateAll(element: OutlinerNode): void
+	updateTransform(element: OutlinerNode): void
+	updateVisibility(element: OutlinerNode): void
+	updateSelection(element: OutlinerNode): void
+	updateGeometry(instance: OutlinerNode): void
+	updateUV(instance: OutlinerNode): void
+	updateFaces(instance: OutlinerNode): void
+	updatePaintingGrid(instance: OutlinerNode): void
+	updateHighlight(instance: OutlinerNode): void
+}

package/types/canvas_frame.d.ts

@@ -13,9 +13,9 @@ declare class CanvasFrame {
 
 	createCanvas(width: number, height: number): void
 	loadFromUrl(url: string): Promise<void>
-	loadFromImg(img: HTMLImageElement): void
+	loadFromImage(img: HTMLImageElement): void
 	/**
 	 * Crop the image to only pixels that have an alpha value
 	 */
 	autoCrop(): void
-}
+}

package/types/codec.d.ts

@@ -1,9 +1,9 @@
-
+/// <reference path="./blockbench.d.ts"/>
 interface CodecOptions {
 	name: string
-	load?(model: any, file: object, add?: boolean): void
-	compile?(options?: object): void
-	parse?(data: any, path: string): void
+	load?(model: any, file: FileResult, add?: boolean): void
+	compile?(options?: any): string | ArrayBuffer | any
+	parse?(data: any, path: string, add?: boolean): void
 	export?(): void
 	/**
 	 * Generate a file name to suggest when exporting
@@ -11,9 +11,11 @@ interface CodecOptions {
 	fileName?(): string
 	startPath?(): string
 	write?(content: any, path: string): void
-	overwrite?(content: any, path: string, callback: ((path) => void)): void
-	afterDownload?(path): void
-	afterSave?(path): void
+	overwrite?(content: any, path: string, callback: (path: any) => void): void
+	afterDownload?(path: any): void
+	afterSave?(path: any): void
+
+	dispatchEvent?(event_name: string, data: any): void
 
 	extension: string
 	/**
@@ -50,73 +52,73 @@ declare class Codec extends Deletable {
 
 	/**
 	 * Load a file into the program
-	 * @param model 
-	 * @param file 
-	 * @param add 
+	 * @param model
+	 * @param file
+	 * @param add
 	 */
-	load?(model: any, file: object, add?: boolean): void
+	load(model: any, file: any, add?: boolean): void
 	/**
 	 * Compiles the file content
-	 * @param options 
+	 * @param options
 	 */
-	compile?(options?: object): any
+	compile(options?: any): any
 	/**
 	 * Takes the content of a file, and loads the model into the current Blockbench project
 	 * @param data File content
 	 * @param path File path
 	 */
-	parse?(data: any, path: string): void
+	parse?(data: any, path: string, add?: boolean): void
 	/**
 	 * Opens the file browser to export a file of this type
 	 */
-	export?(): void
+	export(): void
 	/**
 	 * Generate a file name to suggest when exporting
 	 */
-	fileName?(): string
+	fileName(): string
 	/**
 	 * Generates the suggested file path. This is the path that the explorer opens in when exporting this type
 	 */
-	startPath?(): string
+	startPath(): string
 	/**
 	 * Write the content of this file to the selected location. The default method can be overwritten to achieve custom behavior
 	 * @param content File content, as generated by compile()
 	 * @param path The file export path
 	 */
-	write?(content: any, path: string): void
-	overwrite?(content: any, path: string, callback: ((path) => void)): void
-	afterDownload?(path): void
-	afterSave?(path): void
+	write(content: any, path: string): void
+	overwrite(content: any, path: string, callback: (path: string) => void): void
+	afterDownload(path: string): void
+	afterSave(path: string): void
 
 	/**
 	 * Return the stored export option values of the current project
 	 */
-	getExportOptions(): {[key: string]: any}
+	getExportOptions(): { [key: string]: any }
 	/**
 	 * Prompt the user to enter their preferred export settings into the dialog
 	 */
-	promptExportOptions(): Promise<({[key: string]: any} | null)>
+	promptExportOptions(): Promise<{ [key: string]: any } | null>
 
 	/**
 	 * Adds an event listener to the codec
 	 * @param event_name The event type to listen for
-	 * @param callback 
+	 * @param callback
 	 */
-	on(event_name: string, callback: (data: object) => void): void
+	on(event_name: string, callback: (data: any) => void): void
 	/**
 	 * Adds a single-use event listener to the codec
 	 * @param event_name The event type to listen for
-	 * @param callback 
+	 * @param callback
 	 */
-	once(event_name: string, callback: (data: object) => void): void
+	once(event_name: string, callback: (data: any) => void): void
 	/**
 	 * Removes an event listener from the codec
-	 * @param event_name 
-	 * @param callback 
+	 * @param event_name
+	 * @param callback
 	 */
-	removeListener(event_name: string, callback: (data: object) => void): void
-	dispatchEvent(data: object): void
-	
+	removeListener(event_name: string, callback: (data: any) => void): void
+	dispatchEvent(event_name: string, data: any): void
+
 	/**
 	 * The display name of the codec
 	 */
@@ -141,6 +143,8 @@ declare class Codec extends Deletable {
 		[key: string]: DialogFormElement
 	}
 
+	format: ModelFormat
+
 	/**
 	 * Get a list of all possible extensions of all codecs
 	 */