blockbench-types 4.9.0 → 4.11.0

package/types/project.d.ts

@@ -1,13 +1,17 @@
+/// <reference path="./blockbench.d.ts"/>
 interface ModelProjectOptions {
 	format: ModelFormat
 }
-
 /**
  * A project instance. The tab bar can be used to switch between projects.
  */
 declare class ModelProject {
 	constructor(options: ModelProjectOptions)
 
+	static properties: {
+		[key: string]: Property<any>
+	}
+
 	box_uv: boolean
 	texture_width: number
 	texture_height: number
@@ -52,10 +56,10 @@ declare class ModelProject {
 			edges: string[]
 			faces: string[]
 		}
-	};
-	selected_faces: []
+	}
+	selected_faces: any[]
 	textures: Texture[]
-	selected_texture: Texture | null;
+	selected_texture: Texture | null
 	outliner: OutlinerNode[]
 	animations: _Animation[]
 	timeline_animators: []
@@ -65,40 +69,53 @@ declare class ModelProject {
 			rotation: [number, number, number]
 			scale: [number, number, number]
 			mirror: [boolean, boolean, boolean]
-			export(): void;
+			export?(...args: any[]): any
 		}
-	};
-	ambientocclusion: boolean;
-	front_gui_light: boolean;
-	overrides: any;
+	}
+	overrides?: any
+	exploded_view: boolean
+	tool: string
+	uv_viewport: {
+		zoom: number
+		offset: [number, number]
+		[key: string]: any
+	}
+	backgrounds: {
+		[key: string]: any
+	}
+	unhandled_root_fields: any
+	ambientocclusion: boolean
+	front_gui_light: boolean
 
-	get model_3d(): THREE.Object3D;
-    get materials(): {
+	get model_3d(): THREE.Object3D
+	get materials(): {
 		[uuid: UUID]: THREE.ShaderMaterial
-	};
-    get nodes_3d(): {
+	}
+	get nodes_3d(): {
 		[uuid: UUID]: THREE.Object3D
-	};
+	}
 
-    getDisplayName(): string;
-    openSettings(): void;
-    whenNextOpen(callback: () => void): void;
-    select(): boolean;
-    unselect(): void;
-    close(force: any): Promise<boolean>;
+	getDisplayName(): string
+	openSettings(): void
+	whenNextOpen(callback: () => void): void
+	select(): boolean
+	unselect(): void
+	close(force: any): Promise<boolean>
 
+	saveEditorState(): void
+	loadEditorState(): void
 	static all: ModelProject[]
 }
 
 /**
  * Global variable and shortcut to get the currently opened project. If no project is open, or the New Tab is open, this value is falsy.
  */
-declare const Project: ModelProject | 0
+declare let Project: ModelProject | null | undefined
 
-declare function setupProject(format: ModelFormat | string): boolean;
-declare function newProject(format: ModelFormat | string): boolean;
-declare function setProjectResolution(width: number, height: number, modify_uv?: boolean): void;
-declare function updateProjectResolution(): void;
+declare function setupProject(format: ModelFormat | string, uuid?: string): boolean
+declare function newProject(format: ModelFormat | string): boolean
+declare function setProjectResolution(width: number, height: number, modify_uv?: boolean): void
+declare function updateProjectResolution(): void
 
 /**
  * An edit session instance. Edit sessions can be attached to a project to collaborate on it with multiple users via P2P connections.
@@ -116,22 +133,22 @@ declare class EditSession {
 
 	updateClientCound(): void
 	start(username?: string): void
-	join(username: string, token: string)
+	join(username: string, token: string): void
 	quit(): void
 	setState(active: boolean): void
-	copyToken(): void;
-    initNewModel(force?: boolean): void;
-    initConnection(conn: any): void;
-    sendAll(type: string, data: any): void;
-    sendEdit(entry: UndoEntry): void;
-    receiveData(tag: object): void;
-    processData(tag: object): void;
-    catchUp(): void;
+	copyToken(): void
+	initNewModel(force?: boolean): void
+	initConnection(conn: any): void
+	sendAll(type: string, data: any): void
+	sendEdit(entry: UndoEntry): void
+	receiveData(tag: any): void
+	processData(tag: any): void
+	catchUp(): void
 	/**
 	 * Send a chat message
 	 * @param text Text to send. If omitted, the current text in the chat panel input is sent
 	 */
-    sendChat(text?: string): void;
-    addChatMessage(message: any): any;
-    processChatMessage(data: any): void;
+	sendChat(text?: string): void
+	addChatMessage(message: any): any
+	processChatMessage(data: any): void
 }

