blockbench-types 4.4.0 → 4.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockbench-types",
-  "version": "4.4.0",
+  "version": "4.6.0",
   "description": "Blockbench typescript types",
   "main": "",
   "types": "types/index.d.ts",
@@ -22,6 +22,6 @@
     "@types/tinycolor2": "^1.4.3",
     "three": "^0.129.0",
     "vue": "^2.6.14",
-    "wintersky": "^1.1.0"
+    "wintersky": "^1.2.0"
   }
 }

package/types/action.d.ts

@@ -68,6 +68,23 @@ declare class Action extends BarItem {
      */
     side_menu?: Menu
 }
+interface ToggleOptions extends ActionOptions {
+    /**
+     * Default value of the toggle
+     */
+    default?: boolean
+    /**
+     * Method that gets called when the user changes the value of the toggle
+     */
+    onChange?(value: boolean): void
+}
+declare class Toggle extends Action {
+    constructor(id: string, options: ToggleOptions);
+    /**
+     * Updates the state of the toggle in the UI
+     */
+    updateEnabledState(): void
+}
 
 type RGBAColor = {r: number, g: number, b: number, a: number}
 type ViewMode = 'textured' | 'solid' | 'wireframe' | 'uv' | 'normal'
@@ -272,4 +289,8 @@ declare namespace Keybinds {
     const structure: {};
     function save (): void;
     function reset (): void;
-}
+}
+declare class _ToolToolbar extends Toolbar {
+    selected: Tool
+}
+declare const Toolbox: _ToolToolbar;

package/types/animation.d.ts

