blockbench-types 4.9.0 → 4.11.0

package/types/animation.d.ts

@@ -1,177 +1,211 @@
+/// <reference path="./blockbench.d.ts"/>
+
 declare class AnimationItem {
-    static all: AnimationItem[]
-    static selected: AnimationItem | null
+	static all: _Animation[]
+	static selected: _Animation | null
+	getUndoCopy?(options?: any, save?: any): AnimationOptions
 }
 
 interface AnimationOptions {
-    name?: string
-    path?: string
-    loop?: 'once' | 'hold' | 'loop'
-    override?: boolean
-    anim_time_update?: string
-    blend_weight?: string
-    length?: number
-    snapping?: number
+	name?: string
+	uuid?: string
+	path?: string
+	loop?: 'once' | 'hold' | 'loop'
+	override?: boolean
+	anim_time_update?: string
+	blend_weight?: string
+	length?: number
+	snapping?: number
+}
+
+interface AnimationUndoCopy {
+	uuid: any
+	name: any
+	loop: any
+	override: any
+	anim_time_update: any
+	blend_weight: any
+	length: any
+	snapping: any
+	selected: any
 }
 
 declare class _Animation extends AnimationItem {
-    constructor(data: AnimationOptions);
-    extend(data: AnimationOptions): this;
-    getUndoCopy(options?: {}, save?: any): {
-        uuid: any;
-        name: any;
-        loop: any;
-        override: any;
-        anim_time_update: any;
-        blend_weight: any;
-        length: any;
-        snapping: any;
-        selected: any;
-    };
-    /**
-     * Compiles the JSON tree of the animation for the Minecraft Bedrock Edition animation format.
-     */
-    compileBedrockAnimation(): object;
-    save(): this | undefined;
-    select(): this | undefined;
-    setLength(length: number): void;
-    createUniqueName(references: _Animation[]): any;
-    rename(): this;
-    togglePlayingState(state: any): any;
-    showContextMenu(event: any): this;
-    /**
-     * Returns (if necessary creates) the animator of a specific bone of the animation
-     */
-    getBoneAnimator(group: OutlinerNode): BoneAnimator;
-    /**
-     * Adds the animation to the current project and to the interface
-     * @param undo If true, the addition of the animation will be registered as an edit
-     */
-    add(undo?: any): this;
-    remove(undo: any, remove_from_file?: boolean): this;
-    getMaxLength(): number;
-    setLoop(value: any, undo: any): void;
-    /**
-     * Calculate the snapping value that the animation should use, based on the time codes of the keyframes that it holds. Directly updates the value, but also returns it as a number (snaps per second)
-     */
-    calculateSnappingFromKeyframes(): number;
-    /**
-     * Opens the properties dialog
-     */
-    propertiesDialog(): void;
+	constructor(data?: AnimationOptions)
+	extend(data?: AnimationOptions): this
+	getUndoCopy(options?: {}, save?: any): AnimationUndoCopy
+	/**
+	 * Compiles the JSON tree of the animation for the Minecraft Bedrock Edition animation format.
+	 */
+	compileBedrockAnimation(): any
+	save(): this | undefined
+	select(): this | undefined
+	setLength(length?: number): void
+	createUniqueName(references: _Animation[]): any
+	rename(): this
+	togglePlayingState(state: any): any
+	showContextMenu(event: any): this
+	/**
+	 * Returns (if necessary creates) the animator of a specific outliner node of this animation
+	 */
+	getBoneAnimator(node?: OutlinerNode): BoneAnimator
+	/**
+	 * Adds the animation to the current project and to the interface
+	 * @param undo If true, the addition of the animation will be registered as an edit
+	 */
+	add(undo?: boolean): this
+	remove(undo: boolean, remove_from_file?: boolean): this
+	getMaxLength(): number
+	setLoop(value: any, undo: any): void
+	/**
+	 * Calculate the snapping value that the animation should use, based on the time codes of the keyframes that it holds. Directly updates the value, but also returns it as a number (snaps per second)
+	 */
+	calculateSnappingFromKeyframes(): number
+	/**
+	 * Opens the properties dialog
+	 */
+	propertiesDialog(): void
 
-    name: string
-    loop: 'once' | 'hold' | 'loop'
-    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
+	name: string
+	uuid: string
+	loop: 'once' | 'hold' | 'loop'
+	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
+	time: number
 
-    markers: TimelineMarker[]
-    animators: {
-        [id: string]: GeneralAnimator
-    }
-    saved_name?: string
-    selected: boolean
-    type: string
-    uuid: string
+	effects?: EffectAnimator
+
+	markers: TimelineMarker[]
+	animators: {
+		[id: string]: GeneralAnimator | undefined
+	}
+	saved_name?: string
+	selected: boolean
+	type: string
 }
 