package/types/screencam.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="./blockbench.d.ts"/>
 interface ScreenshotOptions {
 	crop?: boolean
 	width?: number
@@ -41,22 +42,26 @@ declare namespace Screencam {
 	 */
 	const recording_timelapse: boolean
 	const gif_options_dialog: Dialog
-	const gif_crop: {top: number, left: number, right: number, bottom: number}
+	const gif_crop: { top: number; left: number; right: number; bottom: number }
 
-	function screenshotPreview(preview: Preview, options: ScreenshotOptions, cb: ScreenshotReturn): void
+	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, cb: ScreenshotReturn, blob): 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 
+	 * @param options
+	 * @param cb
 	 */
-	function cleanCanvas(options, cb: ScreenshotReturn): void
+	function cleanCanvas(options: any, cb: ScreenshotReturn): void
 
 	function createGif(options: RecordGIFOptions, cb: ScreenshotReturn): void
 

package/types/settings.d.ts

@@ -1,99 +1,101 @@
+/// <reference path="./blockbench.d.ts"/>
+declare const settings: {
+	[id: string]: Setting
+}
+
 interface SettingOptions {
-    name: string
-    type?: 'number' | 'string' | 'boolean' | 'password' | 'select' | 'click'
-    value: boolean | number | string
-    condition?: ConditionResolvable
-    category: string
-    description?: string
-    //launch_setting?: boolean
-    min?: number
-    max?: number
-    step?: number
-    icon?: string
-    click?(): void
-    options?: {
-        [id: string]: string
-    }
-    onChange?: (value: any) => void
+	name: string
+	type?: 'number' | 'string' | 'boolean' | 'password' | 'select' | 'click'
+	value: boolean | number | string
+	condition?: ConditionResolvable
+	category: string
+	description?: string
+	//launch_setting?: boolean
+	min?: number
+	max?: number
+	step?: number
+	icon?: string
+	click?(): void
+	options?: {
+		[id: string]: string
+	}
+	onChange?(value: any): void
 }
 
 /**
  * Settings can be used to add global configuration options to Blockbench. All settings are listed under File > Preferences > Settings.
  */
 declare class Setting extends Deletable {
-    constructor(id: string, options: SettingOptions);
-
-    id: string
-    type: string
-    condition: any
-    /**
-     * The master value, not affected by profiles
-     */
-    master_value: any
-    /**
-     * The active value
-     */
-    value: any
-    /**
-     * The value that is displayed in the settings dialog
-     */
-    ui_value: any
-    name: string
-    description: string
-    category: string
-    /**
-     * If true, the setting can be used by the main process before initializing the Blockbench window. This is not available to custom settings created by plugins.
-     */
-    launch_setting: boolean
-    min?: number
-    max?: number
-    step?: number
-    icon?: string
-    options?: {
-        [id: string]: string
-    }
-    hidden?: boolean
-    onChange?: () => {}
-
-    /**
-     * Sets the value of the setting, while triggering the onChange function if available, and saving the change.
-     */
-    set(value): void
-    /**
-     * Triggers the setting, as if selected in action control. This toggles boolean settings, opens a dialog for string or numeric settings, etc.
-     */
-    trigger(event?: Event): void
-
+	constructor(id: string, options: SettingOptions)
+	id: string
+	type: string
+	condition: any
+	/**
+	 * The master value, not affected by profiles
+	 */
+	master_value: any
+	/**
+	 * The active value
+	 */
+	value: any
+	/**
+	 * The value that is displayed in the settings dialog
+	 */
+	ui_value: any
+	name: string
+	description: string
+	category: string
+	/**
+	 * If true, the setting can be used by the main process before initializing the Blockbench window. This is not available to custom settings created by plugins.
+	 */
+	launch_setting: boolean
+	min?: number
+	max?: number
+	step?: number
+	icon?: string
+	options?: {
+		[id: string]: string
+	}
+	hidden?: boolean
+	onChange?: () => {}
 
+	/**
+	 * Sets the value of the setting, while triggering the onChange function if available, and saving the change.
+	 */
+	set(value: any): void
+	/**
+	 * Triggers the setting, as if selected in action control. This toggles boolean settings, opens a dialog for string or numeric settings, etc.
+	 */
+	trigger(event?: Event): void
 }
 /**
  * Global namespace handling data and functionality related to settings.
  */
+declare type SettingItems = Record<string, { name: string; open: boolean; items: SettingItems }>
+
 declare namespace Settings {
-    const structure: {};
-    const stored: {};
-    /**
-     * Opens the settings dialog
-     * @param options 
-     */
-    function open(options?: Partial<{
-        search: string
-        tab: 'setting' | 'keybindings' | 'layout_settings' | 'credits'
-    }>): void;
-    /**
-     * Save all settings to the local storage
-     */
-    function saveLocalStorages(): void;
-    /**
-     * Save the settings and apply changes
-     */
-    function save(): void;
-    /**
-     * Returns the value of the specified setting
-     */
-    function get(setting_id: string): any;
+	const structure: Record<string, SettingItems>
+	const stored: Record<string, Setting>
+	/**
+	 * Opens the settings dialog
+	 * @param options
+	 */
+	function open(
+		options?: Partial<{
+			search: string
+			tab: 'setting' | 'keybindings' | 'layout_settings' | 'credits'
+		}>
+	): void
+	/**
+	 * Save all settings to the local storage
+	 */
+	function saveLocalStorages(): void
+	/**
+	 * Save the settings and apply changes
+	 */
+	function save(): void
+	/**
+	 * Returns the value of the specified setting
+	 */
+	function get(setting_id: string): any
 }
-
-declare const settings: {
-    [id: string]: Setting
-};

package/types/shared_actions.d.ts

@@ -27,7 +27,7 @@
  * 
  */
 declare namespace SharedActions {
-    const checks: {
+	const checks: {
 		[id: SharedActionID]: SharedActionHandler
 	}
 
@@ -52,19 +52,29 @@ declare namespace SharedActions {
 	 * @param context Optional context variable
 	 * @param force Force the specified handler to run and ignore its condition
 	 */
-	function runSpecific(action_id: SharedActionID, subject: string, event?: Event, context?: any, force?: boolean): boolean
+	function runSpecific(
+		action_id: SharedActionID,
+		subject: string,
+		event?: Event,
+		context?: any,
+		force?: boolean
+	): boolean
 	/**
 	 * Check if there is an active and available handler in the current situation for a shared action
-	 * @param action_id 
+	 * @param action_id
 	 */
 	function condition(action_id: SharedActionID): boolean
 	/**
 	 * Find the active handler in the current situation for a shared action
-	 * @param action_id 
-	 * @param event 
-	 * @param context 
+	 * @param action_id
+	 * @param event
+	 * @param context
 	 */
-	function find(action_id: SharedActionID, event?: Event, context?: any): SharedActionHandler | null
+	function find(
+		action_id: SharedActionID,
+		event?: Event,
+		context?: any
+	): SharedActionHandler | null
 }
 
 interface SharedActionHandler {
@@ -74,5 +84,11 @@ interface SharedActionHandler {
 	run: (event?: Event, context?: any) => void
 }
 
-type SharedActionID = string | 'rename' | 'delete' | 'duplicate' | 'select_all' | 'unselect_all' | 'invert_selection'
-
+type SharedActionID =
+	| string
+	| 'rename'
+	| 'delete'
+	| 'duplicate'
+	| 'select_all'
+	| 'unselect_all'
+	| 'invert_selection'

package/types/texture_layers.d.ts

@@ -1,118 +1,117 @@
 /// <reference types="three" />
 
 interface TextureLayerData {
-    name?: string
-    in_limbo?: boolean
-    offset?: ArrayVector2
-    scale?: ArrayVector2
-    opacity?: number
-    visible?: boolean
-    blend_mode?: 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'screen' | 'difference'
-    image_data?: ImageData
-    data_url?: string
+	name?: string
+	in_limbo?: boolean
+	offset?: ArrayVector2
+	scale?: ArrayVector2
+	opacity?: number
+	visible?: boolean
+	blend_mode?: 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'screen' | 'difference'
+	image_data?: ImageData
+	data_url?: string
 }
 
 /**
  * Texture layers always belong to a texture and represent the layers of the texture. Each layer has its own HTML canvas and canvas context
  */
 declare class TextureLayer {
-    constructor(data: TextureLayerData, texture: Texture, uuid?: string);
+	constructor(data: TextureLayerData, texture: Texture, uuid?: string)
 
-    name: string
-    uuid: UUID
-    texture: Texture
-    canvas: HTMLCanvasElement
-    ctx: CanvasRenderingContext2D
-    in_limbo: boolean
-    img: HTMLImageElement
-    /**
-     * Layer offset from the top left corner of the texture to the top left corner of the layer
-     */
-    offset: ArrayVector2
-    /**
-     * Layer scale. This is only used by the layer transform tool and should be applied and reset to 1x1 before doing further changes
-     */
-    scale: ArrayVector2
-    opacity: number
-    visible: boolean
-    blend_mode: 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'screen' | 'difference'
+	name: string
+	uuid: UUID
+	texture: Texture
+	canvas: HTMLCanvasElement
+	ctx: CanvasRenderingContext2D
+	in_limbo: boolean
+	img: HTMLImageElement
+	/**
+	 * Layer offset from the top left corner of the texture to the top left corner of the layer
+	 */
+	offset: ArrayVector2
+	/**
+	 * Layer scale. This is only used by the layer transform tool and should be applied and reset to 1x1 before doing further changes
+	 */
+	scale: ArrayVector2
+	opacity: number
+	visible: boolean
+	blend_mode: 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'screen' | 'difference'
 
-    extend(data: TextureLayerData): void
-    /**
-     * Selects the layer
-     */
-    select(): void
-    showContextMenu(event: Event): void
-    /**
-     * Remove the layer
-     * @param undo Create an undo point and update the texture
-     */
-    remove(undo: boolean): void
-    getUndoCopy(image_data: boolean): object
-    getSaveCopy(): object
-    /**
-     * Set the layer into a limbo state, where clicking Place or clicking next to the layer will place it on the layer below
-     */
-    setLimbo(): void
-    /**
-     * Resolves the limbo state by turning the limbo layer into a full layer, or merging it into the layer below
-     * @param keep_separate If true, the layer is kept as a separate layer
-     */
-    resolveLimbo(keep_separate): void
-    /**
-     * Set the layer size. This resizes the canvas, which discards the layer content
-     */
-    setSize(width: number, height: number): void
-    /**
-     * Toggle layer visibility. This creates an undo point
-     */
-    toggleVisibility(): void
-    /**
-     * Scroll the layer panel list to 
-     */
-    scrollTo(): void
-    /**
-     * Add the layer to the associated texture above the previously selected layer, select this layer, and scroll the layer panel list to it
-     */
-    addForEditing(): void
-    /**
-     * Merge this texture onto the texture below
-     * @param undo Create an undo entry
-     */
-    mergeDown(undo: boolean): void
-    /**
-     * Expand the layer to include the listed pixels
-     * @param points 
-     */
-    expandTo(...points: ArrayVector2): void
-    /**
-     * Flip the texture along an axis
-     * @param axis Flip axis, where 0 is X and 1 is Y
-     * @param undo Create an undo entry
-     */
-    flip(axis: number, undo): void
-    /**
-     * Rotate the layer around itself in 90 degree steps
-     * @param angle Angle in degrees
-     * @param undo Create an undo entry
-     */
-    rotate(angle: number, undo: boolean): void
-    /**
-     * Centers the layer on the texture
-     */
-    center(): void
-    /**
-     * Open the properties dialog
-     */
-    propertiesDialog(): void
+	extend(data: TextureLayerData): void
+	/**
+	 * Selects the layer
+	 */
+	select(): void
+	showContextMenu(event: Event): void
+	/**
+	 * Remove the layer
+	 * @param undo Create an undo point and update the texture
+	 */
+	remove(undo: boolean): void
+	getUndoCopy(image_data: boolean): object
+	getSaveCopy(): object
+	/**
+	 * Set the layer into a limbo state, where clicking Place or clicking next to the layer will place it on the layer below
+	 */
+	setLimbo(): void
+	/**
+	 * Resolves the limbo state by turning the limbo layer into a full layer, or merging it into the layer below
+	 * @param keep_separate If true, the layer is kept as a separate layer
+	 */
+	resolveLimbo(keep_separate: boolean): void
+	/**
+	 * Set the layer size. This resizes the canvas, which discards the layer content
+	 */
+	setSize(width: number, height: number): void
+	/**
+	 * Toggle layer visibility. This creates an undo point
+	 */
+	toggleVisibility(): void
+	/**
+	 * Scroll the layer panel list to
+	 */
+	scrollTo(): void
+	/**
+	 * Add the layer to the associated texture above the previously selected layer, select this layer, and scroll the layer panel list to it
+	 */
+	addForEditing(): void
+	/**
+	 * Merge this texture onto the texture below
+	 * @param undo Create an undo entry
+	 */
+	mergeDown(undo: boolean): void
+	/**
+	 * Expand the layer to include the listed pixels
+	 * @param points
+	 */
+	expandTo(...points: ArrayVector2): void
+	/**
+	 * Flip the texture along an axis
+	 * @param axis Flip axis, where 0 is X and 1 is Y
+	 * @param undo Create an undo entry
+	 */
+	flip(axis: number, undo: boolean): void
+	/**
+	 * Rotate the layer around itself in 90 degree steps
+	 * @param angle Angle in degrees
+	 * @param undo Create an undo entry
+	 */
+	rotate(angle: number, undo: boolean): void
+	/**
+	 * Centers the layer on the texture
+	 */
+	center(): void
+	/**
+	 * Open the properties dialog
+	 */
+	propertiesDialog(): void
 
-
-    /**
-     * Get all layers of the active texture
-     */
-    static all: TextureLayer[]
-    /**
-     * Get the selected layer
-     */
-    static selected: TextureLayer
+	/**
+	 * Get all layers of the active texture
+	 */
+	static all: TextureLayer[]
+	/**
+	 * Get the selected layer
+	 */
+	static selected: TextureLayer
 }