@@ -1,3 +1,8 @@
+declare class AnimationItem {
+    static all: AnimationItem[]
+    static selected: AnimationItem | null
+}
+
 interface AnimationOptions {
     name?: string
     loop?: string
@@ -8,7 +13,7 @@ interface AnimationOptions {
     snapping?: number
 }
 
-declare class Animation {
+declare class Animation extends AnimationItem {
     constructor(data: AnimationOptions);
     extend(data: AnimationOptions): this;
     getUndoCopy(options: any, save: any): {
@@ -37,9 +42,32 @@ declare class Animation {
     setLoop(value: any, undo: any): void;
     calculateSnappingFromKeyframes(): any;
     propertiesDialog(): void;
+
+    name: string
+    loop: string
+    override: boolean
+    anim_time_update: string
+    blend_weight: string
+    length: number
+    snapping: number
+    loop_delay: string
+    start_delay: string
+    path: string
+    playing: boolean
+    saved: boolean
+
+    markers: TimelineMarker[]
+    animators: {
+        [id: string]: GeneralAnimator
+    }
+    saved_name?: string
+    selected: boolean
+    type: string
+    uuid: string
 }
 
-namespace Animator {
+
+declare namespace Animator {
     const open: boolean
     const MolangParser: object
     const motion_trail: THREE.Object3D
@@ -90,15 +118,14 @@ declare class BoneAnimator extends GeneralAnimator {
     position: Keyframe[]
     scale: Keyframe[]
     getGroup(): Group
-    select
-    fillValues
-    pushKeyframe
-    doRender
-    displayRotation
-    displayPosition
-    displayScale
-    interpolate
-    displayFrame
+    fillValues: () => void
+    pushKeyframe: () => void
+    doRender: () => boolean
+    displayRotation: () => void
+    displayPosition: () => void
+    displayScale: () => void
+    interpolate: () => void
+    displayFrame: () => void
 }
 declare class NullObjectAnimator extends GeneralAnimator {
     name: string
@@ -107,11 +134,10 @@ declare class NullObjectAnimator extends GeneralAnimator {
     position: Keyframe[]
     scale: Keyframe[]
     getElement(): NullObject
-    select
-    doRender
-    displayPosition
-    displayIK
-    displayFrame
+    doRender: () => void
+    displayPosition: () => void
+    displayIK: () => void
+    displayFrame: () => void
 }
 declare class EffectAnimator extends GeneralAnimator {
     name: string
@@ -121,6 +147,11 @@ declare class EffectAnimator extends GeneralAnimator {
     scale: Keyframe[]
     pushKeyframe(keyframe): this
     displayFrame(in_loop): this
-    startPreviousSounds
+    startPreviousSounds: () => void
+}
+
+declare class TimelineMarker {
+    color: number
+    time: number
 }
 

package/types/animation_controller.d.ts

@@ -0,0 +1,112 @@
+type StateAnimationInput = string | {
+    [key: string]: string
+} | {
+    uuid: string
+    key?: string
+    animation?: string
+    blend_value?: number
+}
+type StateAnimation = {
+    uuid: string
+    key: string
+    animation: string
+    blend_value: number
+}
+
+interface AnimationControllerStateOptions {
+    name?: string
+    animations?: StateAnimationInput[]
+    transitions?: object[]
+    sounds?: object[]
+    particles?: object[]
+    on_entry?: string
+    on_exit?: string
+    blend_transition?: number
+    blend_via_shortest_path?: boolean
+}
+
+declare class AnimationControllerState {
+    constructor(controller: AnimationController, options?: AnimationControllerStateOptions)
+    controller: AnimationController
+    uuid: string
+    name: string
+    fold: {
+        animations: boolean
+        particles: boolean
+        sounds: boolean
+        on_entry: boolean
+        on_exit: boolean
+        transitions: boolean
+    }
+    muted: {
+        sound: boolean
+        particle: boolean
+    }
+    playing_sounds: HTMLAudioElement[]
+    animations: StateAnimation[]
+    transitions: object[]
+    sounds: object[]
+    particles: object[]
+    on_entry: string
+    on_exit: string
+    blend_transition: number
+    blend_via_shortest_path: boolean
+
+    extend: (data: AnimationControllerStateOptions) => void
+    getUndoCopy: () => object
+    compileForBedrock: () => object
+    select: (force?: boolean) => void
+    unselect: () => void
+    playEffects: () => void
+    scrollTo: () => void
+    rename: () => void
+    remove: (undo?: boolean) => void
+    createUniqueName: () => void
+
+    addAnimation: (animation?: Animation) => void
+    addTransition: (target_uuid?: string) => void
+    addParticle: (options?: {effect: string}) => void
+    addSound: (options?: {effect: string, file: string}) => void
+    openMenu: (event: Event) => void
+    /**
+     * Returns the current animation time of the state in seconds
+     */
+    getStateTime: () => number
+}
+
+interface AnimationControllerOptions {
+    name?: string
+    path?: string
+    initial_state?: string
+}
+
+
+declare class AnimationController extends AnimationItem {
+    constructor(data: AnimationControllerOptions);
+    name: string
+    path: string
+    uuid: string
+    playing: boolean
+    saved: boolean
+    selected: boolean
+    saved_name: string
+    states: AnimationControllerState[]
+    initial_state: string
+    selected_state: null | AnimationControllerState
+    extend(data: AnimationControllerOptions): this;
+    getUndoCopy(): object;
+    compileForBedrock(): object;
+    save(): this | undefined;
+    select(): this | undefined;
+    createUniqueName(references: AnimationController[]): any;
+    rename(): this;
+    add(undo: any): this;
+    remove(undo: any, remove_from_file?: boolean): this;
+    propertiesDialog(): void;
+    /**
+     * Updates the preview of the controller, including updating the animations and switching states if preview mode is set to play
+     */
+    updatePreview: () => void
+    togglePlayingState: (state?: boolean) => boolean
+    showContextMenu: (event: Event | HTMLElement) => void
+}

package/types/canvas.d.ts

@@ -208,4 +208,40 @@ declare const TickUpdates: {
     keyframes: undefined | true
     keyframe_selection: undefined | true
     keybind_conflicts: undefined | true
+}
+
+interface NodePreviewControllerOptions {
+    setup?: (element: OutlinerNode) => void
+    remove?: (element: OutlinerNode) => void
+    updateAll?: (element: OutlinerNode) => void
+    updateTransform?: (element: OutlinerNode) => void
+    updateVisibility?: (element: OutlinerNode) => void
+    updateSelection?: (element: OutlinerNode) => void
+    updateGeometry?: (element: OutlinerNode) => void
+    updateUV?: (element: OutlinerNode) => void
+    updateFaces?: (element: OutlinerNode) => void
+    updatePaintingGrid?: (element: OutlinerNode) => void
+    updateHighlight?: (element: OutlinerNode) => void
+}
+declare class NodePreviewController {
+    constructor(type: typeof OutlinerNode, options: NodePreviewControllerOptions)
+    type: typeof OutlinerNode
+    events: {
+        [event_name: string]: ((data) => void)[]
+    }
+    dispatchEvent(event_name: string, data: object)
+    on(event_name: string, cb: (data) => void)
+    removeListener(event_name: string, cb: (data) => void)
+
+    setup(element: OutlinerNode): void
+    remove(element: OutlinerNode): void
+    updateAll(element: OutlinerNode): void
+    updateTransform(element: OutlinerNode): void
+    updateVisibility(element: OutlinerNode): void
+    updateSelection(element: OutlinerNode): void
+    updateGeometry(instance: OutlinerNode): void
+    updateUV(instance: OutlinerNode): void
+    updateFaces(instance: OutlinerNode): void
+    updatePaintingGrid(instance: OutlinerNode): void
+    updateHighlight(instance: OutlinerNode): void
 }

package/types/codec.d.ts

@@ -1,8 +1,8 @@
 interface CodecOptions {
 	name: string
 	load?(model: any, file: object, add?: boolean): void
-	compile?(): void
-	parse?(): void
+	compile?(options?: object): void
+	parse?(data: any, path: string): void
 	export?(): void
 	/**
 	 * Generate a file name to suggest when exporting
@@ -10,6 +10,7 @@ interface CodecOptions {
 	fileName?(): string
 	startPath?(): string
 	write?(content: any, path: string): void
+	overwrite?(content: any, path: string, callback: ((path) => void)): void
 	afterDownload?(path): void
 	afterSave?(path): void
 
@@ -30,8 +31,8 @@ declare class Codec extends Deletable {
 	constructor(id: string, options: CodecOptions)
 
 	load?(model: any, file: object, add?: boolean): void
-	compile?(): any
-	parse?(model): void
+	compile?(options?: object): any
+	parse?(data: any, path: string): void
 	export?(): void
 	/**
 	 * Generate a file name to suggest when exporting
@@ -39,6 +40,7 @@ declare class Codec extends Deletable {
 	fileName?(): string
 	startPath?(): string
 	write?(content: any, path: string): void
+	overwrite?(content: any, path: string, callback: ((path) => void)): void
 	afterDownload?(path): void
 	afterSave?(path): void
 	on(event_name: string, callback: (data: object) => void): void

package/types/cube.d.ts

@@ -0,0 +1,109 @@
+interface FaceOptions {
+	texture?: Texture
+
+}
+declare class Face {
+	constructor()
+	texture: string | false | null
+
+	getTexture: () => Texture | null
+	/**
+	 * Returns a 2D rectangle around the UV face
+	 */
+	getBoundingRect: () => object
+	reset: () => void
+	/**
+	 * Returns a save copy of the face, ready for serialization. Set project to true to save for a bbmodel project file
+	 */
+	getSaveCopy: (project?: boolean) => object
+	/**
+	 * Get a copy for undo tracking
+	 */
+	getUndoCopy: () => Face
+}
+
+type CubeFaceDirection = 'north' | 'south' | 'east' | 'west' | 'up' | 'down'
+interface CubeFaceOptions extends FaceOptions {
+	uv?: [number, number, number, number]
+	rotation?: number
+	tint?: number
+	cullface?: CubeFaceDirection | ''
+	material_name?: string
+	enabled?: boolean
+}
+declare class CubeFace extends Face {
+	constructor(direction: CubeFaceDirection, data: CubeFaceOptions, cube: Cube)
+	cube: Cube
+	direction: CubeFaceDirection
+	uv: [number, number, number, number]
+	readonly uv_size: ArrayVector2
+	rotation: number
+	tint: number
+	cullface: CubeFaceDirection | ''
+	material_name: string
+	enabled: boolean
+	
+	extend(data: CubeFaceOptions)
+	getVertexIndices: () => [number, number, number, number]
+}
+
+interface CubeOptions {
+	name: string
+	autouv: 1 | 2 | 3
+	shade: boolean
+	mirror_uv: boolean
+	inflate: number
+	color: number
+	visibility: boolean
+	from: ArrayVector3
+	to: ArrayVector3
+	rotation: ArrayVector3
+	origin: ArrayVector3
+	/**
+	 * UV position for box UV mode
+	 */
+	uv_offset: ArrayVector2
+}
+declare class Cube extends OutlinerElement {
+	constructor (options: Partial<CubeOptions>, uuid?: string)
+	autouv: 1 | 2 | 3
+	shade: boolean
+	mirror_uv: boolean
+	inflate: number
+	visibility: boolean
+	from: ArrayVector3
+	to: ArrayVector3
+	rotation: ArrayVector3
+	origin: ArrayVector3
+	faces: {
+		[fkey: string]: CubeFaces
+	}
+	/**
+	 * UV position for box UV mode
+	 */
+	uv_offset: ArrayVector2
+
+	extend(options: Partial<CubeOptions>): this
+	/**
+	 * Calculates and returns the size of a cube across a certain axis. If the axis argument is omitted, it returns all sizes as an array vector.
+	 */
+	size: (axis?: number, floored?: boolean) => number | ArrayVector3
+	rotationAxis: () => void
+	getUndoCopy: (aspects?: object) => void
+	getSaveCopy: (project?: boolean) => void
+	roll: (axis: number, steps: number, origin: ArrayVector3) => void
+	flip: (axis: number, center: number, skipUV?: boolean) => void
+	transferOrigin: (origin: ArrayVector3, update?: boolean) => void
+	getWorldCenter: () => THREE.Vector3
+	getGlobalVertexPositions: () => void
+	setUVMode: (box_uv: boolean) => void
+	setColor: (color: number) => void
+	applyTexture: (texture: Texture, faces: true | undefined | CubeFaceDirection[]) => void
+	mapAutoUV: () => void
+	moveVector: (offset: ArrayVector3, axis: number, update?: boolean) => void
+	resize: (value: number, axis: number, negative: boolean, allow_negative?: boolean, bidirectional?: boolean) => void
+
+	static all: Cube[]
+	static selected: Cube[]
+}
+

package/types/dialog.d.ts

@@ -1,18 +1,22 @@
 interface DialogFormElement {
 	label: string
 	description?: string
-	type: 'text' | 'number' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
+	type: 'text' | 'number' | 'range' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info' | 'buttons'
 	nocolon?: boolean
+	full_width?: boolean
 	readonly?: boolean
 	value?: any
 	placeholder?: string
 	text?: string
+	editable_range_label?: boolean
 	colorpicker?: any
 	min?: number
 	max?: number
 	step?: number
 	height?: number
 	options?: object
+	buttons?: string[]
+	click?: (button_index: number) => void
 }
 
 type FormResultValue = string|number|boolean|[]
@@ -22,7 +26,7 @@ interface ActionInterface {
 	description?: string
 	icon: string,
 	click: (event: Event) => void
-	condition: Condition
+	condition: ConditionResolvable
 }
 interface DialogOptions {
 	title: string
@@ -54,7 +58,7 @@ interface DialogOptions {
 	/**
 	 * Array of HTML object strings for each line of content in the dialog.
 	 */
-	lines?: (string|HTMLElement)[]
+	lines?: (HTMLElement | {label?: string, widget?: Widget|(() => Widget), nocolon?: boolean} | string)[]
 	/**
 	 * Creates a form in the dialog
 	 */
@@ -86,6 +90,10 @@ interface DialogOptions {
 	 * List of buttons
 	 */
 	buttons?: string[]
+	/**
+	 * Unless set to false, clicking on the darkened area outside of the dialog will cancel the dialog.
+	 */
+	cancel_on_click_outside?: boolean
 }
 
 interface DialogSidebarOptions {
@@ -111,11 +119,13 @@ declare class DialogSidebar {
 }
 
 declare class Dialog {
-	constructor (options: DialogOptions)
+	constructor(id: string, options: DialogOptions)
+	constructor(options: DialogOptions)
 
 	id: string
 	component: Vue.Component
 	sidebar: DialogSidebar | null
+	content_vue: Vue | null
 
 
 	show: () => Dialog
@@ -151,4 +161,73 @@ declare class Dialog {
 	 * Currently opened dialog
 	 */
 	static open: Dialog | null
+	static stack: Dialog[]
+}
+
+interface ShapelessDialogOptions {
+	title: string
+	/**
+	 * Default button to press to confirm the dialog. Defaults to the first button.
+	 */
+	confirmIndex?: number
+	/**
+	 * Default button to press to cancel the dialog. Defaults to the last button.
+	 */
+	cancelIndex?: number
+	/**
+	 *  Function to execute when the user confirms the dialog
+	 */
+	onConfirm?: (formResult: object) => void
+	/**
+	 * Function to execute when the user cancels the dialog
+	 */
+	onCancel?: () => void
+	/**
+	 * Triggered when the user presses a specific button
+	 */
+	onClose?: (button_index: number, event?: Event) => void
+	/**
+	 * Vue component
+	 */
+	component?: Vue.Component
+	/**
+	 * Unless set to false, clicking on the darkened area outside of the dialog will cancel the dialog.
+	 */
+	cancel_on_click_outside?: boolean
+}
+declare class ShapelessDialog extends Dialog {
+	constructor (id: string, options: ShapelessDialogOptions)
+
+	id: string
+	component: Vue.Component
+
+
+	show: () => Dialog
+	hide: () => Dialog
+	/**
+	 * Triggers the confirm event of the dialog.
+	 */
+	confirm: (event?: Event) => void
+	/**
+	 * Triggers the cancel event of the dialog.
+	 */
+	cancel: (event?: Event) => void
+	/**
+	 * Closes the dialog using the index of the pressed button
+	 */
+	close: (button: number, event?: Event) => void
+	/**
+	 * If the dialog contains a form, return the current values of the form
+	 */
+	getFormResult(): {
+		[key: string]: FormResultValue
+	}
+	/**
+	 * Set the values of the dialog form inputs
+	 */
+	setFormValues(values: {[key: string]: FormResultValue}): void
+	/**
+	 * Delete the dialog object, causing it to be re-build from scratch on next open
+	 */
+	delete(): void
 }

package/types/display_mode.d.ts

@@ -0,0 +1,37 @@
+interface DisplaySlotOptions {
+	rotation?: ArrayVector3
+	translation?: ArrayVector3
+	scale?: ArrayVector3
+	mirror?: [boolean, boolean, boolean]
+}
+
+declare class DisplaySlot {
+	constructor(id: string, data: DisplaySlotOptions)
+	rotation: ArrayVector3
+	translation: ArrayVector3
+	scale: ArrayVector3
+	mirror: [boolean, boolean, boolean]
+	/**
+	 * Reset slot to default values
+	 */
+	default: () => this
+	extend: (data: DisplaySlotOptions) => this
+	copy: () => {
+		rotation: ArrayVector3
+		translation: ArrayVector3
+		scale: ArrayVector3
+		mirror: [boolean, boolean, boolean]
+	}
+	/**
+	 * Generate the values of the slot for export
+	 */
+	export: () => {
+		rotation: ArrayVector3
+		translation: ArrayVector3
+		scale: ArrayVector3
+	} | undefined
+	/**
+	 * Visually update the UI with the data from this slot if selected
+	 */
+	update: () => this
+}

package/types/file_system.d.ts

@@ -25,6 +25,10 @@ declare namespace Blockbench {
      * Reads the content from the specified files. Desktop app only.
      */
     export function read(files: string[], options?: ReadOptions, callback?: (files: FileResult[]) => void): void
+    /**
+     * Reads the content from the specified files. Desktop app only.
+     */
+    export function readFile(files: string[], options?: ReadOptions, callback?: (files: FileResult[]) => void): void
 
 
 
@@ -125,7 +129,7 @@ declare namespace Blockbench {
         /**
          * Whether or not to enable the drag handler
          */
-        condition?: Condition
+        condition?: ConditionResolvable
         /**
          * Drop target element
          */