blockbench-types 4.11.0 → 4.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "blockbench-types",
-	"version": "4.11.0",
+	"version": "4.12.0",
 	"description": "Blockbench typescript types",
 	"main": "",
 	"types": "types/index.d.ts",
@@ -30,11 +30,11 @@
 		"@types/three": "^0.129.2",
 		"@types/tinycolor2": "^1.4.6",
 		"dompurify": "^3.0.1",
-		"electron": "^31.4.0",
+		"electron": "^33.3.1",
 		"prismjs": "^1.29.0",
 		"tinycolor2": "^1.6.0",
 		"typescript": "^4.9.5",
-		"vue": "^3.2.45",
+		"vue": "2.7.14",
 		"wintersky": "^1.3.0"
 	},
 	"devDependencies": {

package/scripts/generate_docs.js

@@ -25,6 +25,7 @@ async function main() {
 			'./types/blockbench.d.ts',
 			'./types/textures.d.ts',
 			'./types/texture_layers.d.ts',
+			'./types/texture_group.d.ts',
 			'./types/action.d.ts',
 			'./types/animation.d.ts',
 			'./types/animation_controller.d.ts',
@@ -39,6 +40,7 @@ async function main() {
 			'./types/legacy.d.ts',
 			'./types/menu.d.ts',
 			'./types/outliner.d.ts',
+			'./types/collection.d.ts',
 			'./types/group.d.ts',
 			'./types/cube.d.ts',
 			'./types/mesh.d.ts',

package/tsconfig.json

@@ -9,7 +9,8 @@
 		"rootDir": ".",
 		"strict": true,
 		"noImplicitAny": true,
-		"esModuleInterop": true
+		"esModuleInterop": true,
+		"allowUmdGlobalAccess": true
 	},
 	"exclude": ["./node_modules/**/*"]
 }

package/types/action.d.ts

@@ -11,31 +11,114 @@ declare interface KeybindKeys {
 	 * Main key, can be a numeric keycode or a lower case character
 	 */
 	key: number | string
-	ctrl?: boolean | null
-	shift?: boolean | null
-	alt?: boolean | null
-	meta?: boolean | null
+	ctrl?: boolean
+	shift?: boolean
+	alt?: boolean
+	meta?: boolean
 }
+type VariationModifier = 'always' | 'ctrl' | 'shift' | 'alt' | 'meta' | 'unless_ctrl' | 'unless_shift' | 'unless_alt'
+type ModifierKey = 'ctrl' | 'shift' | 'alt' | 'meta'
 /**
  * A customizable keybind
  */
 declare class Keybind {
-	constructor(keys: KeybindKeys)
+	/**
+	 * Create a keybind
+	 * @param {object} keys Set up the default keys that need to be pressed
+	 * @param {number|string} keys.key Main key. Check keycode.info to find out the numeric value, or simply use letters for letter keys
+	 * @param {boolean} keys.ctrl Control key. On MacOS this automatically works for Cmd
+	 * @param {boolean} keys.shift Shift key
+	 * @param {boolean} keys.alt Alt key
+	 * @param {boolean} keys.meta Meta key
+	 */
+	constructor(keys: KeybindKeys, variations?: Record<string, VariationModifier>)
 	key: number
 	ctrl?: boolean
 	shift?: boolean
 	alt?: boolean
+	variations?: {
+		[key: string]: {name: string, description?: string}
+	}
+	set(keys: KeybindKeys): this;
+	/**
+	 * Unassign the assigned key
+	 */
+	clear(): this;
+	/**
+	 * Save any changes to local storage
+	 * @param save Save all keybinding changes to local storage. Set to fales if updating multiple at once
+	 */
+	save(save?: false): this;
+	/**
+	 * Assign an action to the keybind
+	 * @param id ID of the action
+	 * @param sub_id sub keybind ID
+	 */
+	setAction(id: string, sub_id?: string): this | undefined;
+	/**
+	 * Get display text showing the keybind
+	 * @param formatted If true, the return string will include HTML formatting
+	 */
+	getText(formatted?: boolean): string;
 	/**
 	 * Get the name of the bound key
 	 */
-	getCode(): string
+	getCode(key: string): string
+	/**
+	 * Check if a key is assigned
+	 */
+	hasKey(): boolean;
+	/**
+	 * Test if the keybind would be triggered by the event
+	 */
+	isTriggered(event: Event): boolean;
+	/**
+	 * Test which variation would be triggered by the event. Returns the ID of the variation if triggered
+	 * @param event The event to test
+	 */
+	additionalModifierTriggered(event: Event): string | undefined;
+	/**
+	 * Test if a variation would be triggered by the event
+	 * @param event The event to test
+	 * @param variation The variation to test againts
+	 */
+	additionalModifierTriggered(event: Event, variation: string): boolean;
+	/**
+	 * Open a UI to let the user record a new key combination
+	 */
+	record(): this;
+	/**
+	 * Stop recording a new key combination
+	 */
+	stopRecording(): this;
+	/**
+	 * Returns the label of the keybinding
+	 */
+	toString(): string;
+
+	/**
+	 * Load an included keymap by ID
+	 * @param id 
+	 * @param from_start_screen 
+	 */
+	static loadKeymap(id: string, from_start_screen?: boolean): void | true
+	/**
+	 * Check if two KeybindItems are mutually exclusive, so only one can be available at the time. This is only the case if they each have a ConditionResolvable that is structured to support this
+	 */
+	static no_overlap(k1: KeybindItem, k2: KeybindItem): boolean
 }
 interface KeybindItemOptions {
 	keybind?: Keybind
+	variations?: {
+		[key: string]: {name: string, description?: string}
+	}
 }
 declare class KeybindItem extends Deletable {
 	constructor(id: string, options: KeybindItemOptions)
 	keybind: Keybind
+	variations?: {
+		[key: string]: {name: string, description?: string}
+	}
 }
 
 declare class MenuSeparator {
@@ -55,7 +138,7 @@ type ActionEventName =
 interface BarItemOptions extends KeybindItemOptions {
 	name?: string
 	description?: string
-	icon: string
+	icon?: string
 	condition?: ConditionResolvable
 	category?: string
 	keybind?: Keybind
@@ -66,6 +149,8 @@ interface BarItemOptions extends KeybindItemOptions {
 declare class BarItem extends KeybindItem {
 	constructor(id: string, options: BarItemOptions)
 	id: string
+	node: HTMLElement
+	nodes: HTMLElement[]
 	conditionMet(): boolean
 	/**
 	 * Adds a label to the HTML element of the bar item
@@ -101,7 +186,6 @@ declare class BarItem extends KeybindItem {
 	 * @param callback
 	 */
 	removeListener(event_name: ActionEventName, callback: (data: object) => void): void
-	dispatchEvent(data: object): void
 	constructor(id: string, options: BarItemOptions)
 	conditionMet(): boolean
 	/**
@@ -119,6 +203,8 @@ declare class BarItem extends KeybindItem {
 	 */
 	toElement(destination: HTMLElement): this
 	pushToolbar(bar: any): void
+
+	dispatchEvent<T = EventName>(event: T, ...args: any[]): void
 }
 
 interface ActionOptions extends BarItemOptions {
@@ -139,6 +225,14 @@ interface ActionOptions extends BarItemOptions {
 	 * Show the full label in toolbars
 	 */
 	label?: boolean
+	/**
+	 * Provide a menu that belongs to the action, and gets displayed as a small arrow next to it in toolbars.
+	 */
+	side_menu?: Menu
+	/**
+	 * Provide a window with additional configutation related to the action
+	 */
+	tool_config?: ToolConfig
 }
 /**
  * Actions can be triggered to run something, they can be added to menus, toolbars, assigned a keybinding, or run via Action Control
@@ -149,7 +243,11 @@ declare class Action extends BarItem {
 	/**
 	 * Provide a menu that belongs to the action, and gets displayed as a small arrow next to it in toolbars.
 	 */
-	side_menu?: Menu
+	side_menu?: Menu | ToolConfig
+	/**
+	 * Provide a window with additional configutation related to the action
+	 */
+	tool_config?: ToolConfig
 	click: ActionOptions['click']
 
 	condition?(): boolean
@@ -176,11 +274,14 @@ interface ToggleOptions extends ActionOptions {
  * A toggle is a type of action that can be on or off. The state is not persistent between restarts by default.
  */
 declare class Toggle extends Action {
+	value: boolean
 	constructor(id: string, options: ToggleOptions)
 	/**
 	 * Updates the state of the toggle in the UI
 	 */
 	updateEnabledState(): void
+	set(value: boolean): this
+	setIcon(icon: IconString): void
 }
 
 type RGBAColor = { r: number; g: number; b: number; a: number }
@@ -324,6 +425,9 @@ interface ToolOptions extends ActionOptions {
 	paintTool?: boolean
 	brush?: BrushOptions
 }
+interface WidgetOptions extends BarItemOptions {
+	id?: string
+}
 /**
  * A tool, such as move tool, vertex snap tool, or paint brush
  */
@@ -334,10 +438,21 @@ declare class Tool extends Action {
 	trigger(event: Event): boolean
 }
 declare class Widget extends BarItem {
-	constructor(id: string, options: any)
+	constructor(id: string, options: WidgetOptions)
+}
+type NumSliderOptions = WidgetOptions & {
+	settings?: {
+		default?: number
+		min?: number
+		max?: number
+		interval?: number
+		step?: number
+	}
+	change?(value: (n: number) => number): void
+	get?(): number
 }
 declare class NumSlider extends Widget {
-	constructor(id: string, options: any)
+	constructor(id: string, options: NumSliderOptions)
 	startInput(event: Event): void
 	setWidth(width: any): this
 	getInterval(event: Event): number
@@ -346,42 +461,57 @@ declare class NumSlider extends Widget {
 	stopInput(): void
 	arrow(difference: any, event: Event): void
 	trigger(event: Event): boolean
-	setValue(value: number, trim: any): this
-	change(modify: any): void
+	setValue(value: number, trim?: any): this
+	change(modify: (n: number) => number): void
 	get(): number
 	update(): void
 }
 declare class BarSlider extends Widget {
-	constructor(id: string, options: any)
+	constructor(id: string, options: NumSliderOptions)
 	change(event: Event): void
 	set(value: number): void
 	get(): number
 }
-declare class BarSelect extends Widget {
-	constructor(id: string, options: any)
+interface BarSelectOptions<T> extends WidgetOptions {
+	value?: T
+	options: Record<string, T>
+}
+declare class BarSelect<T> extends Widget {
+	constructor(id: string, options: BarSelectOptions<T>)
 	open(event: Event): void
 	trigger(event: Event): boolean | undefined
-	change(event: Event): this
+	change(value: T, event: Event): this
 	getNameFor(key: string): string
 	set(key: string): this
 	get(): string
+	value: T
 }
 declare class BarText extends Widget {
-	constructor(id: string, options: any)
+	constructor(
+		id: string,
+		options: WidgetOptions & {
+			text: string
+		}
+	)
 	set(text: any): this
 	update(): this
 	trigger(event: Event): boolean
 }
-interface ColorPickerOptions {
-	onChange?: () => void
+interface ColorPickerOptions extends WidgetOptions {
+	value?: string
+	palette?: boolean
+	onChange?: (color: tinycolor.Instance) => void
 }
 declare class ColorPicker extends Widget {
-	constructor(id: string, options: any)
-	change(color: any): void
+	value: tinycolor.Instance
+	jq: JQuery
+	constructor(options: ColorPickerOptions)
+	constructor(id: string, options: ColorPickerOptions)
+	change(color: tinycolor.Instance): void
 	hide(): void
 	confirm(): void
 	set(color: any): this
-	get(): any
+	get(): tinycolor.Instance
 }
 interface ToolbarOptions {
 	id: string
@@ -413,6 +543,7 @@ declare class Toolbar {
 	toPlace(place: any): this
 	save(): this
 	reset(): this
+	condition(): boolean
 }
 declare namespace BARS {
 	const stored: {}

package/types/animation.d.ts

@@ -16,6 +16,7 @@ interface AnimationOptions {
 	blend_weight?: string
 	length?: number
 	snapping?: number
+	animators?: any
 }
 
 interface AnimationUndoCopy {
@@ -85,7 +86,7 @@ declare class _Animation extends AnimationItem {
 
 	markers: TimelineMarker[]
 	animators: {
-		[id: string]: GeneralAnimator | undefined
+		[id: string]: GeneralAnimator
 	}
 	saved_name?: string
 	selected: boolean
@@ -176,10 +177,10 @@ declare class BoneAnimator extends GeneralAnimator {
 	fillValues(): void
 	pushKeyframe(): void
 	doRender(): boolean
-	displayRotation(): void
-	displayPosition(): void
-	displayScale(): void
-	interpolate(channel: string, allow_expression?: boolean, axis?: string): ArrayVector3
+	displayRotation(arr?: ArrayVector3 | ArrayVector4, multiplier?: number): void
+	displayPosition(arr?: ArrayVector3, multiplier?: number): this
+	displayScale(arr?: ArrayVector3, multiplier?: number): void
+	interpolate(channel: string, allow_expression?: boolean, axis?: string): ArrayVector3 | false
 	displayFrame(multiplier?: number): void
 }
 declare class NullObjectAnimator extends GeneralAnimator {
@@ -190,7 +191,6 @@ declare class NullObjectAnimator extends GeneralAnimator {
 	scale: _Keyframe[]
 	getElement(): NullObject
 	doRender(): void
-	displayPosition(): void
 	displayIK(): void
 	displayFrame(): void
 }

package/types/blockbench.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="vue" />
-/// <reference types="@types/three" />
+/// <reference types="./three.d.ts" />
 /// <reference types="@types/prismjs" />
 /// <reference types="@types/jquery" />
 /// <reference types="wintersky" />
 
 /// <reference types="./texture_layers" />
+/// <reference types="./texture_group" />
 /// <reference types="./action" />
 /// <reference types="./animation" />
 /// <reference types="./animation_controller" />
@@ -29,6 +30,7 @@
 /// <reference types="./mode" />
 /// <reference types="./molang" />
 /// <reference types="./outliner" />
+/// <reference types="./collection" />
 /// <reference types="./painter" />
 /// <reference types="./panel" />
 /// <reference types="./plugin" />
@@ -50,7 +52,6 @@
 /// <reference types="./math_util" />
 /// <reference types="./canvas_frame" />
 /// <reference types="./io" />
-/// <reference types="./vue" />
 
 /**
  * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used
@@ -313,7 +314,10 @@ declare namespace Blockbench {
 	 * Blockbench.removeListener<EventName>(...)
 	 * ```
 	 */
-	export function removeListener<E extends string>(event_names: E): void
+	export function removeListener<E extends string>(
+		event_names: E,
+		callback: (data: any) => void
+	): void
 
 	/**
 	 * Reads the content from the specified files. Desktop app only.
@@ -390,6 +394,7 @@ type BlockbenchTypeFace = typeof Face
 type BlockbenchTypeCubeFace = typeof CubeFace
 type BlockbenchTypeMeshFace = typeof MeshFace
 type BlockbenchTypeNodePreviewController = typeof NodePreviewController
+type BlockbenchTypeCollection = typeof Collection
 type BlockbenchTypeAnimator = typeof Animator
 type BlockbenchTypeTimeline = typeof Timeline
 type BlockbenchTypeAnimationItem = typeof AnimationItem
@@ -450,6 +455,7 @@ declare namespace Blockbench {
 	const CubeFace: BlockbenchTypeCubeFace
 	const MeshFace: BlockbenchTypeMeshFace
 	const NodePreviewController: BlockbenchTypeNodePreviewController
+	const Collection: BlockbenchTypeCollection
 	const Animator: BlockbenchTypeAnimator
 	const Timeline: BlockbenchTypeTimeline
 	const AnimationItem: BlockbenchTypeAnimationItem
@@ -500,7 +506,10 @@ declare namespace Blockbench {
 
 declare const NativeGlobals: {
 	Animation: {
-		new (effect?: AnimationEffect | null | undefined, timeline?: AnimationTimeline | null | undefined): Animation;
-		prototype: Animation;
-	};
-};
+		new (
+			effect?: AnimationEffect | null | undefined,
+			timeline?: AnimationTimeline | null | undefined
+		): Animation
+		prototype: Animation
+	}
+}

package/types/canvas.d.ts

@@ -93,7 +93,7 @@ declare namespace Canvas {
 	const global_light_color: THREE.Color
 	const global_light_side: number
 
-	const face_order: string[]
+	const face_order: ['east', 'west', 'up', 'down', 'south', 'north']
 
 	/**
 	 * Raycast on the currently selected preview
@@ -152,7 +152,7 @@ declare namespace Canvas {
 	/**
 	 * Update positions and shapes of the selected elements
 	 */
-	function updatePositions(y: number): void
+	function updatePositions(y?: number): void
 	/**
 	 * Update the faces of all selected elements (material, UV map)
 	 */
@@ -215,16 +215,26 @@ declare namespace Canvas {
  * Marks a specific aspect of the interface to be updated in the next tick. Useful to avoid an update function getting called multiple times in the same task.
  */
 declare namespace TickUpdates {
-	const outliner: undefined | true
-	const selection: undefined | true
-	const main_uv: undefined | true
-	const texture_list: undefined | true
-	const keyframes: undefined | true
-	const keyframe_selection: undefined | true
-	const keybind_conflicts: undefined | true
+	let outliner: undefined | true
+	let selection: undefined | true
+	let main_uv: undefined | true
+	let texture_list: undefined | true
+	let keyframes: undefined | true
+	let keyframe_selection: undefined | true
+	let keybind_conflicts: undefined | true
 }
 
 interface NodePreviewControllerOptions {
+	/**
+	 * NOTE: This option is just for type checking and should not be set in the options object. It should be set inside of the setup function via `this.mesh`
+	 *
+	 * ```
+	 * setup(element) {
+	 *    this.mesh = new THREE.Mesh()
+	 * }
+	 * ```
+	 */
+	mesh?: THREE.Object3D | THREE.Mesh
 	setup?(element: OutlinerNode): void
 	remove?(element: OutlinerNode): void
 	updateAll?(element: OutlinerNode): void
@@ -235,14 +245,15 @@ interface NodePreviewControllerOptions {
 	updateUV?(element: OutlinerNode): void
 	updateFaces?(element: OutlinerNode): void
 	updatePaintingGrid?(element: OutlinerNode): void
-	updateHighlight?(element: OutlinerNode): void
+	updateHighlight?(element: OutlinerNode, ...args: any[]): void
 }
 declare class NodePreviewController {
-	constructor(type: typeof OutlinerNode, options: NodePreviewControllerOptions)
+	constructor(type: typeof OutlinerElement | typeof OutlinerNode, options: NodePreviewControllerOptions)
 	type: typeof OutlinerNode
 	events: {
 		[event_name: string]: ((data: any) => void)[]
 	}
+	mesh: THREE.Object3D | THREE.Mesh
 	dispatchEvent(event_name: string, data: Record<string, any>): void
 	/**
 	 * Adds an event listener
@@ -267,5 +278,5 @@ declare class NodePreviewController {
 	updateUV(instance: OutlinerNode): void
 	updateFaces(instance: OutlinerNode): void
 	updatePaintingGrid(instance: OutlinerNode): void
-	updateHighlight(instance: OutlinerNode): void
+	updateHighlight(instance: OutlinerNode, ...args: any[]): void
 }

package/types/codec.d.ts

@@ -14,6 +14,8 @@ interface CodecOptions {
 	overwrite?(content: any, path: string, callback: (path: any) => void): void
 	afterDownload?(path: any): void
 	afterSave?(path: any): void
+	exportCollection?(collection: Collection): void
+	writeCollection?(collection: Collection): void
 
 	dispatchEvent?(event_name: string, data: any): void
 
@@ -31,7 +33,7 @@ interface CodecOptions {
 	 * List of export option inputs, based on the Dialog form API
 	 */
 	export_options?: {
-		[key: string]: DialogFormElement
+		[key: string]: FormElement
 	}
 	/**
 	 * Default action that is used to export to the codec
@@ -89,6 +91,8 @@ declare class Codec extends Deletable {
 	overwrite(content: any, path: string, callback: (path: string) => void): void
 	afterDownload(path: string): void
 	afterSave(path: string): void
+	exportCollection(collection: Collection): void
+	writeCollection(collection: Collection): void
 
 	/**
 	 * Return the stored export option values of the current project
@@ -140,7 +144,7 @@ declare class Codec extends Deletable {
 	 * List of export option inputs
 	 */
 	export_options: {
-		[key: string]: DialogFormElement
+		[key: string]: FormElement
 	}
 
 	format: ModelFormat

package/types/collection.d.ts

@@ -0,0 +1,76 @@
+interface CollectionOptions {
+	children?: string[]
+	name?: string
+	export_codec?: string
+	export_path?: string
+	visibility?: boolean
+}
+
+/**
+ * Collections are "selection presets" for a set of groups and elements in your project, independent from outliner hierarchy
+ */
+declare class Collection {
+    constructor(data?: CollectionOptions, uuid?: string);
+
+	selected: boolean
+	/**
+	 * List of direct children, referenced by UUIDs
+	 */
+	children: string[]
+	name: string
+	export_codec: string
+	export_path: string
+	visibility: boolean
+
+    extend(data: CollectionOptions): this;
+    select(event?: Event): this;
+    clickSelect(event: Event): void;
+	/**
+	 * Get all direct children
+	 */
+    getChildren(): OutlinerNode[];
+    add(): this;
+	/**
+	 * Adds the current outliner selection to this collection
+	 */
+    addSelection(): this;
+	/**
+	 * Returns the visibility of the first contained node that supports visibility. Otherwise returns true.
+	 */
+    getVisibility(): boolean;
+	/**
+	 * Get all children, including indirect ones
+	 */
+    getAllChildren(): any[];
+	/**
+	 * Toggle visibility of everything in the collection
+	 * @param event If the alt key is pressed, the result is inverted and the visibility of everything but the collection will be toggled
+	 */
+    toggleVisibility(event: Event): void;
+	/**
+	 * Opens the context menu
+	 */
+    showContextMenu(event: Event): this;
+    getUndoCopy(): {
+        uuid: string;
+        index: number;
+		[key: string]: any;
+    };
+    getSaveCopy(): {
+        uuid: string;
+		[key: string]: any;
+    };
+	/**
+	 * Opens the properties dialog
+	 */
+    propertiesDialog(): void;
+
+	/**
+	 * Get all collections
+	 */
+	static all(): Collection[]
+	/**
+	 * Get selected collections
+	 */
+	static selected(): Collection[]
+}