blockbench-types 4.9.0 → 4.10.0

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
+}

package/types/mesh.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./blockbench.d.ts"/>
 type OccupationMatrix = {
 	[x: number]: {
 		[y: number]: boolean
@@ -16,70 +17,10 @@ interface MeshOptions {
 		[vkey: string]: ArrayVector3
 	}
 }
-declare class Mesh extends OutlinerElement {
-	constructor (options: Partial<MeshOptions>, uuid?: string)
-
-	visibility: boolean
-	color: number
-
-	vertices: {
-		[vkey: string]: ArrayVector3
-	}
-	faces: {
-		[fkey: string]: MeshFace
-	}
-	seams: {
-		[vkey: string]: MeshSeamValue
-	}
-
-	extend(options: Partial<MeshOptions>): this
-
-	/**
-	 * Get selected vertices as vertex keys
-	 * @param can_write If true, the array can safely be modified to update the selection
-	 */
-	getSelectedVertices(can_write: boolean): string[]
-	/**
-	 * Get selected edges as vertex key pairs
-	 * @param can_write If true, the array can safely be modified to update the selection
-	 */
-	getSelectedEdges(can_write: boolean): ([string, string])[]
-	/**
-	 * Get selected faces as face keys
-	 * @param can_write If true, the array can safely be modified to update the selection
-	 */
-	getSelectedVertices(can_write: boolean): string[]
-
-	setSeam(edge: MeshEdge, value)
-	getSeam(edge: MeshEdge): MeshSeamValue
-	getWorldCenter(ignore_mesh_selection?: boolean): THREE.Vector3
-	addVertices(...ArrayVector3): string[]
-	addFaces(...MeshFace): string[]
-	extend(data: MeshOptions): void
-	getUndoCopy(aspects?: object): object
-	getSaveCopy(project?: boolean): object
-	getSelectionRotation(): THREE.Euler
-	getCenter(global: boolean): THREE.Vector3
-	forAllFaces(callback: (face: MeshFace, key: string) => void): void
-	transferOrigin(origin: ArrayVector3, update?: boolean): void
-	setColor(color: number): void
-	roll(axis: number, steps: number, origin?: ArrayVector3): void
-	flip(axis: number): void
-	moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
-	resize(val: number, axis: number, negative: boolean, allow_negative: boolean, bidirectional?: boolean): void
-	applyTexture(texture: Texture, faces?: true | undefined | string[]): void
-
-	static all: Mesh[]
-	static selected: Mesh[]
-	/**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 MeshFaceOptions extends FaceOptions {
 	vertices: string[]
-	uv: {[vkey: string]: ArrayVector2}
+	uv: { [vkey: string]: ArrayVector2 }
 }
 declare class MeshFace extends Face {
 	constructor(mesh: Mesh, data: MeshFaceOptions)
@@ -95,11 +36,15 @@ declare class MeshFace extends Face {
 	/**
 	 * Returns the face normal in mesh space as calculated from the vertex positions
 	 */
-	getNormal(normalize): ArrayVector3
+	getNormal(normalize: boolean): ArrayVector3
 	/**
 	 * Calculates which pixels the UV face occupies, and returns them as a map
 	 */
-	getOccupationMatrix(texture_space?: boolean, start_offset?: ArrayVector2, matrix?: OccupationMatrix): OccupationMatrix
+	getOccupationMatrix(
+		texture_space?: boolean,
+		start_offset?: ArrayVector2,
+		matrix?: OccupationMatrix
+	): OccupationMatrix
 	/**
 	 * Get the keys of this face and all faces that are connected with it on the UV map
 	 */
@@ -123,7 +68,9 @@ declare class MeshFace extends Face {
 	/**
 	 * Get the adjacent face in the specified side
 	 */
-	getAdjacentFace(side_index: number): {face: MeshFace, key: string, edge: MeshEdge, index: number} | null
+	getAdjacentFace(
+		side_index: number
+	): { face: MeshFace; key: string; edge: MeshEdge; index: number } | null
 	/**
 	 * Returns the face key
 	 */
@@ -141,3 +88,81 @@ declare class MeshFace extends Face {
 	 */
 	getCenter(): ArrayVector3
 }
+
+interface MeshOptions {
+	name?: string
+	color?: number
+	visibility?: boolean
+	rotation?: ArrayVector3
+	origin?: ArrayVector3
+	vertices?: {
+		[vkey: string]: ArrayVector3
+	}
+}
+declare class Mesh extends OutlinerElement {
+	constructor(options: Partial<MeshOptions>, uuid?: string)
+
+	visibility: boolean
+	color: number
+
+	vertices: {
+		[vkey: string]: ArrayVector3
+	}
+	faces: {
+		[fkey: string]: MeshFace
+	}
+	seams: {
+		[vkey: string]: MeshSeamValue
+	}
+
+	extend(options: Partial<MeshOptions>): this
+
+	/**
+	 * Get selected vertices as vertex keys
+	 * @param can_write If true, the array can safely be modified to update the selection
+	 */
+	getSelectedVertices(can_write: boolean): string[]
+	/**
+	 * Get selected edges as vertex key pairs
+	 * @param can_write If true, the array can safely be modified to update the selection
+	 */
+	getSelectedEdges(can_write: boolean): [string, string][]
+	/**
+	 * Get selected faces as face keys
+	 * @param can_write If true, the array can safely be modified to update the selection
+	 */
+	getSelectedVertices(can_write: boolean): string[]
+
+	setSeam(edge: MeshEdge, value: any): void
+	getSeam(edge: MeshEdge): MeshSeamValue
+	getWorldCenter(ignore_mesh_selection?: boolean): THREE.Vector3
+	addVertices(...ArrayVector3: ArrayVector3[]): string[]
+	addFaces(...MeshFace: MeshFace[]): string[]
+	extend(data: MeshOptions): void
+	getUndoCopy(aspects?: any): any
+	getSelectionRotation(): THREE.Euler
+	getCenter(global: boolean): THREE.Vector3
+	forAllFaces(callback: (face: MeshFace, key: string) => void): void
+	transferOrigin(origin: ArrayVector3, update?: boolean): void
+	setColor(color: number): void
+	roll(axis: number, steps: number, origin?: ArrayVector3): void
+	flip(axis: number): void
+	moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
+	resize(
+		val: number,
+		axis: number,
+		negative: boolean,
+		allow_negative: boolean,
+		bidirectional?: boolean
+	): void
+	applyTexture(texture: Texture, faces?: true | undefined | string[]): void
+
+	static all: Mesh[]
+	static selected: Mesh[]
+	/**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 MeshFaceOptions extends FaceOptions {}

package/types/misc.d.ts

@@ -1,4 +1,4 @@
-
+/// <reference path="./blockbench.d.ts"/>
 
 declare class Deletable {
 	delete(): void
@@ -10,7 +10,8 @@ type UUID = string
  */
 declare const isApp: boolean
 
-type EventName = 'remove_animation'
+type EventName =
+	| 'remove_animation'
 	| 'display_animation_frame'
 	| 'before_closing'
 	| 'create_session'
@@ -47,11 +48,14 @@ type EventName = 'remove_animation'
 	| 'canvas_click'
 	| 'change_texture_path'
 	| 'add_texture'
+	| 'update_texture_selection'
+	| 'init_edit'
 	| 'finish_edit'
 	| 'finished_edit'
 	| 'undo'
 	| 'redo'
 	| 'load_undo_save'
+	| 'create_undo_save'
 	| 'change_color'
 	| 'select_mode'
 	| 'unselect_mode'
@@ -78,44 +82,74 @@ type EventName = 'remove_animation'
 	| 'edit_animation_properties'
 	| 'select_preview_scene'
 	| 'unselect_preview_scene'
+	| 'compile_bedrock_animation_controller_state'
+	| 'select_animation_controller_state'
+	| 'add_animation_controller_animation'
+	| 'add_animation_controller_transition'
+	| 'add_animation_controller_particle'
+	| 'add_animation_controller_sound'
+	| 'compile_bedrock_animation_controller'
+	| 'add_animation_controller'
+	| 'edit_animation_controller_properties'
+	| 'timeline_play'
+	| 'timeline_pause'
+	| 'unselect_interface'
+	| 'reset_layout'
+	| 'update_pressed_modifier_keys'
+	| 'open_bar_menu'
+	| 'unselect_all'
+	| 'quick_save_model'
+	| 'save_editor_state'
+	| 'load_editor_state'
+	| 'select_no_project'
+	| 'flip_node_name'
+	| 'update_scene_shading'
+	| 'edit_layer_properties'
+	| 'select_texture'
+	| 'compile_texture_mcmeta'
 
-type IconString = string;
+type IconString = string
 
 interface MessageBoxOptions {
 	/**
 	 * Index of the confirm button within the buttons array
 	 */
-	confirm: number
+	confirm?: number
 	/**
 	 * Index of the cancel button within the buttons array
 	 */
-	cancel: number
-	buttons: string[]
+	cancel?: number
+	buttons?: string[]
 	translateKey?: string
 	title?: string
 	message?: string
 	icon?: string
-	width: number
+	width?: number
 	/**
 	 * Display a list of actions to do in the dialog. When clicked, the message box closes with the string ID of the command as first argument.
 	 */
 	commands?: {
-		[id: string]: string | {text: string, icon?: IconString, condition?: ConditionResolvable}
+		[id: string]: string | {
+			text: string
+			icon?: IconString
+			condition?: ConditionResolvable
+			description?: string
+		}
 	}
 	/**
 	 * Adds checkboxes to the bottom of the message box
 	 */
-	checkboxes: {
-		[id: string]: string | {
-			value?: boolean
-			condition: ConditionResolvable
-			text: string
-		}
+	checkboxes?: {
+		[id: string]:
+			| string
+			| {
+					value?: boolean
+					condition: ConditionResolvable
+					text: string
+			  }
 	}
 }
 
-
-type PropertyType = 'string' | 'number' | 'enum' | 'molang' | 'boolean' | 'array' | 'instance' | 'vector' | 'vector2'
 interface PropertyOptions {
 	default?: any
 	condition?: ConditionResolvable
@@ -124,44 +158,58 @@ interface PropertyOptions {
 	/**
 	 * Options used for select types
 	 */
-	options?: object
+	options?: any
 	/**
 	 * Enum possible values
 	 */
-	values: string[]
-	merge?: (instance: any, data: object) => void
-	reset?: (instance: any) => void
-	merge_validation?: (value: any) => boolean
+	values?: string[]
+	merge?(instance: any, data: any): void
+	reset?(instance: any): void
+	merge_validation?(value: any): boolean
 }
+
+interface IPropertyType {
+	string: string
+	molang: string
+	number: number
+	boolean: boolean
+	array: any[]
+	object: any
+	instance: any
+	vector: ArrayVector3
+	vector2: ArrayVector2
+}
+
 /**
  * Creates a new property on the specified target class
  */
-declare class Property extends Deletable {
-    constructor(target_class: any, type: PropertyType, name: string, options?: PropertyOptions);
-    class: any;
-    name: string;
-    type: PropertyType;
-	default: any;
-	
-    isString: boolean;
-    isEnum: boolean;
-    isMolang: boolean;
-    isNumber: boolean;
-    isBoolean: boolean;
-    isArray: boolean;
-    isVector: boolean;
-	isVector2: boolean;
-	isInstance: boolean;
-	
+declare class Property<T extends keyof IPropertyType> extends Deletable {
+	constructor(target_class: any, type: T, name: string, options?: PropertyOptions)
+	class: any
+	name: string
+	type: T
+	default: IPropertyType[T]
+	export?: boolean
+
+	isString: boolean
+	isEnum: boolean
+	isMolang: boolean
+	isNumber: boolean
+	isBoolean: boolean
+	isArray: boolean
+	isVector: boolean
+	isVector2: boolean
+	isInstance: boolean
+
 	enum_values?: string[]
-    merge_validation: undefined | ((value: any) => boolean);
-    condition: ConditionResolvable;
-    exposed: boolean;
-    label: any;
-	merge(instance: any, data: object): void
-	reset(instance: any): void
-    getDefault(instance: any): any;
-    copy(instance: any, target: any): void;
+	merge_validation: undefined | ((value: IPropertyType[T]) => boolean)
+	condition: ConditionResolvable
+	exposed: boolean
+	label: any
+	merge(instance: IPropertyType[T], data: IPropertyType[T]): void
+	reset(instance: IPropertyType[T]): void
+	getDefault(instance: IPropertyType[T]): IPropertyType[T]
+	copy(instance: IPropertyType[T], target: IPropertyType[T]): void
 }
 
 declare function updateSelection(): void
@@ -189,5 +237,24 @@ declare namespace Language {
 	 * @param language Two letter language code, e. G. 'en'
 	 * @param strings Object listing the translation keys and values
 	 */
-	function addTranslations(language: string, strings: {[key: string]: string})
+	function addTranslations(language: string, strings: { [key: string]: string }): void
+}
+
+interface Object {
+	boneConfig: Record<string, Property<any> | undefined>
+}
+
+declare var LZUTF8: any
+
+interface ToastNotificationOptions {
+	text: string
+	icon?: string
+	expire?: number
+	color?: string
+	click?: () => boolean
 }
+declare namespace Blockbench {
+	function showToastNotification(options: ToastNotificationOptions): Deletable
+}
+
+declare function unselectAllElements(): void

package/types/mode.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="./blockbench.d.ts"/>
+
 interface ModeOptions {
 	name: string
 	default_tool?: string
@@ -16,6 +18,8 @@ interface ModeOptions {
 }
 declare class Mode extends KeybindItem {
 	constructor(id: string, options: ModeOptions)
+	id: string
+	name: string
 
 	/**Selects the mode */
 	select(): void
@@ -24,12 +28,21 @@ declare class Mode extends KeybindItem {
 	/**Activates the mode */
 	trigger(): void
 
+	onSelect?(): void
+
+	onUnselect?(): void
+
 	static selected: Mode
 }
 
 declare namespace Modes {
 	const options: {
 		[id: string]: Mode
+		animate: Mode
+		display: Mode
+		edit: Mode
+		paint: Mode
+		pose: Mode
 	}
-	const selected: Mode;
+	let selected: Mode | false | undefined
 }

package/types/molang.d.ts

@@ -0,0 +1,17 @@
+declare class Molang {
+	parse(expression: string | number, variables?: Record<string, number>): number
+	global_variables: Record<string, string | number | ((...args: number[]) => number)>
+	variableHandler: (variable: string, variables?: Record<string, number>) => number
+}
+
+declare interface MolangExpression {
+	animation: _Animation
+	animator: BoneAnimator
+	channel: string
+	key: string
+	kf: _Keyframe
+	type: string
+	value: string
+}
+
+declare function getAllMolangExpressions(): MolangExpression[]