blockbench-types 4.4.0 → 4.6.0

package/types/misc.d.ts

@@ -0,0 +1,172 @@
+
+
+declare class Deletable {
+	delete: () => void
+}
+type UUID = string
+
+/**
+ * True if Blockbench runs as a native app
+ */
+declare const isApp: boolean
+
+type EventName = 'remove_animation'
+	| 'display_animation_frame'
+	| 'before_closing'
+	| 'create_session'
+	| 'join_session'
+	| 'quit_session'
+	| 'send_session_data'
+	| 'receive_session_data'
+	| 'user_joins_session'
+	| 'user_leaves_session'
+	| 'process_chat_message'
+	| 'update_settings'
+	| 'update_project_settings'
+	| 'save_project'
+	| 'load_project'
+	| 'new_project'
+	| 'reset_project'
+	| 'close_project'
+	| 'saved_state_changed'
+	| 'add_cube'
+	| 'add_mesh'
+	| 'add_group'
+	| 'add_texture_mesh'
+	| 'group_elements'
+	| 'update_selection'
+	| 'update_keyframe_selection'
+	| 'select_all'
+	| 'added_to_selection'
+	| 'invert_selection'
+	| 'canvas_select'
+	| 'canvas_click'
+	| 'change_texture_path'
+	| 'add_texture'
+	| 'finish_edit'
+	| 'finished_edit'
+	| 'undo'
+	| 'redo'
+	| 'load_undo_save'
+	| 'change_color'
+	| 'select_mode'
+	| 'unselect_mode'
+	| 'change_active_panel'
+	| 'resize_window'
+	| 'press_key'
+	| 'select_format'
+	| 'convert_format'
+	| 'construct_format'
+	| 'delete_format'
+	| 'select_project'
+	| 'unselect_project'
+	| 'setup_project'
+	| 'update_project_resolution'
+	| 'merge_project'
+	| 'update_view'
+	| 'update_camera_position'
+	| 'render_frame'
+	| 'construct_model_loader'
+	| 'delete_model_loader'
+	| 'update_recent_project_data'
+	| 'update_recent_project_thumbnail'
+	| 'load_from_recent_project_data'
+	| 'edit_animation_properties'
+	| 'select_preview_scene'
+	| 'unselect_preview_scene'
+
+type IconString = string;
+
+interface MessageBoxOptions {
+	/**
+	 * Index of the confirm button within the buttons array
+	 */
+	confirm: number
+	/**
+	 * Index of the cancel button within the buttons array
+	 */
+	cancel: number
+	buttons: string[]
+	translateKey?: string
+	title?: string
+	message?: string
+	icon?: string
+	width: number
+	/**
+	 * Display a list of actions to do in the dialog. When clicked, the message box closes with the string ID of the command as first argument.
+	 */
+	commands?: {
+		[id: string]: string | {text: string}
+	}
+}
+
+
+
+interface PropertyOptions {
+	default?: any
+	condition?: any
+	exposed?: boolean
+	label?: string
+	/**
+	 * Options used for select types
+	 */
+	options?: object
+	merge?: (instance: any, data: object) => void
+	reset?: (instance: any) => void
+	merge_validation?: (value: any) => boolean
+}
+/**
+ * Creates a new property on the specified target class
+ */
+declare class Property extends Deletable {
+    constructor(target_class: any, type: string, name: string, options?: PropertyOptions);
+    class: any;
+    name: string;
+    type: string;
+	default: any;
+	
+    isString: boolean;
+    isMolang: boolean;
+    isNumber: boolean;
+    isBoolean: boolean;
+    isArray: boolean;
+    isVector: boolean;
+	isVector2: boolean;
+	
+    merge_validation: undefined | ((value: any) => boolean);
+    condition: any;
+    exposed: boolean;
+    label: any;
+	merge: (instance: any, data: object) => void
+	reset: (instance: any) => void
+    getDefault(instance: any): any;
+    copy(instance: any, target: any): void;
+}
+
+declare function updateSelection(): void
+
+/**
+ * Returns a translated string in the current language
+ * @param key Translation key
+ * @param arguments Array of arguments that replace anchors (%0, etc.) in the translation. Items can be strings or anything that can be converted to strings
+ */
+declare function tl(key: string, arguments?: any[]): string
+
+declare namespace Language {
+	/**
+	 * Translation data for the current language
+	 */
+	const data: {
+		[key: string]: string
+	}
+	/**
+	 * Two letter code indicating the currently selected language
+	 */
+	const code: string
+	/**
+	 * Add translations for custom translation strings
+	 * @param language Two letter language code, e. G. 'en'
+	 * @param strings Object listing the translation keys and values
+	 */
+	function addTranslations(language: string, strings: {[key: string]: string})
+}

