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

package/custom/painter.d.ts

@@ -1,69 +1,70 @@
-/// <reference types="./blockbench"/>
-/**
- * A global namespace containing various functionality for Blockbench's 2D and 3D paint tools and texture editor
- */
-declare namespace Painter {
-	const currentPixel: ArrayVector2
-	const brushChanges: boolean
-	let current: any
-	const selection: any
-	const mirror_painting: boolean
-	const lock_alpha: boolean
-	const erase_mode: boolean
-	const default_brush_presets: any[]
-
-	function edit(
-		texture: Texture,
-		callback: (canvas: HTMLCanvasElement) => void,
-		options: TextureEditOptions
-	): void
-	function setAlphaMatrix(texture: Texture, x: number, y: number, val: number): void
-	function getAlphaMatrix(texture: Texture, x: number, y: number): number
-
-	function combineColors(base: RGBAColor, added: RGBAColor, opacity: number): RGBAColor
-	function blendColors(
-		base: RGBAColor,
-		added: RGBAColor,
-		opacity: number,
-		blend_mode: string
-	): RGBAColor
-	function getMirrorElement(element: OutlinerElement, symmetry_axes: number[]): void
-	function updateNslideValues(): void
-	function getBlendModeCompositeOperation(): string
-	function getCanvas(texture: Texture): HTMLCanvasElement
-	function scanCanvas(
-		ctx: CanvasRenderingContext2D,
-		x: number,
-		y: number,
-		w: number,
-		h: number,
-		cb: ((px: number, py: number, color: [r: number, g: number, b: number, a: number]) => [number, number, number, number] | void)
-	): void
-	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): void
-	function modifyCanvasSection(
-		ctx: CanvasRenderingContext2D,
-		x: number,
-		y: number,
-		w: number,
-		h: number,
-		cb: () => void
-	): void
-	function editCircle(
-		ctx: CanvasRenderingContext2D,
-		x: number,
-		y: number,
-		r: number,
-		softness: number,
-		editPx: (RGBAColor: any, opacity: number, px: number, py: number) => RGBAColor
-	): void
-	function editSquare(
-		ctx: CanvasRenderingContext2D,
-		x: number,
-		y: number,
-		r: number,
-		softness: number,
-		editPx: (RGBAColor: any, opacity: number, px: number, py: number) => RGBAColor
-	): void
-	function openBrushOptions(): void
-	function loadBrushPreset(preset: any): void
-}
+/// <reference types="./blockbench"/>
+/**
+ * A global namespace containing various functionality for Blockbench's 2D and 3D paint tools and texture editor
+ */
+declare namespace Painter {
+	const currentPixel: ArrayVector2
+	const brushChanges: boolean
+	let current: any
+	const selection: any
+	const mirror_painting: boolean
+	const lock_alpha: boolean
+	const erase_mode: boolean
+	const default_brush_presets: any[]
+
+	function edit(
+		texture: Texture,
+		callback: (canvas: HTMLCanvasElement) => void,
+		options: TextureEditOptions
+	): void
+	function setAlphaMatrix(texture: Texture, x: number, y: number, val: number): void
+	function getAlphaMatrix(texture: Texture, x: number, y: number): number
+
+	function combineColors(base: RGBAColor, added: RGBAColor, opacity: number): RGBAColor
+	function blendColors(
+		base: RGBAColor,
+		added: RGBAColor,
+		opacity: number,
+		blend_mode: string
+	): RGBAColor
+	function getMirrorElement(element: OutlinerElement, symmetry_axes: number[]): void
+	function updateNslideValues(): void
+	function getBlendModeCompositeOperation(blend_mode?: string): string
+	function getCanvas(texture: Texture): HTMLCanvasElement
+	function copyCanvas(original_canvas: HTMLCanvasElement): HTMLCanvasElement
+	function scanCanvas(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		w: number,
+		h: number,
+		cb: ((px: number, py: number, color: [r: number, g: number, b: number, a: number]) => [number, number, number, number] | void)
+	): void
+	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): void
+	function modifyCanvasSection(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		w: number,
+		h: number,
+		cb: () => void
+	): void
+	function editCircle(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		r: number,
+		softness: number,
+		editPx: (RGBAColor: any, opacity: number, px: number, py: number) => RGBAColor
+	): void
+	function editSquare(
+		ctx: CanvasRenderingContext2D,
+		x: number,
+		y: number,
+		r: number,
+		softness: number,
+		editPx: (RGBAColor: any, opacity: number, px: number, py: number) => RGBAColor
+	): void
+	function openBrushOptions(): void
+	function loadBrushPreset(preset: any): void
+}

package/custom/preview.d.ts

