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

package/custom/painter.d.ts

@@ -1,69 +1,102 @@
-/// <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 getCanvasToolPixelCoords(uv_point: {x: number, y: number}, texture: Texture): ArrayVector2
+	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): tinycolor
+	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
+}
+
+	declare interface BarItemRegistry {
+		paint_secondary_color: KeybindItem
+		pan_tool: Tool
+		brush_tool: Tool
+		copy_brush: Tool
+		fill_tool: Tool
+		eraser: Tool
+		color_picker: Tool
+		draw_shape_tool: Tool
+		gradient_tool: Tool
+		move_layer_tool: Tool
+		brush_shape: BarSelect
+		draw_shape_type: BarSelect
+		blend_mode: BarSelect
+		fill_mode: BarSelect
+		copy_brush_mode: BarSelect
+		selection_tool_operation_mode: BarSelect
+		expand_texture_selection: Action
+		mirror_painting: Toggle
+		color_erase_mode: Toggle
+		lock_alpha: Toggle
+		painting_grid: Toggle
+		image_tiled_view: Toggle
+		image_onion_skin_view: Toggle
+		slider_brush_size: NumSlider
+		slider_brush_softness: NumSlider
+		slider_brush_opacity: NumSlider
+		pixel_perfect_drawing: Toggle
+		slider_color_select_threshold: NumSlider
+	}

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

package/custom/screencam.d.ts

@@ -1,71 +1,71 @@
-/// <reference types="./blockbench"/>
-interface ScreenshotOptions {
-	crop?: boolean
-	width?: number
-	height?: number
-}
-interface RecordGIFOptions {
-	fps: number
-	format?: 'gif' | 'apng' | 'png_sequence'
-	length_mode?: 'seconds' | 'frames' | 'turntable' | 'animation'
-	length?: number
-	pixelate?: number
-	quality?: number
-	background: string
-	background_image?: string
-	turnspeed?: string
-	/** Start playing the selected animation when the animation starts */
-	play?: boolean
-	repeat?: any
-	/** Disable all UI feedback about GIF recording */
-	silent?: boolean
-}
-interface RecordTimelapseOptions {
-	/** Destination oath */
-	destination: string
-	source: 'preview' | 'locked' | 'interface'
-	/** Interval between frames in seconds */
-	interval: number
-}
-type ScreenshotReturn = (dataURL: string) => void
-
-/**
- * A global namespace handling screenshot and GIF recording utilities.
- */
-declare namespace Screencam {
-	/**
-	 * Provided preview with anti aliasing disabled that can be used for screenshots
-	 */
-	const NoAAPreview: Preview
-	/**
-	 * Whether a timelapse is currently being recorded
-	 */
-	const recording_timelapse: boolean
-	const gif_options_dialog: Dialog
-	const gif_crop: { top: number; left: number; right: number; bottom: number }
-
-	function screenshotPreview(
-		preview: Preview,
-		options: ScreenshotOptions,
-		cb: ScreenshotReturn
-	): void
-
-	function fullScreen(options: ScreenshotOptions, cb: ScreenshotReturn): void
-
-	function screenshot2DEditor(options: ScreenshotOptions, cb: ScreenshotReturn): void
-
-	function returnScreenshot(dataUrl: any, cb: ScreenshotReturn, blob: any): void
-
-	/**
-	 * Runs callback in a clean canvas, where only the model is visible and the control gizmos are hidden
-	 * @param options
-	 * @param cb
-	 */
-	function cleanCanvas(options: any, cb: ScreenshotReturn): void
-
-	function createGif(options: RecordGIFOptions, cb: ScreenshotReturn): void
-
-	function recordTimelapse(options: RecordTimelapseOptions): void
-
-	function stopTimelapse(): void
-}
+/// <reference types="./blockbench"/>
+interface ScreenshotOptions {
+	crop?: boolean
+	width?: number
+	height?: number
+}
+interface RecordGIFOptions {
+	fps: number
+	format?: 'gif' | 'apng' | 'png_sequence'
+	length_mode?: 'seconds' | 'frames' | 'turntable' | 'animation'
+	length?: number
+	pixelate?: number
+	quality?: number
+	background: string
+	background_image?: string
+	turnspeed?: string
+	/** Start playing the selected animation when the animation starts */
+	play?: boolean
+	repeat?: any
+	/** Disable all UI feedback about GIF recording */
+	silent?: boolean
+}
+interface RecordTimelapseOptions {
+	/** Destination oath */
+	destination: string
+	source: 'preview' | 'locked' | 'interface'
+	/** Interval between frames in seconds */
+	interval: number
+}
+type ScreenshotReturn = (dataURL: string) => void
+
+/**
+ * A global namespace handling screenshot and GIF recording utilities.
+ */
+declare namespace Screencam {
+	/**
+	 * Provided preview with anti aliasing disabled that can be used for screenshots
+	 */
+	let NoAAPreview: Preview
+	/**
+	 * Whether a timelapse is currently being recorded
+	 */
+	const recording_timelapse: boolean
+	const gif_options_dialog: Dialog
+	const gif_crop: { top: number; left: number; right: number; bottom: number }
+
+	function screenshotPreview(
+		preview: Preview,
+		options: ScreenshotOptions,
+		cb: ScreenshotReturn
+	): void
+
+	function fullScreen(options: ScreenshotOptions, cb: ScreenshotReturn): void
+
+	function screenshot2DEditor(options: ScreenshotOptions, cb: ScreenshotReturn): void
+
+	function returnScreenshot(dataUrl: any, cb: ScreenshotReturn, blob: any): void
+
+	/**
+	 * Runs callback in a clean canvas, where only the model is visible and the control gizmos are hidden
+	 * @param options
+	 * @param cb
+	 */
+	function cleanCanvas(options: any, cb: ScreenshotReturn): void
+
+	function createGif(options: RecordGIFOptions, cb: ScreenshotReturn): void
+
+	function recordTimelapse(options: RecordTimelapseOptions): void
+
+	function stopTimelapse(): void
+}