package/types/mode.d.ts

@@ -0,0 +1,34 @@
+interface ModeOptions {
+	name: string
+	default_tool?: string
+	selectElements?: boolean
+	/**
+	 * Hide certain types of nodes in the outliner, like cubes and meshes in animation mode
+	 */
+	hidden_node_types?: string[]
+	hide_toolbars?: boolean
+	hide_sidebars?: boolean
+	hide_status_bar?: boolean
+	condition?: ConditionResolvable
+	component?: Vue.Component
+	onSelect?: () => void
+	onUnselect?: () => void
+}
+declare class Mode extends KeybindItem {
+	constructor(id: string, options: ModeOptions)
+
+	/**Selects the mode */
+	select: () => void
+	/**Unselects the mode */
+	unselect: () => void
+	/**Activates the mode */
+	trigger: () => void
+
+	static selected: Mode
+}
+
+declare namespace Modes {
+	const options: {
+		[id: string]: Mode
+	}
+}

package/types/outliner.d.ts

@@ -58,6 +58,8 @@ declare class OutlinerNode {
 declare class OutlinerElement extends OutlinerNode {
 	constructor ()
 	selected: boolean
+	readonly mesh: THREE.Object3D | THREE.Mesh
+	getMesh: () => THREE.Object3D | THREE.Mesh
 	static fromSave: (data: object, keep_uuid?: boolean) => OutlinerElement
 	static isParent: false
 }
@@ -90,6 +92,8 @@ declare class Group extends OutlinerNode {
 
 	name: string
 	children: OutlinerNode[]
+	origin: ArrayVector3
+	rotation: ArrayVector3
 	reset: boolean
 	shade: boolean
 	selected: boolean
@@ -135,51 +139,12 @@ declare class Group extends OutlinerNode {
 	forEachChild(callback: (object: OutlinerNode) => void, type?: any, for_self?: boolean)
 }
 
-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
-	/**
-	 * UV position for box UV mode
-	 */
-	uv_offset: ArrayVector2
-	extend(options: Partial<CubeOptions>): this
-
-	static all: Cube[]
-	static selected: Cube[]
-}
-
 
 interface LocatorOptions {
 	name: string
 	from: ArrayVector3
 
 }
-
 declare class Locator extends OutlinerElement {
 	constructor (options: Partial<LocatorOptions>, uuid?: string)
 
@@ -192,6 +157,52 @@ declare class Locator extends OutlinerElement {
 }
 
 
+interface NullObjectOptions {
+	name?: string
+	position?: ArrayVector3
+	ik_target?: string
+	lock_ik_target_rotation?: boolean
+
+}
+declare class NullObject extends OutlinerElement {
+	constructor (options: Partial<NullObjectOptions>, uuid?: string)
+	position: ArrayVector3
+	ik_target: string
+	lock_ik_target_rotation: boolean
+
+	extend(options: Partial<NullObjectOptions>)
+	flip(axis: number, center: number): this
+	getWorldCenter(): THREE.Vector3
+
+	static all: NullObject[]
+	static selected: NullObject[]
+}
+
+
+interface TextureMeshOptions {
+	name?: string
+	texture_name?: string
+	origin?: ArrayVector3
+	local_pivot?: ArrayVector3
+	rotation?: ArrayVector3
+	scale?: ArrayVector3
+}
+declare class TextureMesh extends OutlinerElement {
+	constructor (options: Partial<TextureMeshOptions>, uuid?: string)
+	texture_name: string
+	local_pivot: ArrayVector3
+	scale: ArrayVector3
+
+	extend(options: Partial<TextureMeshOptions>)
+	flip(axis: number, center: number): this
+	getWorldCenter(): THREE.Vector3
+	moveVector(offset: ArrayVector3 | THREE.Vector3, axis: number, update?: boolean): void
+
+	static all: TextureMesh[]
+	static selected: TextureMesh[]
+}
+
+
 
 declare namespace Outliner {
 	const root: OutlinerNode[]

package/types/painter.d.ts

@@ -0,0 +1,29 @@
+
+declare namespace Painter {
+	const currentPixel: ArrayVector2
+	const brushChanges: boolean
+	const current: object
+	const selection: object
+	const mirror_painting: boolean
+	const lock_alpha: boolean
+	const erase_mode: boolean
+	const default_brush_presets: object[]
+
+	function edit(texture: Texture, callback: (canvas: HTMLCanvasElement) => void, options: TextureEditOptions)
+	function setAlphaMatrix(texture: Texture, x, y, val)
+	function getAlphaMatrix(texture: Texture, x, y)
+
+	function combineColors(base: RGBAColor, added: RGBAColor, opacity: number): RGBAColor
+	function blendColors(base: RGBAColor, added: RGBAColor, opacity: number, blend_mode: string): RGBAColor
+	function getMirrorElement(element: OutlinerElement, symmetry_axes: number[]): void
+	function updateNslideValues(): void
+	function getBlendModeCompositeOperation(): string
+	function getCanvas(texture: Texture): HTMLCanvasElement
+	function scanCanvas(ctx: CanvasRenderingContext2D, x: number, y: number, w: number, h: number, cb: () => void): void
+	function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): void
+	function modifyCanvasSection(ctx: CanvasRenderingContext2D, x: number, y: number, w: number, h: number, cb: () => void): void
+	function editCircle(ctx: CanvasRenderingContext2D, x: number, y: number, r: number, softness: number, editPx: (RGBAColor, opacity: number, px: number, py: number) => RGBAColor): void
+	function editSquare(ctx: CanvasRenderingContext2D, x: number, y: number, r: number, softness: number, editPx: (RGBAColor, opacity: number, px: number, py: number) => RGBAColor): void
+	function openBrushOptions(): void
+	function loadBrushPreset(preset: object): void
+}

package/types/panel.d.ts

@@ -5,8 +5,8 @@ interface PanelOptions {
 	menu?: any
 	growable?: boolean
 	selection_only?: boolean
-	condition?: Condition
-	display_condition?: Condition
+	condition?: ConditionResolvable
+	display_condition?: ConditionResolvable
 	expand_button: boolean
 	toolbars: {
 		[id: string]: Toolbar

package/types/preview_scene.d.ts

@@ -14,7 +14,7 @@ interface PreviewModelCubeTemplate {
 }
 
 interface PreviewModelOptions {
-	condition?: Condition
+	condition?: ConditionResolvable
 	cubes: PreviewModelCubeTemplate[]
 	/**
 	 * Source of the model's texture
@@ -75,7 +75,7 @@ interface PreviewSceneOptions {
 	description?: string
 	light_color?: string
 	light_side?: number
-	condition?: Condition
+	condition?: ConditionResolvable
 	preview_models?: string[]
 }
 
@@ -95,7 +95,7 @@ declare class PreviewScene extends Deletable {
 	description: string
 	light_color: string
 	light_side: number
-	condition?: Condition
+	condition?: ConditionResolvable
 	preview_models: string[]
 
 	/**

package/types/project.d.ts

@@ -41,9 +41,13 @@ declare class ModelProject {
 	elements: OutlinerElement[]
 	groups: Group[]
 	selected_elements: OutlinerElement[]
-	selected_group: Group | null;
-	selected_vertices: {
-		[element_key: string]: string[]
+	selected_group: Group | null
+	mesh_selection: {
+		[element_key: string]: {
+			vertices: string[]
+			edges: string[]
+			faces: string[]
+		}
 	};
 	selected_faces: []
 	textures: Texture[]

package/types/screencam.d.ts

@@ -0,0 +1,58 @@
+interface ScreenshotOptions {
+	crop?: boolean
+	width?: number
+	height?: number
+}
+interface RecordGIFOptions {
+	fps: number
+	format?: 'gif' | 'apng' | 'png_sequence'
+	length_mode?: 'seconds' | 'frames' | 'turntable' | 'animation'
+	length?: number
+	pixelate?: number
+	quality?: number
+	background: string
+	background_image?: string
+	turnspeed?: string
+	/** Start playing the selected animation when the animation starts */
+	play?: boolean
+	repeat?: any
+	/** Disable all UI feedback about GIF recording */
+	silent?: boolean
+}
+interface RecordTimelapseOptions {
+	/** Destination oath */
+	destination: string
+	source: 'preview' | 'locked' | 'interface'
+	/** Interval between frames in seconds */
+	interval: number
+}
+type ScreenshotReturn = (dataURL: string) => void
+
+declare namespace Screencam {
+	/**
+	 * Provided preview with anti aliasing disabled that can be used for screenshots
+	 */
+	const NoAAPreview: Preview
+	/**
+	 * Whether a timelapse is currently being recorded
+	 */
+	const recording_timelapse: boolean
+	const gif_options_dialog: Dialog
+	const gif_crop: {top: number, left: number, right: number, bottom: number}
+
+	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 cleanCanvas(options, cb: ScreenshotReturn): void
+
+	function createGif(options: RecordGIFOptions, cb: ScreenshotReturn): void
+
+	function recordTimelapse(options: RecordTimelapseOptions): void
+
+	function stopTimelapse(): void
+}

package/types/textures.d.ts

@@ -34,6 +34,8 @@ interface TextureEditOptions {
      * If true, the texture is not updated visually
      */
     no_update?: boolean
+    no_undo_init?: boolean
+    no_undo_finish?: boolean
 }
 
 declare class Texture {

package/types/undo.d.ts

@@ -40,21 +40,70 @@ type UndoEntry = {
     action: string
     time: number
 }
+interface AmendEditForm {
+    condition?: ConditionResolvable
+    type?: 'number'
+    label: string
+    interval_type: 'position' | 'rotation'
+    getInterval?: (Event) => number
+    value?: number | string,
+    min?: number,
+    max?: number,
+    step?: number,
+}
 
 declare class UndoSystem {
     constructor();
+    /**
+     * Starts an edit to the current project by saving the state of the provided aspects
+     * @param aspects Aspects to save
+     */
     initEdit(aspects: UndoAspects): any;
+    /**
+     * Finishes an edit by saving the state of the project after it was changed
+     * @param action Description of the edit
+     */
     finishEdit(action: string, aspects?: UndoAspects): {
         before: any;
         post: any;
         action: any;
         time: number;
     };
+    /**
+     * Cancels an event before it was finished and reset the project to the state before
+     */
     cancelEdit(): void;
+    /**
+     * Add keyframes to the current edit that were indirectly removed by moving other keyframes to their position
+     * @param keyframes 
+     */
     addKeyframeCasualties(keyframes: Keyframe[]): void;
+    /**
+     * Undoes the latest edit
+     */
     undo(remote?: boolean): void;
+    /**
+     * Redoes the latest edit
+     */
+    redo(remote?: boolean): void;
+    /**
+     * Redoes the latest edit
+     */
     redo(remote?: boolean): void;
-    remoteEdit(entry: UndoEntry): void;
-    loadSave(save: UndoSave, reference: UndoSave, mode?: string): void;
+    /**
+     * Provides a menu to amend the latest edit with slightly changed values
+     */
+    amendEdit(form: AmendEditForm, callback: (values: {}, form: {}) => void)
+
+    /**
+     * Loads a specific undo save
+     * @param save The undo save to load
+     * @param reference The current undo save for reference
+     * @param mode The load save modes
+     */
+    loadSave(save: UndoSave, reference: UndoSave, mode?: 'session'): void;
 }
+/**
+ * Blockbench's system to register edits to the project and switch between them
+ */
 declare let Undo: UndoSystem;

package/types/util.d.ts

@@ -1,7 +1,24 @@
-type ConditionType = undefined | boolean | number | Partial<{
+type ConditionResolvable = undefined | boolean | ((context) => boolean) | Partial<{
 	modes: string[]
 	formats: string[]
 	tools: string[]
+	features: string[]
+	selected: {
+		animation?: boolean
+		animation_controller?: boolean
+		animation_controller_state?: boolean
+		keyframe?: boolean
+		group?: boolean
+		texture?: boolean
+		element?: boolean
+		cube?: boolean
+		mesh?: boolean
+		locator?: boolean
+		null_object?: boolean
+		texture_mesh?: boolean
+		outliner?: boolean
+	}
+	project: boolean
 	method: (context: any) => boolean
 }>
 
@@ -37,3 +54,19 @@ declare function addEventListeners(element: HTMLElement, events: string, func: (
 declare function trimFloatNumber(value: number): string
 declare function getAxisLetter(axisNumber: number): string
 declare function getAxisNumber(axisLetter: string): number
+
+
+declare namespace Reusable {
+	const vec1: THREE.Vector3
+	const vec2: THREE.Vector3
+	const vec3: THREE.Vector3
+	const vec4: THREE.Vector3
+	const vec5: THREE.Vector3
+	const vec6: THREE.Vector3
+	const vec7: THREE.Vector3
+	const vec8: THREE.Vector3
+	const quat1: THREE.Quaternion
+	const quat2: THREE.Quaternion
+	const euler1: THREE.Euler
+	const euler2: THREE.Euler
+}

package/types/validator.d.ts

@@ -32,7 +32,7 @@ interface ValidatorCheckOptions {
 	 * Names of events that automatically trigger this check
 	 */
 	update_triggers?: EventName[]
-	condition?: Condition
+	condition?: ConditionResolvable
 }
 interface WarningOrError {
 	message: string