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

package/custom/animation.d.ts

@@ -64,7 +64,7 @@ declare class _Animation extends AnimationItem {
 	save(): this | undefined
 	select(): this | undefined
 	setLength(length?: number): void
-	createUniqueName(references: _Animation[]): any
+	createUniqueName(references?: _Animation[]): any
 	setScopeFromAnimators(): number | undefined
 	rename(): this
 	togglePlayingState(state: any): any
@@ -254,3 +254,4 @@ declare class TimelineMarker {
 	color: number
 	time: number
 }
+declare const WinterskyScene: Wintersky.Scene

package/custom/blockbench.d.ts

@@ -5,7 +5,7 @@
 /// <reference types="wintersky" />
 
 /// <reference types="./texture_group" />
-/// <reference types="./toolbars" />
+/// <reference types="./keybind" />
 /// <reference types="./animation" />
 /// <reference types="./animation_controller" />
 /// <reference types="./canvas_frame" />
@@ -18,14 +18,13 @@
 /// <reference types="./group" />
 /// <reference types="./interface" />
 /// <reference types="./keyframe" />
-/// <reference types="./menu" />
+/// <reference types="./menu_bar" />
 /// <reference types="./mesh" />
 /// <reference types="./spline_mesh" />
 /// <reference types="./misc" />
 /// <reference types="./molang" />
 /// <reference types="./outliner" />
 /// <reference types="./painter" />
-/// <reference types="./preview" />
 /// <reference types="./preview_scene" />
 /// <reference types="./edit_session" />
 /// <reference types="./screencam" />
@@ -69,3 +68,6 @@ declare module "*.bbtheme" {
 	const value: string | any;
 	export default value;
 }
+declare module "*.png"
+declare module "*.webp"
+declare module "*.jpeg"

package/custom/canvas.d.ts

@@ -74,6 +74,7 @@ declare namespace Canvas {
 	const bones: {
 		[uuid: UUID]: THREE.Object3D
 	}
+	let outlines: THREE.Object3D
 	/**
 	 * Main scene, shared across all tabs
 	 */
@@ -108,13 +109,17 @@ declare namespace Canvas {
 	const ground_plane: THREE.Mesh
 	const brush_outline: THREE.Mesh
 
-	const show_gizmos: boolean
+	let show_gizmos: boolean
+	let ground_animation: boolean
 
 	const global_light_color: THREE.Color
-	const global_light_side: number
+	let global_light_side: number
 
 	const face_order: ['east', 'west', 'up', 'down', 'south', 'north']
 
+	const hover_helper_line: THREE.LineSegments
+	const hover_helper_vertex: THREE.Points
+
 	/**
 	 * Raycast on the currently selected preview
 	 */
@@ -129,6 +134,8 @@ declare namespace Canvas {
 	function clear(): void
 	function buildGrid(): void
 	function updateShading(): void
+	function updateViewMode(): void
+	function updateCubeHighlights(hover_cube: OutlinerElement, force_off?: boolean): void
 	/**
 	 * Updates selected aspects of the preview
 	 * @param options
@@ -188,7 +195,7 @@ declare namespace Canvas {
 	/**
 	 * Update the position of the origin / pivot point gizmo
 	 */
-	function updateOrigin(): boolean
+	function updatePivotMarker(): boolean
 	/**
 	 * Update the position and shape of the specified cube
 	 * @param cube Cube to update
@@ -229,12 +236,14 @@ declare namespace Canvas {
 	 * Calculate the size of the model, in the currently displayed shape. Returns [width, height] in blockbench units
 	 */
 	function getModelSize(): [number, number]
+	function getSelectionBounds(): THREE.Box3
 }
 
 /**
  * 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 {
+	private function Run(): void
 	let interface: undefined | true
 	let outliner: undefined | true
 	let selection: undefined | true
@@ -269,6 +278,13 @@ interface NodePreviewControllerOptions {
 	updateHighlight?(element: OutlinerNode, ...args: any[]): void
 	[key: string]: any
 }
+interface ViewportRectangleOverlapContext {
+	projectPoint: (vector: THREE.Vector3) => ArrayVector2
+	extend_selection: boolean
+	rect_start: ArrayVector2
+	rect_end: ArrayVector2
+	preview: Preview
+}
 declare class NodePreviewController {
 	constructor(
 		type: typeof OutlinerElement | typeof OutlinerNode,
@@ -304,4 +320,5 @@ declare class NodePreviewController {
 	updateFaces(instance: OutlinerNode): void
 	updatePaintingGrid(instance: OutlinerNode): void
 	updateHighlight(instance: OutlinerNode, ...args: any[]): void
+	viewportRectangleOverlap(element: OutlinerNode, context: ViewportRectangleOverlapContext)
 }

package/custom/codec.d.ts

@@ -36,8 +36,8 @@ interface CodecOptions {
 	support_partial_export?: boolean
 	support_offset?: boolean
 	load_filter?: {
-		extensions: string[]
-		type: 'json' | 'text'
+		extensions: string[] | (() => string[])
+		type: 'json' | 'text' | 'image'
 		condition?: ConditionResolvable
 	}
 	/**

package/custom/cube.d.ts

@@ -146,6 +146,6 @@ declare class CubeFace extends Face {
 	material_name: string
 	enabled: boolean
 
-	extend(data: CubeFaceOptions): void
+	extend(data: CubeFaceOptions): this
 	getVertexIndices(): [number, number, number, number]
 }

package/custom/display_mode.d.ts

@@ -8,6 +8,8 @@ declare const DisplayMode: {
 	display_slot: string
 	display_area: any
 	display_base: any
+	animate_preview: Preview
+	groundAnimation(): void
 }
 
 declare type DisplaySlotName =
@@ -99,7 +101,7 @@ declare const displayReferenceObjects: {
 		inventory_full: refModel<'inventory_full'>
 		hud: refModel<'hud'>
 	}
-	active: refModel<keyof typeof displayReferenceObjects.refmodels> | ''
+	active: refModel<keyof typeof displayReferenceObjects.refmodels>
 	/* Clears the active display model */
 	clear(): void
 	bar(buttons: any): void
@@ -135,3 +137,5 @@ declare class refModel<ID extends string> {
 	buildFrameTopInvisible(): void
 	updateBasePosition(): void
 }
+
+declare function changeDisplaySkin(): void

package/custom/global.d.ts

@@ -25,7 +25,6 @@ declare global {
 	 * @deprecated Use {@link Outliner.selected} instead
 	 */
 	let selected: OutlinerElement[]
-	const Toolbars: Record<string, Toolbar>
 
 	function rotateOnAxis(modify: OutlinerNode, axis: number, slider?: boolean): void
 	function afterRotateOnAxis(): void
@@ -71,7 +70,7 @@ declare global {
 		/**
 		 * Checks if the absolute difference between a and b is smaller than epsilon
 		 */
-		epsilon(a: number, b: number, epsilon: number): boolean
+		epsilon(a: number, b: number, epsilon?: number): boolean
 		/**
 		 * Take a rotation value in degrees, and trim it to a value between -180 and 180, while keeping the same angle
 		 */

package/custom/interface.d.ts

@@ -1,5 +1,10 @@
 /// <reference types="./blockbench"/>
 
+/**
+ * Update the size of everything in the UI after the window has been resized or other UI size changes have happeped
+ * @param event 
+ */
+declare function resizeWindow(event?: Event): void
 
 declare namespace Interface {
 	function createElement(

package/custom/{toolbars.d.ts → keybind.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Toolbars and related things
+ * Keybindings and action control
  */
 /// <reference types="./blockbench"/>
 
@@ -8,7 +8,7 @@ declare global {
 		/**
 		 * Main key, can be a numeric keycode or a lower case character
 		 */
-		key: number | string
+		key?: number | string
 		ctrl?: boolean
 		shift?: boolean
 		alt?: boolean
@@ -42,6 +42,7 @@ declare global {
 		ctrl?: boolean
 		shift?: boolean
 		alt?: boolean
+		meta?: boolean
 		variations?: {
 			[key: string]: ModifierKey
 		}
@@ -115,75 +116,6 @@ declare global {
 		static no_overlap(k1: KeybindItem, k2: KeybindItem): boolean
 	}
 
-
-	class MenuSeparator {
-		constructor(id?: string, label?: string)
-		id: string
-		menu_node: HTMLLIElement
-		label?: string
-		menu_node?: HTMLElement
-	}
-
-	interface ToolbarOptions {
-		id?: string
-		name?: string
-		/**
-		 * If true, the toolbar will display a label abovee
-		 */
-		label?: boolean
-		condition?: ConditionResolvable
-		/**
-		 * If true, the toolbar will only take as much width as needed
-		 */
-		narrow?: boolean
-		vertical?: boolean
-		/**
-		 * Default content of the toolbar. Separators are available, where _ = separator, + = spaces, # = line break
-		 */
-		children: ('_' | '+' | '#' | string | BarItem)[]
-	}
-	export class Toolbar {
-		id: string
-		name: string
-		label: boolean
-		label_node: HTMLElement
-		condition: ConditionResolvable
-		children: (BarItem | string)[]
-		no_wrap: boolean
-		narrow: boolean
-		vertical: boolean
-		default_children: (BarItem | string)[]
-		/*private*/ positionLookup: any
-		/*private*/ condition_cache: any
-		/*private*/ previously_enabled: any
-		/*private*/ postload: any
-		/*private*/ menu: any
-		node: HTMLElement
-		constructor(id: string, data: ToolbarOptions)
-		constructor(data: ToolbarOptions)
-		build(data: any, force: any): this
-		contextmenu(event: Event): void
-		editMenu(): this
-		add(action: any, position?: number): this
-		remove(action: BarItem, update: boolean = false): this
-		update(): this
-		toPlace(place: any): this
-		save(): this
-		reset(): this
-		condition(): boolean
-	}
-	export namespace BARS {
-		const stored: {}
-		const editing_bar: undefined | Toolbar
-		const action_definers: (() => void)[]
-		const condition: any
-		function defineActions(definer: any): void
-		function setupActions(): void
-		function setupToolbars(): void
-		function setupVue(): void
-		function updateConditions(): void
-		function updateToolToolbar(): void
-	}
 	/**
 	 * A dialog-based interface to search and trigger actions and other things
 	 */
@@ -212,11 +144,7 @@ declare global {
 		function reset(): void
 		function loadKeymap(id: string, from_start_screen: boolean = false): true | void
 	}
-	class _ToolToolbar extends Toolbar {
-		selected: Tool
-		original: any
-	}
-	const Toolbox: _ToolToolbar
+	const Vertexsnap: any
 }
 
 export {}

package/custom/menu_bar.d.ts

@@ -0,0 +1,66 @@
+/// <reference types="./blockbench"/>
+
+
+declare interface BarMenuOptions {
+	name?: string
+	icon?: IconString
+	condition?: ConditionResolvable
+}
+
+/**
+ * Creates a new menu in the menu bar
+ */
+declare class BarMenu extends Menu {
+	constructor(id: string, structure: MenuItem[], options?: BarMenuOptions)
+	type: 'bar_menu'
+	id: string
+	condition?: ConditionResolvable
+	name: string
+	label: HTMLElement
+	structure: MenuItem[]
+	/**
+	 * Visually highlights an action within the menu, until the user opens the menu
+	 */
+	highlight(action: Action): void
+}
+
+declare namespace MenuBar {
+	const mode_switcher_button: null | HTMLDivElement
+	const menus: {
+		file: Menu
+		edit: Menu
+		transform: Menu
+		uv: Menu
+		texture: Menu
+		animation: Menu
+		keyframe: Menu
+		display: Menu
+		tools: Menu
+		view: Menu
+		help: Menu
+		[id: string]: Menu
+	}
+	const keys: string[]
+	let open: Menu | null
+	/**
+	 * Add a new menu to the menu bar
+	 * @param menu The BarMenu to add
+	 * @param position Specify the position in the menu list where to add insert the menu. Can either be an index in the list of all menus, or the ID of the menu to insert right from.
+	 */
+	function addMenu(menu: BarMenu, position?: number | string): void
+	/**
+	 * Adds an action to the menu structure
+	 * @param action Action to add
+	 * @param path Path pointing to the location. Use the ID of each level of the menu, or index or group within a level, separated by a point. For example, `file.export.0` places the action at the top position of the Export submenu in the File menu.
+	 */
+	function addAction(action: Action, path?: string): void
+	/**
+	 *
+	 * @param path Path pointing to the location. Use the ID of each level of the menu, or index or group within a level, or item ID, separated by a point. For example, `export.export_special_format` removes the action "Export Special Format" from the Export submenu.
+	 */
+	function removeAction(path: string): void
+	/**
+	 * Update the menu bar
+	 */
+	function update(): void
+}

package/custom/misc.d.ts

@@ -86,6 +86,7 @@ interface BlockbenchEventMap {
 	unselect_mode: { mode: Mode }
 	change_active_panel: any
 	resize_window: {event?: Event}
+	change_view_mode: {view_mode: string, previous_view_mode: string}
 	press_key: {input_in_focus?: HTMLElement, event: KeyboardEvent, capture: () => void}
 	select_format: {format: ModelFormat, project: ModelProject}
 	convert_format: {format: ModelFormat, old_format: ModelFormat}
@@ -155,13 +156,14 @@ declare function updateSelection(): void
 declare var LZUTF8: any
 
 declare function unselectAllElements(exceptions?: OutlinerNode[]): void
-declare function updateCubeHighlights(hover_cube: Cube, force_off: boolean): void
 declare function getRescalingFactor(angle: number): number
 /**
  * Get the world-space center of the selection
  * @param all If true, calculate the center of all elements instead of just selected
  */
 declare function getSelectionCenter(all: boolean = false): ArrayVector3
+declare function getSpatialInterval(event?: Event): number;
+declare function getRotationInterval(event?: Event): number;
 
 declare const Pressing: {
 	shift: boolean
@@ -175,14 +177,20 @@ declare const Pressing: {
 }
 
 declare const Prop = {
-	active_panel: string
+	active_panel: string,
+	fps: number,
+	show_left_bar: boolean,
+	show_right_bar: boolean,
 }
 declare const Project: ModelProject
-
-declare function updateCubeHighlights(hover_cube: Cube, force_off: boolean): void
-declare function getRescalingFactor(angle: number): number
+declare const ReferenceImageMode: any
 
 declare function isStringNumber(value: any): boolean
 
 declare function marked(text: string): string
 declare function pureMarked(text: string): string
+
+declare type ReferenceImage = any
+declare const ReferenceImage = any
+declare type SplineMesh = typeof OutlinerElement & Record<string, any>
+declare const SplineMesh: typeof OutlinerElement

package/custom/painter.d.ts

@@ -30,6 +30,7 @@ declare namespace Painter {
 	function getMirrorElement(element: OutlinerElement, symmetry_axes: number[]): void
 	function updateNslideValues(): void
 	function getBlendModeCompositeOperation(blend_mode?: string): string
+	function getCanvasToolPixelCoords(uv_point: {x: number, y: number}, texture: Texture): ArrayVector2
 	function getCanvas(texture: Texture): HTMLCanvasElement
 	function copyCanvas(original_canvas: HTMLCanvasElement): HTMLCanvasElement
 	function scanCanvas(
@@ -40,7 +41,7 @@ declare namespace Painter {
 		h: number,
 		cb: ((px: number, py: number, color: [r: number, g: number, b: number, a: number]) => [number, number, number, number] | void)
 	): void
-	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): void
+	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): tinycolor
 	function modifyCanvasSection(
 		ctx: CanvasRenderingContext2D,
 		x: number,
@@ -68,3 +69,34 @@ declare namespace Painter {
 	function openBrushOptions(): void
 	function loadBrushPreset(preset: any): void
 }
+
+	declare interface BarItemRegistry {
+		paint_secondary_color: KeybindItem
+		pan_tool: Tool
+		brush_tool: Tool
+		copy_brush: Tool
+		fill_tool: Tool
+		eraser: Tool
+		color_picker: Tool
+		draw_shape_tool: Tool
+		gradient_tool: Tool
+		move_layer_tool: Tool
+		brush_shape: BarSelect
+		draw_shape_type: BarSelect
+		blend_mode: BarSelect
+		fill_mode: BarSelect
+		copy_brush_mode: BarSelect
+		selection_tool_operation_mode: BarSelect
+		expand_texture_selection: Action
+		mirror_painting: Toggle
+		color_erase_mode: Toggle
+		lock_alpha: Toggle
+		painting_grid: Toggle
+		image_tiled_view: Toggle
+		image_onion_skin_view: Toggle
+		slider_brush_size: NumSlider
+		slider_brush_softness: NumSlider
+		slider_brush_opacity: NumSlider
+		pixel_perfect_drawing: Toggle
+		slider_color_select_threshold: NumSlider
+	}

package/custom/screencam.d.ts

@@ -36,7 +36,7 @@ declare namespace Screencam {
 	/**
 	 * Provided preview with anti aliasing disabled that can be used for screenshots
 	 */
-	const NoAAPreview: Preview
+	let NoAAPreview: Preview
 	/**
 	 * Whether a timelapse is currently being recorded
 	 */

package/custom/spline_mesh.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="./blockbench"/>
 
 
-export declare class SplineTubeFace extends MeshFace {
+declare class SplineTubeFace extends MeshFace {
     constructor(mesh: any, spline: any, data: any);
     get element(): SplineMesh;
     getTexture(): Texture;
@@ -14,7 +14,7 @@ interface SplineCurveOptions {
 	start_ctrl: any
 	end_ctrl: any
 }
-export declare class SplineCurve {
+declare class SplineCurve {
     constructor(spline: SplineMesh, data: SplineCurveOptions);
     get element(): SplineMesh;
     extend(data: SplineCurveOptions): this;
@@ -49,7 +49,7 @@ export declare class SplineCurve {
 interface SplineHandle {
 
 }
-export declare class SplineHandle {
+declare class SplineHandle {
     constructor(spline: SplineMesh, data: SplineHandle);
     get element(): SplineMesh;
     extend(data: SplineHandle): this;
@@ -67,7 +67,7 @@ export declare class SplineHandle {
 interface SplineMeshOptions {
 
 }
-export declare class SplineMesh extends OutlinerElement {
+declare class SplineMesh extends OutlinerElement {
     constructor(data: any, uuid: any);
     get vertices(): Record<string, ArrayVector3>;
     get handles(): Record<string, SplineHandle>;
@@ -77,6 +77,7 @@ export declare class SplineMesh extends OutlinerElement {
     set curves(v: Record<string, SplineCurve>);
     get position(): ArrayVector3;
     get vertice_list(): any[];
+    faces: Record<string, SplineTubeFace>
     cyclic: boolean
     export: boolean
     display_space: boolean

package/custom/textures.d.ts

@@ -395,6 +395,7 @@ declare global {
 		static properties: Record<string, Property<any>>
 
 		static file_formats: Record<string, FileFormatOptions>
+		static getAllExtensions(): string[]
 	}
 	/**
 	 * Saves all textures
@@ -520,5 +521,6 @@ declare global {
 		function nextFrame(): void
 		function reset(): void
 		function updateButton(): void
+		function playAnimationFrame(anim_time?: number): void
 	}
 }

package/generated/animations/timeline_animators.d.ts

@@ -69,7 +69,7 @@ declare global {
                 max_data_points: number;
             };
         };
-        menu: Menu;
+        menu: import("../interface/menu").Menu;
     }
     class NullObjectAnimator extends BoneAnimator {
         solver: any;

package/generated/api.d.ts

@@ -105,8 +105,9 @@ export declare const Blockbench: {
     removeDragHandler: typeof Filesystem.removeDragHandler;
 };
 declare global {
-    interface window {
+    interface Window {
         Blockbench: typeof Blockbench;
+        osfs: '/' | '\\';
     }
 }
 declare const global: {

package/generated/file_system.d.ts

@@ -5,6 +5,7 @@ declare global {
             path: string;
             content?: string | ArrayBuffer;
             browser_file?: File;
+            no_file?: boolean;
         };
         /**
          * The resource identifier group, used to allow the file dialog (open and save) to remember where it was last used

package/generated/find_replace.d.ts

@@ -0,0 +1,6 @@
+import { Action } from './interface/actions';
+declare global {
+    interface BarItemRegistry {
+        find_replace: Action;
+    }
+}

package/generated/interface/actions.d.ts

@@ -1,5 +1,7 @@
 import MolangParser from "molangjs";
 import tinycolor from "tinycolor2";
+import { RaycastResult } from "../preview/preview";
+import { MenuItem } from "./menu";
 export declare const BarItems: any;
 type SubKeybind = {
     name: string;
@@ -8,6 +10,7 @@ type SubKeybind = {
     trigger: (event: Event) => void;
 };
 export interface KeybindItemOptions {
+    id?: string;
     name?: string;
     description?: string;
     category?: string;
@@ -52,7 +55,7 @@ export declare abstract class BarItem extends EventSystem {
     id: string;
     name: string;
     description: string;
-    icon?: IconString | (() => IconString);
+    icon?: IconString | ((context?: any) => IconString);
     category?: string;
     color?: string;
     condition: ConditionResolvable;
@@ -112,9 +115,7 @@ export declare class KeybindItem {
             description?: string;
         };
     };
-    constructor(id: string, data: KeybindItemOptions & {
-        id: string;
-    });
+    constructor(id: string, data: KeybindItemOptions);
     delete(): void;
 }
 export interface ActionOptions extends BarItemOptions {
@@ -312,7 +313,7 @@ export interface BrushOptions {
 interface ToolSpecificOptions {
     selectFace?: boolean;
     selectElements?: boolean;
-    transformerMode?: 'translate' | 'hidden' | '';
+    transformerMode?: 'translate' | 'scale' | 'rotate' | 'stretch' | 'hidden' | '';
     cursor?: string;
     animation_channel?: string;
     toolbar?: string;
@@ -329,7 +330,7 @@ interface ToolSpecificOptions {
     onCanvasClick?(raycast_data: RaycastResult): void;
     onSelect?(): void;
     onUnselect?(): void;
-    onCanvasMouseMove?(raycast_data: RaycastResult): any;
+    onCanvasMouseMove?(raycast_data: RaycastResult | false): any;
     onCanvasRightClick?(raycast_data: RaycastResult): any;
     onTextureEditorClick?(raycast_data: RaycastResult): any;
 }
@@ -393,13 +394,13 @@ interface WidgetOptions extends BarItemOptions {
 export declare abstract class Widget extends BarItem {
     constructor(id: string, data: WidgetOptions);
 }
-type NumSliderOptions = WidgetOptions & {
+export type NumSliderOptions = WidgetOptions & {
     private?: boolean;
     settings?: {
         default?: number;
         min?: number;
         max?: number;
-        interval?: number;
+        interval?: number | (() => number);
         step?: number;
         show_bar?: boolean;
         limit?: boolean;
@@ -502,7 +503,7 @@ export declare class BarSlider extends Widget {
 type BarSelectPropertyFormat = string | boolean | {
     name: string | true;
     condition?: ConditionResolvable;
-    icon?: string;
+    icon?: IconString;
 };
 interface BarSelectOptions extends WidgetOptions {
     value?: string;