blockbench-types 5.0.0-beta.1 → 5.0.0-beta.3

package/custom/action.d.ts

@@ -1,7 +1,7 @@
 /**
  * Registry of all toolbar items, such as actions, tools, etc.
  */
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 import tinycolor from 'tinycolor2'
 
@@ -486,6 +486,7 @@ declare global {
 			max?: number
 			interval?: number
 			step?: number
+			show_bar?: boolean
 		}
 		/**
 		 * Define a tool setting key under which the value of the slider is saved on the selected tool

package/custom/animation.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 declare class AnimationItem {
 	static all: _Animation[]

package/custom/animation_controller.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 type StateAnimationInput =
 	| string

package/custom/blockbench.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="vue" />
-/// <reference types="./three" />
+/// <reference types="./libs" />
 /// <reference types="@types/prismjs" />
 /// <reference types="@types/jquery" />
 /// <reference types="wintersky" />
@@ -21,6 +21,7 @@
 /// <reference types="./keyframe" />
 /// <reference types="./menu" />
 /// <reference types="./mesh" />
+/// <reference types="./spline_mesh" />
 /// <reference types="./misc" />
 /// <reference types="./molang" />
 /// <reference types="./outliner" />
@@ -43,6 +44,7 @@
 /// <reference types="./canvas_frame" />
 /// <reference types="./io" />
 /// <reference types="./native_apis" />
+/// <reference types="./util/VersionUtil" />
 
 /**
  * Provides access to global Javascript/DOM variables that are overwritten by Blockbench's own variables

package/custom/canvas.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 interface UpdateViewOptions {
 	/**
 	 * List of elements to update
@@ -67,6 +67,7 @@ declare namespace Canvas {
 	const emptyMaterials: {
 		[uuid: UUID]: THREE.Material
 	}
+	const coloredSolidMaterials: THREE.ShaderMaterial[]
 	const meshes: {
 		[uuid: UUID]: THREE.Mesh
 	}
@@ -181,7 +182,7 @@ declare namespace Canvas {
 	/**
 	 * Update the hierarchy and position of all bones
 	 */
-	function updateAllBones(): void
+	function updateAllBones(bones?: OutlinerNode[]): void
 	/**
 	 * Update the position of the origin / pivot point gizmo
 	 */