+interface MolangAutoCompletionItem {
+	text: string
+	label: string | undefined
+	overlap: number
+}
 
 declare namespace Animator {
-    const open: boolean
-    const MolangParser: object
-    const possible_channels: unknown[];
-    const motion_trail: THREE.Object3D
-    const motion_trail_lock: boolean
-    const particle_effects: object
-    function showDefaultPose(no_matrix_update?: boolean): void
-    function resetParticles(): void
-    function showMotionTrail(target?: Group): void
-    /**
-     * Updates the preview based on the current time
-     */
-    function preview(): void
-    function loadParticleEmitter(path: string, content: string): void
-    /**
-     * Import a Bedrock animation file
-     * @param file File object
-     * @param animation_filter List of names of animations to import
-     */
-    function loadFile(file: object, animation_filter?: string[])
-
-
+	const open: boolean
+	const MolangParser: Molang
+	const possible_channels: unknown[]
+	const motion_trail: THREE.Object3D
+	const motion_trail_lock: boolean
+	const particle_effects: any
+	const animations: _Animation[]
+	const selected: _Animation | undefined
+	function showDefaultPose(no_matrix_update?: boolean): void
+	function resetParticles(): void
+	function showMotionTrail(target?: Group): void
+	/**
+	 * Updates the preview based on the current time
+	 */
+	function preview(in_loop?: boolean): void
+	function loadParticleEmitter(path: string, content: string): void
+	/**
+	 * Import a Bedrock animation file
+	 * @param file File any
+	 * @param animation_filter List of names of animations to import
+	 */
+	function loadFile(file: any, animation_filter?: string[]): void
+	function resetLastValues(): void
+	function autocompleteMolang(
+		text: string,
+		position: number,
+		type: string
+	): MolangAutoCompletionItem[]
 }
 
 interface AddChannelOptions {
-    name?: string
-    transform?: boolean
-    mutable?: boolean
-    max_data_points?: number
+	name?: string
+	transform?: boolean
+	mutable?: boolean
+	max_data_points?: number
+}
+interface Channel {
+	name: string
+	transform: boolean
+	mutable: boolean
+	max_data_points: number
 }
 declare class GeneralAnimator {
-    constructor(uuid: string, animation: _Animation, name: string)
-    uuid: string
-    keyframes: _Keyframe[]
-    select(): this
-    addToTimeline(): this
-    addKeyframe(data: KeyframeOptions, uuid?: string): _Keyframe
-    createKeyframe(): _Keyframe
-    getOrMakeKeyframe(): {before: _Keyframe, result: _Keyframe}
-    toggleMuted(channel: string): this
-    scrollTo(): this
+	constructor(uuid: string | null, animation: _Animation, name: string)
+	uuid: string
+	keyframes: _Keyframe[]
+	animation: _Animation
+	expanded: boolean
+	selected: boolean
+	select(): this
+	addToTimeline(): this
+	addKeyframe(data: KeyframeOptions, uuid?: string): _Keyframe
+	createKeyframe(): _Keyframe
+	getOrMakeKeyframe(): { before: _Keyframe; result: _Keyframe }
+	toggleMuted(channel: string): this
+	scrollTo(): this
 
-    static addChannel(channel: string, options: AddChannelOptions)
+	static addChannel(channel: string, options: AddChannelOptions): void
+	channels: {
+		[channel: string]: Channel
+	}
+	muted: {
+		[channel: string]: boolean | undefined
+	};
+	[channel: string]: any
 }
 
 declare class BoneAnimator extends GeneralAnimator {
-    name: string
-    uuid: string
-    rotations: _Keyframe[]
-    position: _Keyframe[]
-    scale: _Keyframe[]
-    getGroup(): Group
-    fillValues(): void
-    pushKeyframe(): void
-    doRender(): boolean
-    displayRotation(): void
-    displayPosition(): void
-    displayScale(): void
-    interpolate(): void
-    displayFrame(): void
+	name: string
+	uuid: string
+	rotations: _Keyframe[]
+	position: _Keyframe[]
+	scale: _Keyframe[]
+	getGroup(): Group
+	fillValues(): void
+	pushKeyframe(): void
+	doRender(): boolean
+	displayRotation(): void
+	displayPosition(): void
+	displayScale(): void
+	interpolate(channel: string, allow_expression?: boolean, axis?: string): ArrayVector3
+	displayFrame(multiplier?: number): void
 }
 declare class NullObjectAnimator extends GeneralAnimator {
-    name: string
-    uuid: string
-    rotations: _Keyframe[]
-    position: _Keyframe[]
-    scale: _Keyframe[]
-    getElement(): NullObject
-    doRender(): void
-    displayPosition(): void
-    displayIK(): void
-    displayFrame(): void
+	name: string
+	uuid: string
+	rotations: _Keyframe[]
+	position: _Keyframe[]
+	scale: _Keyframe[]
+	getElement(): NullObject
+	doRender(): void
+	displayPosition(): void
+	displayIK(): void
+	displayFrame(): void
 }
 declare class EffectAnimator extends GeneralAnimator {
-    constructor(animation: _Animation)
-    name: string
-    uuid: string
-    particle: _Keyframe[]
-    sound: _Keyframe[]
-    timeline: _Keyframe[]
-    pushKeyframe(keyframe): this
-    displayFrame(in_loop): this
-    startPreviousSounds(): void
+	name: string
+	uuid: string
+	rotations: _Keyframe[]
+	position: _Keyframe[]
+	scale: _Keyframe[]
+	pushKeyframe(keyframe: _Keyframe): this
+	displayFrame(in_loop?: boolean): void
+	startPreviousSounds(): void
 }
 
 declare class TimelineMarker {
-    color: number
-    time: number
+	color: number
+	time: number
 }