@@ -1,137 +1,147 @@
-/// <reference types="./blockbench"/>
-interface AnglePreset {
-	position: ArrayVector3
-	target?: ArrayVector3
-	rotation?: ArrayVector3
-	projection: 'unset' | 'orthographic' | 'perspective'
-	zoom?: number
-	focal_length?: number
-	fov?: number
-	aspect_ratio?: number
-	lockedAngle?: number
-}
-
-interface PreviewOptions {
-	id: string
-	antialias?: boolean
-}
-
-type RaycastResult = {
-	type: 'element' | 'keyframe' | 'vertex' | 'cube' | 'line' | 'none'
-	event: PointerEvent | MouseEvent | TouchEvent
-	cube?: Cube
-	intersects?: any[]
-	face?: string
-	vertex?: any
-	keyframe?: _Keyframe
-	element?: OutlinerElement
-}
-
-type SplitScreenMode = 'single'|'double_horizontal'|'double_vertical'|'quad'|'triple_left'|'triple_right'|'triple_top'|'triple_bottom'
-
-/**
- * Previews are 3D viewports, that can either be used as a viewport for the user, or as an offscreen view to record media.
- */
-declare class Preview extends Deletable {
-	constructor(options: PreviewOptions)
-
-	id: string
-	canvas: HTMLCanvasElement
-	height: number
-	width: number
-	aspect_ratio?: number
-	node: HTMLElement
-	label: HTMLLabelElement
-	/**
-	 * True if the preview is in orthographic camera mode
-	 */
-	isOrtho: boolean
-	/**
-	 * Angle, when in a specific side view
-	 */
-	angle: null | number
-	default_angle?: AnglePreset
-	readonly camera: THREE.PerspectiveCamera | THREE.OrthographicCamera
-	camPers: THREE.PerspectiveCamera
-	camOrtho: THREE.OrthographicCamera
-	controls: any
-	annotations: any
-	renderer: THREE.WebGLRenderer
-	background: {
-		name: string
-		image: any
-		size: number
-		x: number
-		y: number
-		lock: boolean
-	}
-	raycaster: THREE.Raycaster
-
-	mouse: THREE.Vector2
-
-	split_screen: {
-		before: undefined | null
-		enabled: boolean
-		lazyLoadPreview: () => void
-		mode: string
-		previews: Preview[]
-		setMode(mode: string): void
-		updateSize(): void
-	}
-
-	raycast(event: MouseEvent): false | RaycastResult
-	render(): void
-	setProjectionMode(orthographic: boolean): this
-	setFOV(fov: number): void
-	setLockedAngle(angle: number): this
-
-	loadAnglePreset(angle_preset: AnglePreset): this
-	/**
-	 * Opens a dialog to create and save a new angle preset
-	 */
-	newAnglePreset(): this
-
-	getFacingDirection(): 'north' | 'south' | 'east' | 'west'
-	getFacingHeight(): 'up' | 'middle' | 'down'
-
-	occupyTransformer(): this
-	showContextMenu(event: Event | HTMLElement): this
-	loadBackground(): void
-
-	/**
-	 * List of all previews
-	 */
-	static all: Preview[]
-	/**
-	 * The last used preview
-	 */
-	static selected: Preview
-
-	/**
-	 * Utility regarding split screen preview mode
-	 */
-	static split_screen: {
-		/**
-		 * Whether the split screen is enabled
-		 */
-		enabled: boolean
-		/**
-		 * The current split screen mode
-		 */
-		mode: SplitScreenMode
-		previews: Preview[]
-		lazyLoadPreview(index: number, camera_preset): Preview
-		/**
-		 * Set a split screen mode
-		 */
-		setMode(mode: SplitScreenMode = 'single')
-		/**
-		 * Update the size of the split screens
-		 */
-		updateSize()
-	}
-}
-
-declare const DefaultCameraPresets: AnglePreset[]
-
-declare function animate(): void
+/// <reference types="./blockbench"/>
+interface AnglePreset {
+	position: ArrayVector3
+	target?: ArrayVector3
+	rotation?: ArrayVector3
+	projection: 'unset' | 'orthographic' | 'perspective'
+	zoom?: number
+	focal_length?: number
+	fov?: number
+	aspect_ratio?: number
+	lockedAngle?: number
+}
+
+interface PreviewOptions {
+	id: string
+	antialias?: boolean
+}
+
+type RaycastResult = {
+	type: 'element' | 'keyframe' | 'vertex' | 'cube' | 'line' | 'none'
+	event: PointerEvent | MouseEvent | TouchEvent
+	cube?: Cube
+	intersects?: any[]
+	face?: string
+	vertex?: any
+	keyframe?: _Keyframe
+	element?: OutlinerElement
+}
+
+type SplitScreenMode = 'single'|'double_horizontal'|'double_vertical'|'quad'|'triple_left'|'triple_right'|'triple_top'|'triple_bottom'
+
+/**
+ * Previews are 3D viewports, that can either be used as a viewport for the user, or as an offscreen view to record media.
+ */
+declare class Preview extends Deletable {
+	constructor(options: PreviewOptions)
+
+	id: string
+	canvas: HTMLCanvasElement
+	height: number
+	width: number
+	aspect_ratio?: number
+	node: HTMLElement
+	label: HTMLLabelElement
+	/**
+	 * True if the preview is in orthographic camera mode
+	 */
+	isOrtho: boolean
+	/**
+	 * Angle, when in a specific side view
+	 */
+	angle: null | number
+	default_angle?: AnglePreset
+	readonly camera: THREE.PerspectiveCamera | THREE.OrthographicCamera
+	camPers: THREE.PerspectiveCamera
+	camOrtho: THREE.OrthographicCamera
+	controls: any
+	annotations: any
+	renderer: THREE.WebGLRenderer
+	background: {
+		name: string
+		image: any
+		size: number
+		x: number
+		y: number
+		lock: boolean
+	}
+	raycaster: THREE.Raycaster
+
+	mouse: THREE.Vector2
+
+	split_screen: {
+		before: undefined | null
+		enabled: boolean
+		lazyLoadPreview: () => void
+		mode: string
+		previews: Preview[]
+		setMode(mode: string): void
+		updateSize(): void
+	}
+
+	raycast(event: MouseEvent): false | RaycastResult
+	render(): void
+	/**
+	 * Set a size of the preview in pixels. With no arguments, and if the preview node is connected to the DOM, it will adjust to the size of the parent element
+	 */
+	resize(width?: number, height?: number): void
+	setProjectionMode(orthographic: boolean): this
+	setFOV(fov: number): void
+	setLockedAngle(angle: number): this
+
+	loadAnglePreset(angle_preset: AnglePreset): this
+	/**
+	 * Opens a dialog to create and save a new angle preset
+	 */
+	newAnglePreset(): this
+
+	getFacingDirection(): 'north' | 'south' | 'east' | 'west'
+	getFacingHeight(): 'up' | 'middle' | 'down'
+
+	occupyTransformer(): this
+	showContextMenu(event: Event | HTMLElement): this
+	loadBackground(): void
+	/**
+	 * Take a screenshot of the current view of the preview
+	 */
+	screenshot(options: ScreenshotOptions, callback: ScreenshotReturn): void
+
+	/**
+	 * List of all previews
+	 */
+	static all: Preview[]
+	/**
+	 * The last used preview
+	 */
+	static selected: Preview
+
+	/**
+	 * Utility regarding split screen preview mode
+	 */
+	static split_screen: {
+		/**
+		 * Whether the split screen is enabled
+		 */
+		enabled: boolean
+		/**
+		 * The current split screen mode
+		 */
+		mode: SplitScreenMode
+		previews: Preview[]
+		lazyLoadPreview(index: number, camera_preset): Preview
+		/**
+		 * Set a split screen mode
+		 */
+		setMode(mode: SplitScreenMode = 'single')
+		/**
+		 * Update the size of the split screens
+		 */
+		updateSize()
+	}
+}
+
+declare const DefaultCameraPresets: AnglePreset[]
+
+declare const MediaPreview: Preview
+
+declare function animate(): void

