blockbench-types 4.6.1 → 4.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockbench-types",
-  "version": "4.6.1",
+  "version": "4.9.0",
   "description": "Blockbench typescript types",
   "main": "",
   "types": "types/blockbench.d.ts",
@@ -22,6 +22,7 @@
   },
   "dependencies": {
     "@types/jquery": "^3.5.4",
+    "@types/three": "^0.155.0",
     "@types/tinycolor2": "^1.4.3",
     "three": "^0.129.0",
     "typescript": "^4.9.5",

package/scripts/generate_docs.js

@@ -16,6 +16,7 @@ async function main() {
 		entryPoints: [
 			"./types/blockbench.d.ts",
 			"./types/textures.d.ts",
+			"./types/texture_layers.d.ts",
 			"./types/action.d.ts",
 			"./types/animation.d.ts",
 			"./types/animation_controller.d.ts",
@@ -43,6 +44,7 @@ async function main() {
 			"./types/painter.d.ts",
 			"./types/screencam.d.ts",
 			"./types/validator.d.ts",
+			"./types/shared_actions.d.ts",
 			"./types/display_mode.d.ts",
 			"./types/misc.d.ts",
 			"./types/util.d.ts"
@@ -68,13 +70,13 @@ async function main() {
 
 		'Vue.Component': '[Vue.Component](https://v2.vuejs.org/v2/guide/components.html)',
 
-		'THREE.Vector3': '[THREE.Vector3](https://threejs.org/docs/index.html#api/en/math/Vector3)',
-		'THREE.Euler': '[THREE.Euler](https://threejs.org/docs/index.html#api/en/math/Euler)',
-		'THREE.Quaternion': '[THREE.Quaternion](https://threejs.org/docs/index.html#api/en/math/Quaternion)',
-		'THREE.Object3D': '[THREE.Object3D](https://threejs.org/docs/index.html#api/en/core/Object3D)',
-		'THREE.PerspectiveCamera': '[THREE.PerspectiveCamera](https://threejs.org/docs/index.html#api/en/cameras/PerspectiveCamera)',
-		'THREE.OrthographicCamera': '[THREE.OrthographicCamera](https://threejs.org/docs/index.html#api/en/cameras/OrthographicCamera)',
-		'THREE.WebGLRenderer': '[THREE.WebGLRenderer](https://threejs.org/docs/index.html#api/en/renderers/WebGLRenderer)',
+		'Vector3': '[THREE.Vector3](https://threejs.org/docs/index.html#api/en/math/Vector3)',
+		'Euler': '[THREE.Euler](https://threejs.org/docs/index.html#api/en/math/Euler)',
+		'Quaternion': '[THREE.Quaternion](https://threejs.org/docs/index.html#api/en/math/Quaternion)',
+		'Object3D': '[THREE.Object3D](https://threejs.org/docs/index.html#api/en/core/Object3D)',
+		'PerspectiveCamera': '[THREE.PerspectiveCamera](https://threejs.org/docs/index.html#api/en/cameras/PerspectiveCamera)',
+		'OrthographicCamera': '[THREE.OrthographicCamera](https://threejs.org/docs/index.html#api/en/cameras/OrthographicCamera)',
+		'WebGLRenderer': '[THREE.WebGLRenderer](https://threejs.org/docs/index.html#api/en/renderers/WebGLRenderer)',
 
 		'HTMLElement': '[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)',
 		'HTMLCanvasElement': '[HTMLCanvasElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement)',

package/types/action.d.ts

@@ -31,6 +31,7 @@ declare class KeybindItem extends Deletable {
 declare class MenuSeparator {
     constructor();
 }
+type ActionEventName = 'delete' | 'use' | 'used' | 'trigger' | 'get_node' | 'select' | 'change' | 'changed' | 'update' | 'open'
 interface BarItemOptions extends KeybindItemOptions {
     name?: string
     description?: string
@@ -60,6 +61,26 @@ declare class BarItem extends KeybindItem {
      */
     toElement(destination: HTMLElement): this;
     pushToolbar(bar: any): void;
+
+    /**
+	 * Adds an event listener to the item
+	 * @param event_name The event type to listen for
+	 * @param callback 
+	 */
+	on(event_name: ActionEventName, callback: (data: object) => void): void
+	/**
+	 * Adds a single-use event listener to the item
+	 * @param event_name The event type to listen for
+	 * @param callback 
+	 */
+	once(event_name: ActionEventName, callback: (data: object) => void): void
+	/**
+	 * Removes an event listener from the item
+	 * @param event_name 
+	 * @param callback 
+	 */
+	removeListener(event_name: ActionEventName, callback: (data: object) => void): void
+	dispatchEvent(data: object): void
 }
 
 interface ActionOptions extends BarItemOptions {
@@ -230,7 +251,7 @@ interface ToolOptions extends ActionOptions {
     brush?: BrushOptions
 }
 /**
- * A tool, such as mvoe tool, vertex snap tool, or paint brush
+ * A tool, such as move tool, vertex snap tool, or paint brush
  */
 declare class Tool extends Action {
     constructor(id: string, options: ToolOptions);
@@ -284,8 +305,27 @@ declare class ColorPicker extends Widget {
     set(color: any): this;
     get(): any;
 }
+interface ToolbarOptions {
+    id: string
+    name?: string
+    /**
+     * If true, the toolbar will display a label abovee
+     */
+    label?: boolean
+    condition?: ConditionResolvable
+    /**
+     * If true, the toolbar will only take as much width as needed
+     */
+    narrow?: boolean
+    vertical?: boolean
+    /**
+     * Default content of the toolbar. Separators are available, where _ = separator, + = spaces, # = line break
+     */
+    children: ('_' | '+' | '#' | string | BarItem)[]
+}
 declare class Toolbar {
-    constructor(data: any);
+    constructor(id: string, data: ToolbarOptions);
+    constructor(data: ToolbarOptions);
     build(data: any, force: any): this;
     contextmenu(event: Event): void;
     editMenu(): this;

package/types/animation.d.ts

@@ -5,6 +5,7 @@ declare class AnimationItem {
 
 interface AnimationOptions {
     name?: string
+    path?: string
     loop?: 'once' | 'hold' | 'loop'
     override?: boolean
     anim_time_update?: string
@@ -27,20 +28,36 @@ declare class _Animation extends AnimationItem {
         snapping: any;
         selected: any;
     };
+    /**
+     * Compiles the JSON tree of the animation for the Minecraft Bedrock Edition animation format.
+     */
     compileBedrockAnimation(): object;
     save(): this | undefined;
     select(): this | undefined;
     setLength(length: number): void;
-    createUniqueName(references: Animation[]): any;
+    createUniqueName(references: _Animation[]): any;
     rename(): this;
     togglePlayingState(state: any): any;
     showContextMenu(event: any): this;
-    getBoneAnimator(group: any): BoneAnimator;
-    add(undo: any): this;
+    /**
+     * Returns (if necessary creates) the animator of a specific bone of the animation
+     */
+    getBoneAnimator(group: OutlinerNode): BoneAnimator;
+    /**
+     * Adds the animation to the current project and to the interface
+     * @param undo If true, the addition of the animation will be registered as an edit
+     */
+    add(undo?: any): this;
     remove(undo: any, remove_from_file?: boolean): this;
     getMaxLength(): number;
     setLoop(value: any, undo: any): void;
+    /**
+     * Calculate the snapping value that the animation should use, based on the time codes of the keyframes that it holds. Directly updates the value, but also returns it as a number (snaps per second)
+     */
     calculateSnappingFromKeyframes(): number;
+    /**
+     * Opens the properties dialog
+     */
     propertiesDialog(): void;
 
     name: string
@@ -70,6 +87,7 @@ declare class _Animation extends AnimationItem {
 declare namespace Animator {
     const open: boolean
     const MolangParser: object
+    const possible_channels: unknown[];
     const motion_trail: THREE.Object3D
     const motion_trail_lock: boolean
     const particle_effects: object
@@ -98,13 +116,14 @@ interface AddChannelOptions {
     max_data_points?: number
 }
 declare class GeneralAnimator {
-    constructor(uuid: string, animation: Animation)
-    keyframes: Keyframe[]
+    constructor(uuid: string, animation: _Animation, name: string)
+    uuid: string
+    keyframes: _Keyframe[]
     select(): this
     addToTimeline(): this
-    addKeyframe(data: KeyframeOptions, uuid: string): Keyframe
-    createKeyframe(): Keyframe
-    getOrMakeKeyframe(): {before: Keyframe, result: Keyframe}
+    addKeyframe(data: KeyframeOptions, uuid?: string): _Keyframe
+    createKeyframe(): _Keyframe
+    getOrMakeKeyframe(): {before: _Keyframe, result: _Keyframe}
     toggleMuted(channel: string): this
     scrollTo(): this
 
@@ -114,9 +133,9 @@ declare class GeneralAnimator {
 declare class BoneAnimator extends GeneralAnimator {
     name: string
     uuid: string
-    rotations: Keyframe[]
-    position: Keyframe[]
-    scale: Keyframe[]
+    rotations: _Keyframe[]
+    position: _Keyframe[]
+    scale: _Keyframe[]
     getGroup(): Group
     fillValues(): void
     pushKeyframe(): void
@@ -130,9 +149,9 @@ declare class BoneAnimator extends GeneralAnimator {
 declare class NullObjectAnimator extends GeneralAnimator {
     name: string
     uuid: string
-    rotations: Keyframe[]
-    position: Keyframe[]
-    scale: Keyframe[]
+    rotations: _Keyframe[]
+    position: _Keyframe[]
+    scale: _Keyframe[]
     getElement(): NullObject
     doRender(): void
     displayPosition(): void
@@ -140,11 +159,12 @@ declare class NullObjectAnimator extends GeneralAnimator {
     displayFrame(): void
 }
 declare class EffectAnimator extends GeneralAnimator {
+    constructor(animation: _Animation)
     name: string
     uuid: string
-    rotations: Keyframe[]
-    position: Keyframe[]
-    scale: Keyframe[]
+    particle: _Keyframe[]
+    sound: _Keyframe[]
+    timeline: _Keyframe[]
     pushKeyframe(keyframe): this
     displayFrame(in_loop): this
     startPreviousSounds(): void

package/types/animation_controller.d.ts

@@ -63,7 +63,7 @@ declare class AnimationControllerState {
     remove(undo?: boolean): void
     createUniqueName(): void
 
-    addAnimation(animation?: Animation): void
+    addAnimation(animation?: _Animation): void
     addTransition(target_uuid?: string): void
     addParticle(options?: {effect: string}): void
     addSound(options?: {effect: string, file: string}): void
@@ -80,7 +80,9 @@ interface AnimationControllerOptions {
     initial_state?: string
 }
 
-
+/**
+ * Animation Controllers are state machines used for Minecraft: Bedrock Edition models to control and blend between animations.
+ */
 declare class AnimationController extends AnimationItem {
     constructor(data: AnimationControllerOptions);
     name: string
@@ -100,6 +102,10 @@ declare class AnimationController extends AnimationItem {
     select(): this | undefined;
     createUniqueName(references: AnimationController[]): string | boolean;
     rename(): this;
+    /**
+     * Adds the animation controller to the current project and to the interface
+     * @param undo If true, the addition of the animation controller will be registered as an edit
+     */
     add(undo: any): this;
     remove(undo?: boolean, remove_from_file?: boolean): this;
     propertiesDialog(): void;

package/types/blockbench.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="vue" />
-/// <reference types="three" />
+/// <reference types="@types/three" />
 /// <reference types="@types/tinycolor2" />
 /// <reference types="@types/jquery" />
 /// <reference types="wintersky" />
 
 /// <reference types="./textures" />
+/// <reference types="./texture_layers" />
 /// <reference types="./action" />
 /// <reference types="./animation" />
 /// <reference types="./animation_controller" />
@@ -32,9 +33,13 @@
 /// <reference types="./painter" />
 /// <reference types="./screencam" />
 /// <reference types="./validator" />
+/// <reference types="./shared_actions" />
 /// <reference types="./display_mode" />
 /// <reference types="./misc" />
 /// <reference types="./util" />
+/// <reference types="./math_util" />
+/// <reference types="./canvas_frame" />
+/// <reference types="./io" />
 
 
 	
@@ -58,7 +63,7 @@ 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
+	custom_writer?(content: string | ArrayBuffer, file_path: string): void
 }
 interface PickDirOptions {
 	/**Location where the file dialog starts off
@@ -189,6 +194,12 @@ declare namespace Blockbench {
 	export function showStatusMessage(message: string, time?: number): void
 
 	export function setStatusBarText(text?: string): void
+
+	/**
+	 * Display a tooltip displaying a custom text that appears next to and follows the mouse cursor
+	 * @param text The text to display. Line breaks are supported. Leave empty to hide the tooltip.
+	 */
+	export function setCursorTooltip(text?: string): void
 	/**
 	 * Set the value of a progress bar
 	 * 
@@ -204,9 +215,13 @@ declare namespace Blockbench {
 	/**
 	 * Opens a message box
 	 */
-	export function showMessageBox(options: MessageBoxOptions, callback: (buttonID: number | string) => void): void
+	export function showMessageBox(options: MessageBoxOptions, callback: (button: number | string, checkbox_results: {[key: string]: boolean} | undefined, event: Event) => void): void
 
 	export function textPrompt(title: string, value: string, callback: (value: string) => void): void
+	/**
+	 * todo
+	 */
+	export function showToastMessage(): Deletable
 	/**
 	 * Opens the specified link in the browser or in a new tab
 	 */
@@ -232,9 +247,18 @@ declare namespace Blockbench {
 	export function dispatchEvent(event_name: EventName, data: object): void
 
 	export function addListener(event_names: EventName, callback: (data: object) => void): void
+	/**
+	 * Adds an event listener
+	 */
 	export function on(event_names: EventName, callback: (data: object) => void): void
-
-	export function removeListener(event_names: EventName): void
+	/**
+	 * Adds a single-use event listener
+	 */
+	export function once(event_names: EventName, callback: (data: object) => void): void
+	/**
+	 * Removes an event listener
+	 */
+	export function removeListener(event_names: EventName, callback: (data: object) => void): void
 
 
 
@@ -274,6 +298,22 @@ declare namespace Blockbench {
 	export { _export as export };
 
 
+	interface FindFileFromContentOptions {
+		read_file?: boolean
+		json?: boolean
+		recursive?: boolean
+		filter_regex?: RegExp
+		priority_regex?: RegExp
+	}
+	type CheckFileCallback = (path: string, content: (string|object)) => any
+	/**
+	 * Find a file in a directory, based on content. Optimized by prioritizing files with certain names.
+	 * @param base_directories Base directories to search in
+	 * @param options Options
+	 * @param check_file Function that runs on every file to check if the file is a match. If the function returns anything truthy, that result is returned by the main function.
+	 */
+	export function findFileFromContent(base_directories: string[], options: FindFileFromContentOptions, check_file: CheckFileCallback): false | any
+
 
 	/**
 	 * Adds a drag handler that handles dragging and dropping files into Blockbench

package/types/canvas.d.ts

@@ -38,6 +38,9 @@ interface UpdateViewOptions {
     selection?: boolean
 }
 
+/**
+ * A global namespace handling miscellaneous functionality related to the 3D preview
+ */
 declare namespace Canvas {
     const materials: {
         [uuid: UUID]: THREE.Material
@@ -230,7 +233,17 @@ declare class NodePreviewController {
         [event_name: string]: ((data) => void)[]
     }
     dispatchEvent(event_name: string, data: object)
+	/**
+	 * Adds an event listener
+	 */
     on(event_name: string, cb: (data) => void)
+	/**
+	 * Adds a single-use event listener
+	 */
+    once(event_name: string, cb: (data) => void)
+	/**
+	 * Removes an event listener
+	 */
     removeListener(event_name: string, cb: (data) => void)
 
     setup(element: OutlinerNode): void

package/types/canvas_frame.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Wrapper for HTML canvases to simplify loading and modifying images
+ */
+declare class CanvasFrame {
+	readonly width: number
+	readonly height: number
+	canvas: HTMLCanvasElement
+	ctx: CanvasRenderingContext2D
+
+	constructor(a: HTMLCanvasElement)
+	constructor(a: HTMLImageElement)
+	constructor(a: number, b: number)
+
+	createCanvas(width: number, height: number): void
+	loadFromUrl(url: string): Promise<void>
+	loadFromImg(img: HTMLImageElement): void
+	/**
+	 * Crop the image to only pixels that have an alpha value
+	 */
+	autoCrop(): void
+}

package/types/codec.d.ts

@@ -25,6 +25,15 @@ interface CodecOptions {
 		type: 'json' | 'text'
 		condition?: ConditionResolvable
 	}
+	/**
+	 * List of export option inputs, based on the Dialog form API
+	 */
+	export_options?: {
+		[key: string]: DialogFormElement
+	}
+	/**
+	 * Default action that is used to export to the codec
+	 */
 	export_action?: Action
 }
 
@@ -79,12 +88,27 @@ declare class Codec extends Deletable {
 	afterDownload?(path): void
 	afterSave?(path): void
 
+	/**
+	 * Return the stored export option values of the current project
+	 */
+	getExportOptions(): {[key: string]: any}
+	/**
+	 * Prompt the user to enter their preferred export settings into the dialog
+	 */
+	promptExportOptions(): Promise<({[key: string]: any} | null)>
+
 	/**
 	 * Adds an event listener to the codec
 	 * @param event_name The event type to listen for
 	 * @param callback 
 	 */
 	on(event_name: string, callback: (data: object) => void): void
+	/**
+	 * Adds a single-use event listener to the codec
+	 * @param event_name The event type to listen for
+	 * @param callback 
+	 */
+	once(event_name: string, callback: (data: object) => void): void
 	/**
 	 * Removes an event listener from the codec
 	 * @param event_name 
@@ -110,6 +134,13 @@ declare class Codec extends Deletable {
 	 */
 	export_action?: Action
 
+	/**
+	 * List of export option inputs
+	 */
+	export_options: {
+		[key: string]: DialogFormElement
+	}
+
 	/**
 	 * Get a list of all possible extensions of all codecs
 	 */

package/types/cube.d.ts

@@ -80,11 +80,14 @@ declare class Cube extends OutlinerElement {
 
 	static all: Cube[]
 	static selected: Cube[]
+	/**Check if any elements of the type are in the project */
+	static hasAny: () => boolean
+	/**Check if any elements of the type are currently selected */
+	static hasSelected: () => boolean
 }
 
 interface FaceOptions {
 	texture?: Texture
-
 }
 declare class Face {
 	constructor()

package/types/dialog.d.ts

@@ -1,5 +1,5 @@
 interface DialogFormElement {
-	type: 'text' | 'number' | 'range' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info' | 'buttons'
+	type: 'text' | 'number' | 'range' | 'checkbox' | 'select' | 'inline_select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info' | 'buttons'
 	label?: string
 	description?: string
 	nocolon?: boolean
@@ -8,9 +8,22 @@ interface DialogFormElement {
 	readonly?: boolean
 	/** Add buttons to allow copying and sharing the text or link */
 	share_text?: boolean
+	/**
+	 * The default value
+	 */
 	value?: any
+	/**
+	 * The default selected option for 'select', 'inline_select' and 'radio' types. Alias for 'value'
+	 */
+	default?: any
 	placeholder?: string
+	/**
+	 * When using 'text' type, the text to display. Markdown is supported
+	 */
 	text?: string
+	/**
+	 * When using 'range' type, allow users to modify the numeric input
+	 */
 	editable_range_label?: boolean
 	colorpicker?: any
 	min?: number
@@ -19,6 +32,14 @@ interface DialogFormElement {
 	height?: number
 	options?: object
 	buttons?: string[]
+	/**
+	 * Allow users to toggle the entire option on or off
+	 */
+	toggle_enabled?: boolean
+	/**
+	 * Set whether the setting is toggled on or off by default. Requires 'toggle_enabled' field to be set to true
+	 */
+	toggle_default?: boolean
 	click?: (button_index: number) => void
 }
 
@@ -97,6 +118,7 @@ interface DialogOptions {
 	 * Unless set to false, clicking on the darkened area outside of the dialog will cancel the dialog.
 	 */
 	cancel_on_click_outside?: boolean
+	width?: number
 }
 
 declare class Dialog {

package/types/display_mode.d.ts

@@ -1,3 +1,7 @@
+declare const DisplayMode: {
+	slots: string[]
+}
+
 interface DisplaySlotOptions {
 	rotation?: ArrayVector3
 	translation?: ArrayVector3
@@ -5,6 +9,9 @@ interface DisplaySlotOptions {
 	mirror?: [boolean, boolean, boolean]
 }
 
+/**
+ * Display Slots hold the transform values for a specific item slot in the Minecraft Java Edition "Display Mode" feature
+ */
 declare class DisplaySlot {
 	constructor(id: string, data: DisplaySlotOptions)
 	rotation: ArrayVector3

package/types/format.d.ts

@@ -56,6 +56,7 @@ interface FormatOptions {
 	bone_rig?: boolean
 	centered_grid?: boolean
 	rotate_cubes?: boolean
+	stretch_cubes?: boolean
 	integer_size?: boolean
 	meshes?: boolean
 	texture_meshes?: boolean
@@ -108,6 +109,7 @@ declare class ModelFormat extends Deletable {
 	bone_rig: boolean
 	centered_grid: boolean
 	rotate_cubes: boolean
+	stretch_cubes: boolean
 	integer_size: boolean
 	meshes: boolean
 	texture_meshes: boolean

package/types/global.d.ts

@@ -16,11 +16,17 @@ declare global {
 		 * Rounds the input number to N digits
 		 */
 		roundTo(number: number, digits: number): number
+		/**
+		 * Test if the number is between two other numbers
+		 */
 		isBetween(number: number, limit1: number, limit2: number): boolean
 		/**
 		 * Checks if the absolute difference between a and b is smaller than epsilon
 		 */
 		epsilon(a: number, b: number, epsilon: number): boolean
+		/**
+		 * Take a rotation value in degrees, and trim it to a value between -180 and 180, while keeping the same angle
+		 */
 		trimDeg(degrees: number): number
 		isPowerOfTwo(number: number): boolean
 		/***
@@ -32,8 +38,30 @@ declare global {
 		 */
 		randomab(a: number, b: number): number
 		areMultiples(number1: number, number2: number): boolean
+		/**
+		 * Return the next highest power of n
+		 * @param num Power
+		 * @param min Value that the result should be equal to or higher than
+		 */
 		getNextPower(num: number, min: number): number
+		/**
+		 * Snap the value to the closest number in a list of 1 or more snap points
+		 */
 		snapToValues(number: number, snap_points: number[], epsilon: number): number
+		/**
+		 * Get the lerp alpha value of m, between points a and b
+		 */
+		getLerp: (a: number, b: number, m: number) => number
+		/**
+		 * Lerp between a and b using the 0-1 alpha value
+		 */
+		lerp: (a: number, b: number, alpha: number) => number
+		/**
+		 * Return a random integer
+		 */
+		randomInteger: (a: number, b: number) => number
+		hermiteBlend: (input: number) => number
+		clamp: (number: number, min: number, max: number) => number
 	}
 	interface Array<T> {
 		remove(item: any): boolean

package/types/group.d.ts

@@ -23,6 +23,8 @@ declare class Group extends OutlinerNode {
 	constructor (options: Partial<GroupOptions>)
 	static selected: Group
 	static all: Group[]
+	/**Check if any groups are in the project */
+	static hasAny: () => boolean
 
 	name: string
 	children: OutlinerNode[]

package/types/io.d.ts

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