-

package/types/animation_controller.d.ts

@@ -1,118 +1,124 @@
-type StateAnimationInput = string | {
-    [key: string]: string
-} | {
-    uuid: string
-    key?: string
-    animation?: string
-    blend_value?: number
-}
+/// <reference path="./blockbench.d.ts"/>
+
+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
+	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
+	name?: string
+	animations?: StateAnimationInput[]
+	transitions?: any[]
+	sounds?: any[]
+	particles?: any[]
+	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
+	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: any[]
+	sounds: any[]
+	particles: any[]
+	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
+	extend(data: AnimationControllerStateOptions): void
+	getUndoCopy(): any
+	compileForBedrock(): any
+	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
+	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
+	name?: string
+	uuid?: string
+	path?: string
+	initial_state?: string
 }
 
 /**
  * Animation Controllers are state machines used for Minecraft: Bedrock Edition models to control and blend between animations.
  */
 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[]): string | boolean;
-    rename(): this;
-    /**
-     * Adds the animation controller to the current project and to the interface
-     * @param undo If true, the addition of the animation controller will be registered as an edit
-     */
-    add(undo: any): this;
-    remove(undo?: boolean, 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
+	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(): any
+	compileForBedrock(): any
+	save(): this | undefined
+	select(): this | undefined
+	createUniqueName(references: AnimationController[]): string | boolean
+	rename(): this
+	/**
+	 * Adds the animation controller to the current project and to the interface
+	 * @param undo If true, the addition of the animation controller will be registered as an edit
+	 */
+	add(undo?: boolean): this
+	remove(undo?: boolean, 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
 }