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

package/custom/util.d.ts

@@ -1,235 +1,235 @@
-/// <reference types="./blockbench"/>
-
-type ConditionResolvable<Context extends any = any> =
-	| undefined
-	| boolean
-	| ((context: Context) => boolean)
-	| Partial<{
-			modes: string[]
-			formats: string[]
-			tools: string[]
-			features: (string | keyof FormatFeatures)[]
-			selected: {
-				animation?: boolean
-				animation_controller?: boolean
-				animation_controller_state?: boolean
-				keyframe?: boolean
-				group?: boolean
-				texture?: boolean
-				element?: boolean
-				cube?: boolean
-				mesh?: boolean
-				locator?: boolean
-				null_any?: boolean
-				texture_mesh?: boolean
-				outliner?: boolean
-				spline?: boolean
-			}
-			project: boolean
-			method(context: Context): boolean
-	  }>
-
-/**
- * Tests if a condition is truthy or falsy. Returns true if the condition is unspecified
- * @param condition Boolean, function, any or anything else
- */
-declare function Condition<Context extends any = any>(condition: ConditionResolvable<Context>, context?: Context): boolean
-
-
-/**
- * If the input event is a touch event, convert touch event to a compatible mouse event
- */
-declare function convertTouchEvent(event: MouseEvent): MouseEvent
-
-/**
- * Adds an event listener to an element, except that is supports multiple event types simultaneously
- * @param element Target Element
- * @param events Event types, separated by space characters
- * @param func Function
- * @param option Option
- */
-declare function addEventListeners(
-	element: HTMLElement | Document,
-	events: string,
-	func: (event: Event) => void,
-	option?: any
-): void
-declare function removeEventListeners(
-	el: HTMLElement | Document,
-	events: string,
-	func: (event: Event) => void,
-	option?: any
-): void
-
-/**
- * @deprecated Use {@link VersionUtil.compare} instead.
- */
-declare function compareVersions(versionA: any, versionB: any): boolean
-/**
- * Sets properties such as clientX on a TouchEvent based on touches. The use of the PointerEvent API is recommended instead.
- * @param event 
- */
-declare function convertTouchEvent(event: TouchEvent | MouseEvent): MouseEvent
-/**
- * Generate a new random UUID
- */
-declare function guid(): string
-/**
- * Returns true if the passed input is a UUID
- */
-declare function isUUID(s: string): boolean
-declare function bbuid(length: number): string
-declare function trimFloatNumber(value: number, decimal_places: number = 4): string
-declare function getAxisLetter(axisNumber: number): string
-declare function getAxisNumber(axisLetter: string): number
-declare function limitNumber(number: any, min: any, max: any): any
-declare function highestInObject(obj: any, inverse: any): string
-declare function getRectangle(
-	a: any,
-	b: any,
-	c: any,
-	d: any
-): {
-	ax: any
-	ay: any
-	bx: any
-	by: any
-	x: number
-	w: number
-	y: number
-	h: number
-}
-declare function doRectanglesOverlap(rect1: any, rect2: any): boolean
-declare function omitKeys(obj: any, keys: any, dual_level?: boolean): {}
-declare function get(options: any, name: any, defaultValue: any): any
-declare function getKeyByValue(any: any, value: any): any
-declare function onVueSetup(func: any): void
-declare function capitalizeFirstLetter(string: any): any
-declare function pluralS(arr: any): '' | 's'
-declare function pathToName(path: string, extension: boolean = false): string | ''
-declare function pathToExtension(path: string): string | ''
-declare function intToRGBA(int: any): {
-	r: number
-	g: number
-	b: number
-	a: number
-}
-declare function getAverageRGB(
-	imgEl: any,
-	blockSize: any
-): {
-	r: number
-	g: number
-	b: number
-}
-declare function stringifyLargeInt(int: any): any
-declare function intersectLines(p1: any, p2: any, p3: any, p4: any): boolean
-declare function pointInRectangle(point: any, rect_start: any, rect_end: any): boolean
-declare function lineIntersectsRectangle(p1: any, p2: any, rect_start: any, rect_end: any): boolean
-declare function cameraTargetToRotation(position: any, target: any): any[]
-declare function cameraRotationToTarget(position: any, rotation: any): any
-
-/**
- *
- * @param condition Input condition. Can be undefined, a boolean, a function or a condition any
- * @param context
- * Reusable data types that can be used by anything, but should not be used to store data between function calls. Can be used to save memory on frequent function calls.
- */
-declare function Condition(condition: (() => boolean) | undefined | boolean, context: any): boolean
-declare namespace Condition {
-	function mutuallyExclusive(a: any, b: any): boolean
-}
-declare function asyncLoop(o: any): void
-declare namespace Objector {
-	function equalKeys(obj: any, ref: any): boolean
-	function keyLength(obj: any): number
-}
-declare namespace Merge {
-	export function number(obj: any, source: any, index?: any): void
-	export function string(obj: any, source: any, index?: any, validate?: boolean): void
-	export function molang(obj: any, source: any, index?: any): void
-	export function boolean(obj: any, source: any, index?: any, validate?: boolean): void
-	export function _function(obj: any, source: any, index?: any, validate?: boolean): void
-	export { _function as function }
-	export function arrayVector(obj: any, source: any, index?: any, validate?: boolean): void
-	export function arrayVector2(obj: any, source: any, index?: any, validate?: boolean): void
-}
-
-/**
- * Reusable data types that can be used by anything, but should not be used to store data between function calls. Can be used to save memory on frequent function calls.
- */
-declare namespace Reusable {
-	const vec1: THREE.Vector3
-	const vec2: THREE.Vector3
-	const vec3: THREE.Vector3
-	const vec4: THREE.Vector3
-	const vec5: THREE.Vector3
-	const vec6: THREE.Vector3
-	const vec7: THREE.Vector3
-	const vec8: THREE.Vector3
-	const quat1: THREE.Quaternion
-	const quat2: THREE.Quaternion
-	const euler1: THREE.Euler
-	const euler2: THREE.Euler
-}
-
-declare function getCurrentGroup(): Group
-
-/**
- * Merge the value under a certain key from one object into another
- */
-declare namespace Merge {
-	function number(target: object, source: object, key: string | number): void
-	function string(
-		target: object,
-		source: object,
-		key: string | number,
-		validate?: (value: string) => boolean
-	): void
-	function molang(target: object, source: object, key: string | number): void
-	function boolean(
-		target: object,
-		source: object,
-		key: string | number,
-		validate?: (value: boolean) => boolean
-	): void
-	function arrayVector(
-		target: object,
-		source: object,
-		key: string | number,
-		validate?: (value: number[]) => boolean
-	): void
-	function arrayVector2(
-		target: object,
-		source: object,
-		key: string | number,
-		validate?: (value: ArrayVector2) => boolean
-	): void
-}
-
-declare class Rectangle {
-	constructor(start_x: number, start_y: number, width: number, height: number)
-	start_x: number
-	start_y: number
-	width: number
-	height: number
-	readonly start: ArrayVector2
-	readonly w: number
-	readonly h: number
-	end_x: number
-	end_y: number
-	readonly area: number
-	fromCoords(x1: number, y1: number, x2: number, y2: number): void
-	fromUnorderedCoords(x1: number, y1: number, x2: number, y2: number): void
-	expandTo(x: number, y: number): void
-}
-
-/**
- * TGA / Targa library
- */
-declare class Targa {
-	constructor()
-	load(data: Uint8Array)
-	getDataURL(): string
-	open(file: any, callback: () => void)
-}
+/// <reference types="./blockbench"/>
+
+type ConditionResolvable<Context extends any = any> =
+	| undefined
+	| boolean
+	| ((context: Context) => boolean)
+	| Partial<{
+			modes: string[]
+			formats: string[]
+			tools: string[]
+			features: (string | keyof FormatFeatures)[]
+			selected: {
+				animation?: boolean
+				animation_controller?: boolean
+				animation_controller_state?: boolean
+				keyframe?: boolean
+				group?: boolean
+				texture?: boolean
+				element?: boolean
+				cube?: boolean
+				mesh?: boolean
+				locator?: boolean
+				null_any?: boolean
+				texture_mesh?: boolean
+				outliner?: boolean
+				spline?: boolean
+			}
+			project: boolean
+			method(context: Context): boolean
+	  }>
+
+/**
+ * Tests if a condition is truthy or falsy. Returns true if the condition is unspecified
+ * @param condition Boolean, function, any or anything else
+ */
+declare function Condition<Context extends any = any>(condition: ConditionResolvable<Context>, context?: Context): boolean
+
+
+/**
+ * If the input event is a touch event, convert touch event to a compatible mouse event
+ */
+declare function convertTouchEvent(event: MouseEvent): MouseEvent
+
+/**
+ * Adds an event listener to an element, except that is supports multiple event types simultaneously
+ * @param element Target Element
+ * @param events Event types, separated by space characters
+ * @param func Function
+ * @param option Option
+ */
+declare function addEventListeners(
+	element: HTMLElement | Document,
+	events: string,
+	func: (event: Event) => void,
+	option?: any
+): void
+declare function removeEventListeners(
+	el: HTMLElement | Document,
+	events: string,
+	func: (event: Event) => void,
+	option?: any
+): void
+
+/**
+ * @deprecated Use {@link VersionUtil.compare} instead.
+ */
+declare function compareVersions(versionA: any, versionB: any): boolean
+/**
+ * Sets properties such as clientX on a TouchEvent based on touches. The use of the PointerEvent API is recommended instead.
+ * @param event 
+ */
+declare function convertTouchEvent(event: TouchEvent | MouseEvent): MouseEvent
+/**
+ * Generate a new random UUID
+ */
+declare function guid(): string
+/**
+ * Returns true if the passed input is a UUID
+ */
+declare function isUUID(s: string): boolean
+declare function bbuid(length: number): string
+declare function trimFloatNumber(value: number, decimal_places: number = 4): string
+declare function getAxisLetter(axisNumber: number): string
+declare function getAxisNumber(axisLetter: string): number
+declare function limitNumber(number: any, min: any, max: any): any
+declare function highestInObject(obj: any, inverse: any): string
+declare function getRectangle(
+	a: any,
+	b: any,
+	c: any,
+	d: any
+): {
+	ax: any
+	ay: any
+	bx: any
+	by: any
+	x: number
+	w: number
+	y: number
+	h: number
+}
+declare function doRectanglesOverlap(rect1: any, rect2: any): boolean
+declare function omitKeys(obj: any, keys: any, dual_level?: boolean): {}
+declare function get(options: any, name: any, defaultValue: any): any
+declare function getKeyByValue(any: any, value: any): any
+declare function onVueSetup(func: any): void
+declare function capitalizeFirstLetter(string: any): any
+declare function pluralS(arr: any): '' | 's'
+declare function pathToName(path: string, extension: boolean = false): string | ''
+declare function pathToExtension(path: string): string | ''
+declare function intToRGBA(int: any): {
+	r: number
+	g: number
+	b: number
+	a: number
+}
+declare function getAverageRGB(
+	imgEl: any,
+	blockSize: any
+): {
+	r: number
+	g: number
+	b: number
+}
+declare function stringifyLargeInt(int: any): any
+declare function intersectLines(p1: any, p2: any, p3: any, p4: any): boolean
+declare function pointInRectangle(point: any, rect_start: any, rect_end: any): boolean
+declare function lineIntersectsRectangle(p1: any, p2: any, rect_start: any, rect_end: any): boolean
+declare function cameraTargetToRotation(position: any, target: any): any[]
+declare function cameraRotationToTarget(position: any, rotation: any): any
+
+/**
+ *
+ * @param condition Input condition. Can be undefined, a boolean, a function or a condition any
+ * @param context
+ * Reusable data types that can be used by anything, but should not be used to store data between function calls. Can be used to save memory on frequent function calls.
+ */
+declare function Condition(condition: (() => boolean) | undefined | boolean, context: any): boolean
+declare namespace Condition {
+	function mutuallyExclusive(a: any, b: any): boolean
+}
+declare function asyncLoop(o: any): void
+declare namespace Objector {
+	function equalKeys(obj: any, ref: any): boolean
+	function keyLength(obj: any): number
+}
+declare namespace Merge {
+	export function number(obj: any, source: any, index?: any): void
+	export function string(obj: any, source: any, index?: any, validate?: boolean): void
+	export function molang(obj: any, source: any, index?: any): void
+	export function boolean(obj: any, source: any, index?: any, validate?: boolean): void
+	export function _function(obj: any, source: any, index?: any, validate?: boolean): void
+	export { _function as function }
+	export function arrayVector(obj: any, source: any, index?: any, validate?: boolean): void
+	export function arrayVector2(obj: any, source: any, index?: any, validate?: boolean): void
+}
+
+/**
+ * Reusable data types that can be used by anything, but should not be used to store data between function calls. Can be used to save memory on frequent function calls.
+ */
+declare namespace Reusable {
+	const vec1: THREE.Vector3
+	const vec2: THREE.Vector3
+	const vec3: THREE.Vector3
+	const vec4: THREE.Vector3
+	const vec5: THREE.Vector3
+	const vec6: THREE.Vector3
+	const vec7: THREE.Vector3
+	const vec8: THREE.Vector3
+	const quat1: THREE.Quaternion
+	const quat2: THREE.Quaternion
+	const euler1: THREE.Euler
+	const euler2: THREE.Euler
+}
+
+declare function getCurrentGroup(): Group
+
+/**
+ * Merge the value under a certain key from one object into another
+ */
+declare namespace Merge {
+	function number(target: object, source: object, key: string | number): void
+	function string(
+		target: object,
+		source: object,
+		key: string | number,
+		validate?: (value: string) => boolean
+	): void
+	function molang(target: object, source: object, key: string | number): void
+	function boolean(
+		target: object,
+		source: object,
+		key: string | number,
+		validate?: (value: boolean) => boolean
+	): void
+	function arrayVector(
+		target: object,
+		source: object,
+		key: string | number,
+		validate?: (value: number[]) => boolean
+	): void
+	function arrayVector2(
+		target: object,
+		source: object,
+		key: string | number,
+		validate?: (value: ArrayVector2) => boolean
+	): void
+}
+
+declare class Rectangle {
+	constructor(start_x: number, start_y: number, width: number, height: number)
+	start_x: number
+	start_y: number
+	width: number
+	height: number
+	readonly start: ArrayVector2
+	readonly w: number
+	readonly h: number
+	end_x: number
+	end_y: number
+	readonly area: number
+	fromCoords(x1: number, y1: number, x2: number, y2: number): void
+	fromUnorderedCoords(x1: number, y1: number, x2: number, y2: number): void
+	expandTo(x: number, y: number): void
+}
+
+/**
+ * TGA / Targa library
+ */
+declare class Targa {
+	constructor()
+	load(data: Uint8Array)
+	getDataURL(): string
+	open(file: any, callback: () => void)
+}