@@ -264,6 +265,7 @@ interface NodePreviewControllerOptions {
 	updateFaces?(element: OutlinerNode): void
 	updatePaintingGrid?(element: OutlinerNode): void
 	updateHighlight?(element: OutlinerNode, ...args: any[]): void
+	[key: string]: any
 }
 declare class NodePreviewController {
 	constructor(

package/custom/codec.d.ts

@@ -1,9 +1,14 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
+interface LoadOptions {
+	import_to_current_project?: boolean
+	externalDataLoader?: (path: string) => any
+	[key: string]: unknown
+}
 interface CodecOptions {
 	name: string
-	load?(model: any, file: FileResult, add?: boolean): void
+	load?(model: any, file: FileResult, args?: LoadOptions): void
 	compile?(options?: any): string | ArrayBuffer | any
-	parse?(data: any, path: string, add?: boolean): void
+	parse?(data: any, path: string, args?: LoadOptions): void
 	export?(): void
 	/**
 	 * Generate a file name to suggest when exporting
@@ -63,7 +68,7 @@ declare class Codec extends Deletable {
 	 * @param file
 	 * @param add
 	 */
-	load(model: any, file?: any, add?: boolean): void
+	load(model: any, file?: any, args?: LoadOptions): void
 	/**
 	 * Compiles the file content
 	 * @param options
@@ -74,7 +79,7 @@ declare class Codec extends Deletable {
 	 * @param data File content
 	 * @param path File path
 	 */
-	parse?(data: any, path: string, add?: boolean): void
+	parse?(data: any, path: string, args?: LoadOptions): void
 	/**
 	 * Opens the file browser to export a file of this type
 	 */

package/custom/cube.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 type CardinalDirection = 'north' | 'south' | 'east' | 'west' | 'up' | 'down'
 
 interface ICubeOptions {
@@ -13,6 +13,7 @@ interface ICubeOptions {
 	to?: ArrayVector3
 	rotation?: ArrayVector3
 	origin?: ArrayVector3
+	stretch?: ArrayVector3
 	box_uv?: boolean
 	/**
 	 * UV position for box UV mode
@@ -54,6 +55,7 @@ declare class Cube extends OutlinerElement {
 	to: ArrayVector3
 	rotation: ArrayVector3
 	origin: ArrayVector3
+	stretch: ArrayVector3
 	faces: {
 		[fkey: string]: CubeFace
 	}
@@ -72,9 +74,13 @@ declare class Cube extends OutlinerElement {
 
 	extend(options: ICubeOptions): this
 	/**
-	 * Calculates and returns the size of a cube across a certain axis. If the axis argument is omitted, it returns all sizes as an array vector.
+	 * Calculates and returns the size of the cube
 	 */
-	size(axis?: number, floored?: boolean): number | ArrayVector3
+	size(): ArrayVector3
+	/**
+	 * Calculates and returns the size of a cube on a certain axis
+	 */
+	size(axis: number, floored?: boolean): number
 	rotationAxis(): string
 	getUndoCopy(aspects?: any): void
 	getSaveCopy(project?: boolean): Cube
@@ -116,7 +122,7 @@ declare class Cube extends OutlinerElement {
 }
 
 interface FaceOptions {
-	texture?: Texture
+	texture?: Texture | UUID | false
 }
 declare class Face {
 	constructor()

package/custom/desktop.d.ts

@@ -49,20 +49,24 @@ type ScopedFS = Pick<typeof import("node:fs"),
 		"stat"
 	>
 }
-declare function requireNativeModule(module: 'fs', options?: {scope?: string, message?: string}): ScopedFS | undefined
-declare function requireNativeModule(module: 'path', options?: {message?: string}): typeof import("node:path");
-declare function requireNativeModule(module: 'crypto', options?: {message?: string}): typeof import("node:crypto");
-declare function requireNativeModule(module: 'events', options?: {message?: string}): typeof import("node:events");
-declare function requireNativeModule(module: 'zlib', options?: {message?: string}): typeof import("node:zlib");
-declare function requireNativeModule(module: 'timers', options?: {message?: string}): typeof import("node:timers");
-declare function requireNativeModule(module: 'url', options?: {message?: string}): typeof import("node:url");
-declare function requireNativeModule(module: 'string_decoder', options?: {message?: string}): typeof import("node:string_decoder");
-declare function requireNativeModule(module: 'querystring', options?: {message?: string}): typeof import("node:querystring");
-declare function requireNativeModule(module: 'child_process', options?: {message?: string}): (typeof import("node:child_process")) | undefined;
-declare function requireNativeModule(module: 'electron', options?: {message?: string}): (typeof import("node:electron")) | undefined;
-declare function requireNativeModule(module: 'https', options?: {message?: string}): (typeof import("node:https")) | undefined;
-declare function requireNativeModule(module: 'net', options?: {message?: string}): (typeof import("node:net")) | undefined;
-declare function requireNativeModule(module: 'tls', options?: {message?: string}): (typeof import("node:tls")) | undefined;
-declare function requireNativeModule(module: 'util', options?: {message?: string}): (typeof import("node:util")) | undefined;
-declare function requireNativeModule(module: 'os', options?: {message?: string}): (typeof import("node:os")) | undefined;
-declare function requireNativeModule(module: 'v8', options?: {message?: string}): (typeof import("node:v8")) | undefined;
+interface RequireDialogOptions {
+	message?: string
+	optional?: boolean
+}
+declare function requireNativeModule(module: 'fs', options?: {scope?: string} & RequireDialogOptions): ScopedFS | undefined
+declare function requireNativeModule(module: 'path'): typeof import("node:path");
+declare function requireNativeModule(module: 'crypto'): typeof import("node:crypto");
+declare function requireNativeModule(module: 'events'): typeof import("node:events");
+declare function requireNativeModule(module: 'zlib'): typeof import("node:zlib");
+declare function requireNativeModule(module: 'timers'): typeof import("node:timers");
+declare function requireNativeModule(module: 'url'): typeof import("node:url");
+declare function requireNativeModule(module: 'string_decoder'): typeof import("node:string_decoder");
+declare function requireNativeModule(module: 'querystring'): typeof import("node:querystring");
+declare function requireNativeModule(module: 'child_process', options?: RequireDialogOptions): (typeof import("node:child_process")) | undefined;
+declare function requireNativeModule(module: 'electron', options?: RequireDialogOptions): (typeof import("node:electron")) | undefined;
+declare function requireNativeModule(module: 'https', options?: RequireDialogOptions): (typeof import("node:https")) | undefined;
+declare function requireNativeModule(module: 'net', options?: RequireDialogOptions): (typeof import("node:net")) | undefined;
+declare function requireNativeModule(module: 'tls', options?: RequireDialogOptions): (typeof import("node:tls")) | undefined;
+declare function requireNativeModule(module: 'util', options?: RequireDialogOptions): (typeof import("node:util")) | undefined;
+declare function requireNativeModule(module: 'os', options?: RequireDialogOptions): (typeof import("node:os")) | undefined;
+declare function requireNativeModule(module: 'v8', options?: RequireDialogOptions): (typeof import("node:v8")) | undefined;

package/custom/display_mode.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 declare const DisplayMode: {
 	slots: string[]
 }

package/custom/global.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 declare global {
 	// const Prism: typeof import('prismjs')

package/custom/group.d.ts

@@ -24,11 +24,10 @@ interface GroupOptions {
 declare class Group extends OutlinerNode {
 	constructor(options: Partial<GroupOptions> | string)
 	/**
-	 * Returns the first selected group.
-	 * In the future this will return an array of selected groups instead.
-	 * @deprecated Use {@link Group.multi_selected} instead!
+	 * Returns the selected groups
+	 * @Note This only includes directly selected groups, not groups that are selected because the parent is selected
 	 */
-	static selected: Group | undefined
+	static selected: Group[]
 	/**
 	 * The first group in {@link Group.multi_selected}
 	 */

package/custom/interface.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 interface ResizeLineOptions {
 	condition?: ConditionResolvable

package/custom/keyframe.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 interface KeyframeDataPointData {
 	[key: string]: any
@@ -27,6 +27,7 @@ interface KeyframeOptions {
 	bezier_right_value?: ArrayVector3
 }
 type axisLetter = 'x' | 'y' | 'z'
+type axisNumber = 0 | 1 | 2
 
 declare class _Keyframe {
 	constructor(options: KeyframeOptions, uuid: any)
@@ -38,7 +39,7 @@ declare class _Keyframe {
 	uuid: string
 	color: number
 	uniform: boolean
-	interpolation: 'linear' | 'catmullrom' | 'bezier' | 'step'
+	interpolation: 'linear' | 'catmullrom' | 'bezier' | 'step' | string
 	cooldown?: boolean
 	bezier_linked: boolean
 	bezier_left_time: ArrayVector3

package/custom/menu.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 interface CustomMenuItem {
 	name: string
 	id?: string

package/custom/mesh.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 type OccupationMatrix = {
 	[x: number]: {
 		[y: number]: boolean
@@ -32,7 +32,7 @@ declare class MeshFace extends Face {
 	uv: {
 		[vertex: string]: ArrayVector2
 	}
-	extend(data: MeshFaceOptions): void
+	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.
@@ -99,6 +99,7 @@ interface MeshOptions {
 	name?: string
 	color?: number
 	visibility?: boolean
+	shading?: 'flat' | 'smooth'
 	rotation?: ArrayVector3
 	origin?: ArrayVector3
 	vertices?: {
@@ -108,8 +109,11 @@ interface MeshOptions {
 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
@@ -138,7 +142,7 @@ declare class Mesh extends OutlinerElement {
 	 * 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[]
+	getSelectedFaces(can_write?: boolean): string[]
 
 	/**
 	 * Get the armature if one is attached to the mesh
@@ -148,6 +152,7 @@ declare class Mesh extends OutlinerElement {
 	 * 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

package/custom/misc.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 
 declare class Deletable {
 	/**
@@ -33,6 +33,8 @@ type EventName =
 	| 'user_joins_session'
 	| 'user_leaves_session'
 	| 'process_chat_message'
+	| 'loaded_plugin'
+	| 'unloaded_plugin'
 	| 'update_settings'
 	| 'update_project_settings'
 	| 'save_project'
@@ -47,6 +49,7 @@ type EventName =
 	| 'add_group'
 	| 'add_texture_mesh'
 	| 'add_armature'
+	| 'add_armature_bone'
 	| 'group_elements'
 	| 'update_selection'
 	| 'compile_bedrock_animations'
@@ -124,105 +127,10 @@ type EventName =
 
 type IconString = string
 
-
-
-interface PropertyOptions {
-	default?: any
-	condition?: ConditionResolvable
-	exposed?: boolean
-	label?: string
-	/**
-	 * Options used for select types
-	 */
-	options?: any
-	/**
-	 * Enum possible values
-	 */
-	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<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: IPropertyType[T]) => boolean)
-	condition: ConditionResolvable
-	exposed: boolean
-	label: any
-	inputs?: 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
-
-	static resetUniqueValues(type: any, instance: any): void
-}
+declare const osfs: '\\' | '/';
 
 declare function updateSelection(): void
 
-/**
- * Returns a translated string in the current language
- * @param key Translation key
- * @param arguments Array of arguments that replace anchors (%0, etc.) in the translation. Items can be strings or anything that can be converted to strings
- */
-declare function tl(key: string, arguments?: any[]): string
-
-declare namespace Language {
-	/**
-	 * Translation data for the current language
-	 */
-	const data: {
-		[key: string]: string
-	}
-	/**
-	 * Language code indicating the currently selected language
-	 */
-	const code: string
-	/**
-	 * Add translations for custom translation strings
-	 * @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 }): void
-}
-
-interface Object {
-	boneConfig: Record<string, Property<any> | undefined>
-}
-
 declare var LZUTF8: any
 
 declare function unselectAllElements(): void
@@ -240,6 +148,9 @@ declare const Pressing: {
 	}
 }
 
+declare function updateCubeHighlights(hover_cube: Cube, force_off: boolean): void
+declare function getRescalingFactor(angle: number): number
+
 declare function isStringNumber(value: any): boolean
 
 declare function marked(text: string): string

package/custom/outliner.d.ts

@@ -1,7 +1,12 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 type ArrayVector4 = [number, number, number, number]
 type ArrayVector3 = [number, number, number]
 type ArrayVector2 = [number, number]
+declare interface OutlinerNodeParentTraits {
+	children: OutlinerNode[]
+	openUp(): void
+	isOpen: boolean
+}
 
 declare const elements: OutlinerNode[]
 /**
@@ -15,16 +20,19 @@ declare class OutlinerNode {
 	uuid: UUID
 	export: boolean
 	locked: boolean
-	parent?: Group | 'root'
+	parent?: (OutlinerNode & OutlinerNodeParentTraits) | 'root'
+	selected: boolean
 	menu?: Menu
 
 	public preview_controller: NodePreviewController
 	static preview_controller: NodePreviewController
+	readonly scene_object: THREE.Object3D
 
 	/**
 	 * Initializes the node. This should always be called when creating nodes that will be used in the outliner.
 	 */
 	init(): this
+	extend(data: any): void
 	addTo(target?: OutlinerNode | 'root'): this
 	sortInBefore(target?: OutlinerNode, index_modifier?: number): this
 	select(event?: any, isOutlinerClick?: boolean): this
@@ -66,6 +74,11 @@ declare class OutlinerNode {
 	getSaveCopy?(...args: any[]): Record<string, any>
 	sanitizeName(): string
 
+	getTypeBehavior(flag: string): boolean | string | any
+
+	static addBehaviorOverride(override_options: {condition: ConditionResolvable, behavior: Record<string, any>}): Deletable
+	static behavior_overrides = [];
+
 	static uuids: {
 		[uuid: UUID]: OutlinerNode
 	}
@@ -79,6 +92,7 @@ declare class OutlinerElement extends OutlinerNode {
 
 	constructor(data: any, uuid: string)
 	selected: boolean
+	allow_mirror_modeling?: boolean
 	mesh: THREE.Object3D | THREE.Mesh
 	static fromSave(data: any, keep_uuid?: boolean): OutlinerElement
 	static isParent: false
@@ -183,6 +197,7 @@ interface OutlinerToggle {
 
 declare namespace Outliner {
 	const root: OutlinerNode[]
+	const ROOT: 'root'
 	const elements: OutlinerElement[]
 	const selected: OutlinerElement[]
 	let control_menu_group: MenuItem[]
@@ -194,7 +209,9 @@ declare namespace Outliner {
 		shade: OutlinerToggle
 		visibility: OutlinerToggle
 		[id: string]: OutlinerToggle
-	}
+	};
+	function toJSON(): []
+	function loadJSON(array: [], add_to_project?: boolean): void;
 }
 
 declare const markerColors: {

package/custom/painter.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 /**
  * A global namespace containing various functionality for Blockbench's 2D and 3D paint tools and texture editor
  */

package/custom/preview.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 interface AnglePreset {
 	position: ArrayVector3
 	target?: ArrayVector3

package/custom/preview_scene.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 interface PreviewModelCubeTemplate {
 	position: ArrayVector3
 	size: ArrayVector3

package/custom/project.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 interface ModelProjectOptions {
 	format: ModelFormat
 }

package/custom/screencam.d.ts

@@ -1,4 +1,4 @@
-/// <reference path="./blockbench.d.ts"/>
+/// <reference types="./blockbench"/>
 interface ScreenshotOptions {
 	crop?: boolean
 	width?: number