package/custom/preview_scene.d.ts

@@ -1,120 +1,120 @@
-/// <reference types="./blockbench"/>
-interface PreviewModelCubeTemplate {
-	position: ArrayVector3
-	size: ArrayVector3
-	origin?: ArrayVector3
-	rotation?: ArrayVector3
-	faces: {
-		north?: { uv: ArrayVector4 }
-		east?: { uv: ArrayVector4 }
-		west?: { uv: ArrayVector4 }
-		south?: { uv: ArrayVector4 }
-		up?: { uv: ArrayVector4 }
-		down?: { uv: ArrayVector4 }
-	}
-}
-
-interface PreviewModelOptions {
-	condition?: ConditionResolvable
-	cubes: PreviewModelCubeTemplate[]
-	/**
-	 * Source of the model's texture
-	 */
-	texture?: string
-	/**
-	 * Model tint color
-	 */
-	color?: string
-	/**
-	 * Enable shading on the material
-	 */
-	shading?: boolean
-	/**
-	 * THREE.JS material render side
-	 */
-	render_side?: number
-	texture_size?: [number, number]
-	onUpdate?(): void
-}
-
-declare class PreviewModel extends Deletable {
-	constructor(id: string, options: PreviewModelOptions)
-
-	static models: {
-		[id: string]: PreviewModel
-	}
-	static getActiveModels(): PreviewModel[]
-
-	id: string
-	model_3d: THREE.Object3D
-	cubes: PreviewModelCubeTemplate[]
-	texture?: string
-	color?: string
-	shading: boolean
-	render_side: number
-	texture_size: [number, number]
-	onUpdate?: () => void
-	/**
-	 * Enables the model in the preview
-	 */
-	enable(): void
-	/**
-	 * Disables the model in the preview
-	 */
-	disable(): boolean
-	/**
-	 * Update the appearance and visibility of the model
-	 */
-	update(): void
-	buildModel(): void
-}
-
-interface PreviewSceneOptions {
-	name?: string
-	description?: string
-	category?: string
-	light_color?: string
-	light_side?: number
-	condition?: ConditionResolvable
-	preview_models?: string[]
-}
-
-declare class PreviewScene extends Deletable {
-	constructor(id: string, options: PreviewSceneOptions)
-
-	/**
-	 * All preview scenes, listed by ID
-	 */
-	static scenes: Record<string, PreviewScene>
-	/**
-	 * The currently active scene
-	 */
-	static active: PreviewScene | null
-	/**
-	 * The URL to the source repository that scenes are pulled from
-	 */
-	static source_repository: string
-	static menu_categories: {
-		[category_id: string]: {
-			[id: string]: string
-		}
-	}
-
-	id: string
-	name: string
-	description: string
-	category?: string
-	light_color: string
-	light_side: number
-	condition?: ConditionResolvable
-	preview_models: string[]
-
-	/**
-	 * Selects this preview scene
-	 */
-	select(): void
-	/**
-	 * Unselects this preview scene
-	 */
-	unselect(): void
-}
+/// <reference types="./blockbench"/>
+interface PreviewModelCubeTemplate {
+	position: ArrayVector3
+	size: ArrayVector3
+	origin?: ArrayVector3
+	rotation?: ArrayVector3
+	faces: {
+		north?: { uv: ArrayVector4 }
+		east?: { uv: ArrayVector4 }
+		west?: { uv: ArrayVector4 }
+		south?: { uv: ArrayVector4 }
+		up?: { uv: ArrayVector4 }
+		down?: { uv: ArrayVector4 }
+	}
+}
+
+interface PreviewModelOptions {
+	condition?: ConditionResolvable
+	cubes: PreviewModelCubeTemplate[]
+	/**
+	 * Source of the model's texture
+	 */
+	texture?: string
+	/**
+	 * Model tint color
+	 */
+	color?: string
+	/**
+	 * Enable shading on the material
+	 */
+	shading?: boolean
+	/**
+	 * THREE.JS material render side
+	 */
+	render_side?: number
+	texture_size?: [number, number]
+	onUpdate?(): void
+}
+
+declare class PreviewModel extends Deletable {
+	constructor(id: string, options: PreviewModelOptions)
+
+	static models: {
+		[id: string]: PreviewModel
+	}
+	static getActiveModels(): PreviewModel[]
+
+	id: string
+	model_3d: THREE.Object3D
+	cubes: PreviewModelCubeTemplate[]
+	texture?: string
+	color?: string
+	shading: boolean
+	render_side: number
+	texture_size: [number, number]
+	onUpdate?: () => void
+	/**
+	 * Enables the model in the preview
+	 */
+	enable(): void
+	/**
+	 * Disables the model in the preview
+	 */
+	disable(): boolean
+	/**
+	 * Update the appearance and visibility of the model
+	 */
+	update(): void
+	buildModel(): void
+}
+
+interface PreviewSceneOptions {
+	name?: string
+	description?: string
+	category?: string
+	light_color?: string
+	light_side?: number
+	condition?: ConditionResolvable
+	preview_models?: string[]
+}
+
+declare class PreviewScene extends Deletable {
+	constructor(id: string, options: PreviewSceneOptions)
+
+	/**
+	 * All preview scenes, listed by ID
+	 */
+	static scenes: Record<string, PreviewScene>
+	/**
+	 * The currently active scene
+	 */
+	static active: PreviewScene | null
+	/**
+	 * The URL to the source repository that scenes are pulled from
+	 */
+	static source_repository: string
+	static menu_categories: {
+		[category_id: string]: {
+			[id: string]: string
+		}
+	}
+
+	id: string
+	name: string
+	description: string
+	category?: string
+	light_color: string
+	light_side: number
+	condition?: ConditionResolvable
+	preview_models: string[]
+
+	/**
+	 * Selects this preview scene
+	 */
+	select(): void
+	/**
+	 * Unselects this preview scene
+	 */
+	unselect(): void
+}