package/custom/uveditor.d.ts

@@ -1,3 +1,3 @@
-// FIXME - this is a hack to get around the fact that the UVEditor class is not documented.
-// I just wanted to remove the red squiggles in my editor.
-declare const UVEditor: any
+// FIXME - this is a hack to get around the fact that the UVEditor class is not documented.
+// I just wanted to remove the red squiggles in my editor.
+declare const UVEditor: any

package/custom/validator.d.ts

@@ -1,99 +1,99 @@
-/// <reference types="./blockbench"/>
-/**
- * The validator in Blockbench provides feedback about the model and can detect issues in real time, based on a list of checks that can be added. This is a good way to ensure model files are valid, and to teach users about best practices.
- */
-declare namespace Validator {
-	const checks: ValidatorCheck[]
-
-	const warnings: WarningOrError[]
-	const errors: WarningOrError[]
-	/**
-	 * Run the validator
-	 * @param trigger ID of the Blockbench event that triggered the call
-	 */
-	function validate<T extends BlockbenchEventName>(trigger?: T): void
-	/**
-	 * Opens the Validator dialog
-	 */
-	function openDialog(): void
-
-	/**
-	 * Cached trigger IDs
-	 */
-	const triggers: BlockbenchEventName[]
-	/**
-	 * Update the cached triggers list
-	 */
-	function updateCashedTriggers(): void
-}
-
-interface ValidatorCheckOptions {
-	/**
-	 * Function that runs when the validator check runs
-	 */
-	run(): void
-	/**
-	 * Names of events that automatically trigger this check
-	 */
-	update_triggers?: BlockbenchEventName[]
-	condition?: ConditionResolvable
-}
-interface WarningOrError {
-	message: string
-	buttons?: {
-		name: string
-		icon: IconString
-		click(): void
-	}[]
-}
-
-/**
- * A check for the validator. A check can be triggered by certain things, and updates the list of warnings and errors that can be displayed in the status bar.
-
-
-### Example:
-
-```javascript
-	new ValidatorCheck('special_cube_name_rule', {
-		update_triggers: ['update_selection'],
-		run() {
-			Cube.all.forEach(cube => {
-				if (cube.name == 'sphere') {
-					this.warn({
-						message: `The cube "${cube.name}" has an invalid names. Cubes may not be called "sphere".`,
-						buttons: [
-							{
-								name: 'Select Cube',
-								icon: 'fa-cube',
-								click() {
-									Validator.dialog.hide();
-									cube.select();
-								}
-							}
-						]
-					})
-				}
-			})
-		}
-	})
-```
- */
-declare class ValidatorCheck extends Deletable {
-	id: string
-	name: string
-	plugin?: string
-	constructor(id: string, options: ValidatorCheckOptions)
-
-	/**
-	 * Manually run this check
-	 */
-	update(): void
-	/**
-	 * Throw a warning. This is intended to be used inside the run() method
-	 */
-	warn(...warnings: WarningOrError[]): void
-	/**
-	 * Throw an error. This is intended to be used inside the run() method
-	 */
-	fail(...warnings: WarningOrError[]): void
-}
+/// <reference types="./blockbench"/>
+/**
+ * The validator in Blockbench provides feedback about the model and can detect issues in real time, based on a list of checks that can be added. This is a good way to ensure model files are valid, and to teach users about best practices.
+ */
+declare namespace Validator {
+	const checks: ValidatorCheck[]
+
+	const warnings: WarningOrError[]
+	const errors: WarningOrError[]
+	/**
+	 * Run the validator
+	 * @param trigger ID of the Blockbench event that triggered the call
+	 */
+	function validate<T extends BlockbenchEventName>(trigger?: T): void
+	/**
+	 * Opens the Validator dialog
+	 */
+	function openDialog(): void
+
+	/**
+	 * Cached trigger IDs
+	 */
+	const triggers: BlockbenchEventName[]
+	/**
+	 * Update the cached triggers list
+	 */
+	function updateCashedTriggers(): void
+}
+
+interface ValidatorCheckOptions {
+	/**
+	 * Function that runs when the validator check runs
+	 */
+	run(): void
+	/**
+	 * Names of events that automatically trigger this check
+	 */
+	update_triggers?: BlockbenchEventName[]
+	condition?: ConditionResolvable
+}
+interface WarningOrError {
+	message: string
+	buttons?: {
+		name: string
+		icon: IconString
+		click(): void
+	}[]
+}
+
+/**
+ * A check for the validator. A check can be triggered by certain things, and updates the list of warnings and errors that can be displayed in the status bar.
+
+
+### Example:
+
+```javascript
+	new ValidatorCheck('special_cube_name_rule', {
+		update_triggers: ['update_selection'],
+		run() {
+			Cube.all.forEach(cube => {
+				if (cube.name == 'sphere') {
+					this.warn({
+						message: `The cube "${cube.name}" has an invalid names. Cubes may not be called "sphere".`,
+						buttons: [
+							{
+								name: 'Select Cube',
+								icon: 'fa-cube',
+								click() {
+									Validator.dialog.hide();
+									cube.select();
+								}
+							}
+						]
+					})
+				}
+			})
+		}
+	})
+```
+ */
+declare class ValidatorCheck extends Deletable {
+	id: string
+	name: string
+	plugin?: string
+	constructor(id: string, options: ValidatorCheckOptions)
+
+	/**
+	 * Manually run this check
+	 */
+	update(): void
+	/**
+	 * Throw a warning. This is intended to be used inside the run() method
+	 */
+	warn(...warnings: WarningOrError[]): void
+	/**
+	 * Throw an error. This is intended to be used inside the run() method
+	 */
+	fail(...warnings: WarningOrError[]): void
+}