blockbench-types 5.1.0 → 5.2.0-beta.0-next.1

package/custom/menu.d.ts

@@ -1,136 +1,137 @@
-/// <reference types="./blockbench"/>
-interface CustomMenuItem {
-	name: string
-	id?: string
-	icon: IconString | boolean | ((context: any) => (IconString|boolean))
-	color?: string
-	description?: string
-	condition?: ConditionResolvable
-	/**
-	 * 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[] | ((context: any) => MenuItem[])
-	click?(context?: any, event?: Event): void
-}
-type MenuItem = CustomMenuItem | Action | BarSelect<string> | MenuSeparator | string
-interface MenuOptions {
-	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 {
-	/**
-	 * 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 | 'mouse', context?: any): this
-	/**
-	 * Alias for .open()
-	 */
-	show(position: MouseEvent | HTMLElement | 'mouse', 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 | CustomMenuItem, 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 | Action): void
-	/**
-	 * @deprecated
-	 */
-	deleteItem(rm_item: Action): void
-	hover(node: HTMLElement, event: Event, expand?: boolean): void
-	structure: MenuItem[]
-	node: HTMLUListElement
-	static open: Menu | null
-	static closed_in_this_click?: string
-}
-
-declare interface BarMenuOptions {
-	name?: string
-	icon?: IconString
-	condition?: ConditionResolvable
-}
-
-/**
- * Creates a new menu in the menu bar
- */
-declare class BarMenu extends Menu {
-	constructor(id: string, structure: MenuItem[], options?: BarMenuOptions)
-	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
-	}
-	/**
-	 * Add a new menu to the menu bar
-	 * @param menu The BarMenu to add
-	 * @param position Specify the position in the menu list where to add insert the menu. Can either be an index in the list of all menus, or the ID of the menu to insert right from.
-	 */
-	function addMenu(menu: BarMenu, position?: number | string): void
-	/**
-	 * 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
-}
+/// <reference types="./blockbench"/>
+interface CustomMenuItem {
+	name: string
+	id?: string
+	icon: IconString | boolean | ((context: any) => (IconString|boolean))
+	color?: string
+	description?: string
+	condition?: ConditionResolvable
+	/**
+	 * 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[] | ((context: any) => MenuItem[])
+	click?(context?: any, event?: Event): void
+}
+type MenuItem = CustomMenuItem | Action | BarSelect<string> | MenuSeparator | string
+interface MenuOptions {
+	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 {
+	/**
+	 * 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 | 'mouse', context?: any): this
+	/**
+	 * Alias for .open()
+	 */
+	show(position: MouseEvent | HTMLElement | 'mouse', 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 | CustomMenuItem | '_', 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 | Action): void
+	/**
+	 * @deprecated
+	 */
+	deleteItem(rm_item: Action): void
+	hover(node: HTMLElement, event: Event, expand?: boolean): void
+	structure: MenuItem[]
+	node: HTMLUListElement
+	static open: Menu | null
+	static closed_in_this_click?: string
+}
+
+declare interface BarMenuOptions {
+	name?: string
+	icon?: IconString
+	condition?: ConditionResolvable
+}
+
+/**
+ * Creates a new menu in the menu bar
+ */
+declare class BarMenu extends Menu {
+	constructor(id: string, structure: MenuItem[], options?: BarMenuOptions)
+	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 mode_switcher_button: null | HTMLDivElement
+	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
+	}
+	/**
+	 * Add a new menu to the menu bar
+	 * @param menu The BarMenu to add
+	 * @param position Specify the position in the menu list where to add insert the menu. Can either be an index in the list of all menus, or the ID of the menu to insert right from.
+	 */
+	function addMenu(menu: BarMenu, position?: number | string): void
+	/**
+	 * 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/custom/mesh.d.ts

@@ -1,196 +1,196 @@
-/// <reference types="./blockbench"/>
-
-type OccupationMatrix = {
-	[x: number]: {
-		[y: number]: boolean
-	}
-}
-type MeshEdge = [string, string]
-
-type MeshSeamValue = 'auto' | 'divide' | 'join'
-interface MeshOptions {
-	name?: string
-	color?: number
-	visibility?: boolean
-	rotation?: ArrayVector3
-	origin?: ArrayVector3
-	vertices?: {
-		[vkey: string]: ArrayVector3
-	}
-}
-
-interface MeshFaceOptions extends FaceOptions {
-	vertices?: string[]
-	uv?: { [vkey: string]: ArrayVector2 }
-}
-declare class MeshFace extends Face {
-	constructor(mesh: Mesh, data: MeshFaceOptions)
-	/**
-	 * The vertices that make up the face, as vertex keys. The vertices go around the face counter-clockwise when looking at the front side of the face. That also means that reversing the vertex order reverses the face direction.
-	 */
-	vertices: string[]
-	mesh: Mesh
-	uv: {
-		[vertex: string]: ArrayVector2
-	}
-	extend(data: MeshFaceOptions): this
-	/**
-	 * Returns the face normal in mesh space as calculated from the vertex positions
-	 * @param normalize If true, the values will be normalized.
-	 * @param alt_tri On quads, if true, this will return the normal of the second tri instead of the first
-	 */
-	getNormal(normalize: boolean = false, alt_tri?: 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
-	/**
-	 * Get the keys of this face and all faces that are connected with it on the UV map
-	 */
-	getUVIsland(): string[]
-	/**
-	 * Returns the angle between two faces in degrees
-	 */
-	getAngleTo(other_face: MeshFace): number
-	/**
-	 * Inverts the direction of the face
-	 */
-	invert(): void
-	/**
-	 * Returns whether the face is selected
-	 * @param face_key Optional face key of the face, the method runs faster if this is provided
-	 */
-	isSelected(face_key?: string): boolean
-	/**
-	 * Returns true if the face is concave
-	 */
-	isConcave(): boolean
-	/**
-	 * Returns the vertices of a quad in an order that creates a convex quad shape if possible. If the face has less than 4 vertices, it just returns the vertices in original order.
-	 */
-	getSortedVertices(): string[]
-	/**
-	 * Get the adjacent face in the specified side
-	 */
-	getAdjacentFace(
-		side_index: number
-	): { face: MeshFace; key: string; edge: MeshEdge; index: number } | null
-	/**
-	 * Return all edges of the face
-	 */
-	getEdges(): [string, string][]
-	/**
-	 * Returns the face key
-	 */
-	getFaceKey(): string
-	/**
-	 * Takes a UV coordinate and turns it into a 3D space coordinate in local space of the mesh. On quads, the first triangle is used for calculation, so the coordinates on warped quads may be inaccurate.
-	 */
-	UVToLocal(uv: ArrayVector2): THREE.Vector3
-	/**
-	 * Takes a 3D coordinate in local space of the mesh, and turns it into a coordinate on the UV map using barycentric coordinates. On quads, the first triangle is used for calculation, so the coordinates on warped quads may be inaccurate.
-	 */
-	localToUV(vector: THREE.Vector3): ArrayVector2
-	/**
-	 * Get the face center by weight in local space
-	 */
-	getCenter(): ArrayVector3
-}
-
-interface MeshOptions {
-	name?: string
-	color?: number
-	visibility?: boolean
-	shading?: 'flat' | 'smooth'
-	rotation?: ArrayVector3
-	origin?: ArrayVector3
-	vertices?: {
-		[vkey: string]: ArrayVector3
-	}
-}
-declare class Mesh extends OutlinerElement {
-	constructor(options: Partial<MeshOptions>, uuid?: string)
-
-	shading: 'flat' | 'smooth'
-	visibility: boolean
-	color: number
-	origin: ArrayVector3
-	rotation: ArrayVector3
-
-	vertices: {
-		[vkey: string]: ArrayVector3
-	}
-	faces: {
-		[fkey: string]: MeshFace
-	}
-	seams: {
-		[vkey: string]: MeshSeamValue
-	}
-	vertice_list: ArrayVector3[]
-	armature: string
-
-	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
-	 */
-	getSelectedFaces(can_write?: boolean): string[]
-
-	/**
-	 * Get the armature if one is attached to the mesh
-	 */
-	getArmature() : Armature | undefined
-	/**
-	 * Vertex lists of quads are generally in arbitrary order, the order is calculated when calling getSortedVertices() to account for dfiferent face geometries. Calling this method pre-sorts all faces to allow optimizing subsequent processing
-	 */
-	sortAllFaceVertices(): void
-	calculateNormals(): Record<string, ArrayVector3>
-
-	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 {}
+/// <reference types="./blockbench"/>
+
+type OccupationMatrix = {
+	[x: number]: {
+		[y: number]: boolean
+	}
+}
+type MeshEdge = [string, string]
+
+type MeshSeamValue = 'auto' | 'divide' | 'join'
+interface MeshOptions {
+	name?: string
+	color?: number
+	visibility?: boolean
+	rotation?: ArrayVector3
+	origin?: ArrayVector3
+	vertices?: {
+		[vkey: string]: ArrayVector3
+	}
+}
+
+interface MeshFaceOptions extends FaceOptions {
+	vertices?: string[]
+	uv?: { [vkey: string]: ArrayVector2 }
+}
+declare class MeshFace extends Face {
+	constructor(mesh: Mesh, data: MeshFaceOptions)
+	/**
+	 * The vertices that make up the face, as vertex keys. The vertices go around the face counter-clockwise when looking at the front side of the face. That also means that reversing the vertex order reverses the face direction.
+	 */
+	vertices: string[]
+	mesh: Mesh
+	uv: {
+		[vertex: string]: ArrayVector2
+	}
+	extend(data: MeshFaceOptions): this
+	/**
+	 * Returns the face normal in mesh space as calculated from the vertex positions
+	 * @param normalize If true, the values will be normalized.
+	 * @param alt_tri On quads, if true, this will return the normal of the second tri instead of the first
+	 */
+	getNormal(normalize: boolean = false, alt_tri?: 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
+	/**
+	 * Get the keys of this face and all faces that are connected with it on the UV map
+	 */
+	getUVIsland(): string[]
+	/**
+	 * Returns the angle between two faces in degrees
+	 */
+	getAngleTo(other_face: MeshFace): number
+	/**
+	 * Inverts the direction of the face
+	 */
+	invert(): void
+	/**
+	 * Returns whether the face is selected
+	 * @param face_key Optional face key of the face, the method runs faster if this is provided
+	 */
+	isSelected(face_key?: string): boolean
+	/**
+	 * Returns true if the face is concave
+	 */
+	isConcave(): boolean
+	/**
+	 * Returns the vertices of a quad in an order that creates a convex quad shape if possible. If the face has less than 4 vertices, it just returns the vertices in original order.
+	 */
+	getSortedVertices(): string[]
+	/**
+	 * Get the adjacent face in the specified side
+	 */
+	getAdjacentFace(
+		side_index: number
+	): { face: MeshFace; key: string; edge: MeshEdge; index: number } | null
+	/**
+	 * Return all edges of the face
+	 */
+	getEdges(): [string, string][]
+	/**
+	 * Returns the face key
+	 */
+	getFaceKey(): string
+	/**
+	 * Takes a UV coordinate and turns it into a 3D space coordinate in local space of the mesh. On quads, the first triangle is used for calculation, so the coordinates on warped quads may be inaccurate.
+	 */
+	UVToLocal(uv: ArrayVector2): THREE.Vector3
+	/**
+	 * Takes a 3D coordinate in local space of the mesh, and turns it into a coordinate on the UV map using barycentric coordinates. On quads, the first triangle is used for calculation, so the coordinates on warped quads may be inaccurate.
+	 */
+	localToUV(vector: THREE.Vector3): ArrayVector2
+	/**
+	 * Get the face center by weight in local space
+	 */
+	getCenter(): ArrayVector3
+}
+
+interface MeshOptions {
+	name?: string
+	color?: number
+	visibility?: boolean
+	shading?: 'flat' | 'smooth'
+	rotation?: ArrayVector3
+	origin?: ArrayVector3
+	vertices?: {
+		[vkey: string]: ArrayVector3
+	}
+}
+declare class Mesh extends OutlinerElement {
+	constructor(options: Partial<MeshOptions>, uuid?: string)
+
+	shading: 'flat' | 'smooth'
+	visibility: boolean
+	color: number
+	origin: ArrayVector3
+	rotation: ArrayVector3
+
+	vertices: {
+		[vkey: string]: ArrayVector3
+	}
+	faces: {
+		[fkey: string]: MeshFace
+	}
+	seams: {
+		[vkey: string]: MeshSeamValue
+	}
+	vertice_list: ArrayVector3[]
+	armature: string
+
+	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
+	 */
+	getSelectedFaces(can_write?: boolean): string[]
+
+	/**
+	 * Get the armature if one is attached to the mesh
+	 */
+	getArmature() : Armature | undefined
+	/**
+	 * Vertex lists of quads are generally in arbitrary order, the order is calculated when calling getSortedVertices() to account for dfiferent face geometries. Calling this method pre-sorts all faces to allow optimizing subsequent processing
+	 */
+	sortAllFaceVertices(): void
+	calculateNormals(): Record<string, ArrayVector3>
+
+	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 {}