blockbench-types 4.2.0 → 4.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockbench-types",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Blockbench typescript types",
   "main": "",
   "types": "types/index.d.ts",

package/types/canvas.d.ts

@@ -48,18 +48,37 @@ declare const Canvas: {
     bones: {
         [uuid: UUID]: THREE.Object3D
     };
+    /**
+     * Main scene, shared across all tabs
+     */
+    scene: THREE.Scene
+    /**
+     * List of the gizmos (control and UI elements) in the 3D scene
+     */
+    gizmos: []
     /**
      * The material used for all selection outlines
      */
     outlineMaterial: THREE.LineBasicMaterial;
+    meshOutlineMaterial: THREE.LineBasicMaterial;
     /**
      * The material used for the wireframe view
      */
     wireframeMaterial: THREE.MeshBasicMaterial;
+    solidMaterial: THREE.ShaderMaterial;
+    normalHelperMaterial: THREE.ShaderMaterial;
+    uvHelperMaterial: THREE.ShaderMaterial;
+    meshVertexMaterial: THREE.PointsMaterial;
     /**
      * The material used for the grids
      */
     gridMaterial: THREE.LineBasicMaterial;
+
+    pivot_marker: THREE.Object3D
+
+    global_light_color: THREE.Color
+    global_light_side: number
+
     face_order: string[];
 
     /**
@@ -74,6 +93,8 @@ declare const Canvas: {
      * Clear all elements from the scene
      */
     clear(): void;
+    buildGrid(): void;
+    updateShading(): void;
     /**
      * Updates selected aspects of the preview
      * @param options 
@@ -161,6 +182,10 @@ declare const Canvas: {
      * @param animation Whether to display the current animated texture frame
      */
     updateUV(cube: Cube, animation?: boolean): any;
+    /**
+     * Update the materials of marker colors if new colors were added
+     */
+    updateMarkerColorMaterials(): void;
     /**
      * Create an additional outline around the specified cubes
      * @param arr List of cubes to outline

package/types/dialog.d.ts

@@ -0,0 +1,154 @@
+interface DialogFormElement {
+	label: string
+	description?: string
+	type: 'text' | 'number' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
+	nocolon?: boolean
+	readonly?: boolean
+	value?: any
+	placeholder?: string
+	text?: string
+	colorpicker?: any
+	min?: number
+	max?: number
+	step?: number
+	height?: number
+	options?: object
+}
+
+type FormResultValue = string|number|boolean|[]
+
+interface ActionInterface {
+	name: string
+	description?: string
+	icon: string,
+	click: (event: Event) => void
+	condition: Condition
+}
+interface DialogOptions {
+	title: string
+	id: 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
+	 */
+	onButton?: (button_index: number, event?: Event) => void
+	/**
+	 * Function to run when anything in the form is changed
+	 */
+	onFormChange?: (form_result: {[key: string]: FormResultValue}) => void
+	/**
+	 * Array of HTML object strings for each line of content in the dialog.
+	 */
+	lines?: (string|HTMLElement)[]
+	/**
+	 * Creates a form in the dialog
+	 */
+	form?: {
+		[formElement: string]: '_' | DialogFormElement
+	}
+	/**
+	 * Vue component
+	 */
+	component?: Vue.Component
+	/**
+	 * Order that the different interface types appear in the dialog. Default is 'form', 'lines', 'component'.
+	 */
+	part_order?: string[]
+	form_first?: boolean
+	/**
+	 * Creates a dialog sidebar
+	 */
+	sidebar?: DialogSidebarOptions
+	/**
+	 * Menu in the handle bar
+	 */
+	title_menu?: Menu
+	/**
+	 * If true, the dialog will only have one button to close it
+	 */
+	singleButton?: boolean
+	/**
+	 * List of buttons
+	 */
+	buttons?: string[]
+}
+
+interface DialogSidebarOptions {
+	pages?: {
+		[key: string]: string | {label: string, icon: IconString, color?: string}
+	}
+	page?: string
+	actions?: (Action|ActionInterface|string)[],
+	onPageSwitch?: (page: string) => void
+}
+declare class DialogSidebar {
+	constructor(options: DialogSidebarOptions)
+
+	pages: {
+		[key: string]: string
+	}
+	page: string
+	actions: (Action|string)[]
+	onPageSwitch(page: string): void
+	build(): void
+	toggle(state?: boolean): void
+	setPage(page: string): void
+}
+
+declare class Dialog {
+	constructor (options: DialogOptions)
+
+	id: string
+	component: Vue.Component
+	sidebar: DialogSidebar | null
+
+
+	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
+
+	/**
+	 * Currently opened dialog
+	 */
+	static open: Dialog | null
+}

package/types/file_system.d.ts

@@ -135,7 +135,7 @@ declare namespace Blockbench {
          */
         propagate?: boolean
     }
-    export function addDragHandler(id: string, options: DragHandlerOptions, callback?: () => void): void
+    export function addDragHandler(id: string, options: DragHandlerOptions, callback?: () => void): Deletable
     export function removeDragHandler(id: string): void
 
 }

package/types/format.d.ts

@@ -1,9 +1,28 @@
+interface FormatPage {
+	component?: Vue.Component
+	content?: ({
+		type: 'image' | 'h2' | 'h3' | 'h4' | 'text' | 'label' | 'image' | ''
+		text?: string
+		source?: string
+		width?: number
+		height?: number
+	} | string)[]
+	button_text?: string
+}
+
 interface FormatOptions {
 	id: string
 	icon: string
 	name?: string
 	description?: string
+	category?: string
+	target?: string | string[]
+	confidential?: boolean
+	condition?: Condition
 	show_on_start_screen?: boolean
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
 
 	box_uv?: boolean
 	optional_box_uv?: boolean
@@ -31,28 +50,47 @@ interface FormatOptions {
 }
 
 declare class ModelFormat extends Deletable {
+	constructor(id: string, options: FormatOptions)
 	constructor(options: FormatOptions)
 
 	id: string
 	icon: string
-	name?: string
-	description?: string
-	show_on_start_screen?: boolean
+	name: string
+	description: string
+	category: string
+	target: string | string[]
+	confidential: boolean
+	condition?: Condition
+	show_on_start_screen: boolean
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
 
 	box_uv: boolean
 	optional_box_uv: boolean
 	single_texture: boolean
+	model_identifier: boolean
+	parent_model_id: boolean
+	vertex_color_ambient_occlusion: boolean
 	animated_textures: boolean
 	bone_rig: boolean
 	centered_grid: boolean
 	rotate_cubes: boolean
 	integer_size: boolean
+	meshes: boolean
+	texture_meshes: boolean
 	locators: boolean
 	canvas_limit: boolean
 	rotation_limit: boolean
 	uv_rotation: boolean
+	java_face_properties: boolean
+	select_texture_for_particles: boolean
+	bone_binding_expression: boolean
+	animation_files: boolean
+	pose_mode: boolean
 	display_mode: boolean
 	animation_mode: boolean
+	texture_folder: boolean
 
 	/**
 	 * Selects the format
@@ -72,3 +110,36 @@ declare class ModelFormat extends Deletable {
  * The current format
  */
 declare const Format: ModelFormat
+
+
+interface ModelLoaderOptions {
+	id?: string
+	icon: string
+	name?: string
+	description?: string
+	category?: string
+	target?: string | string[]
+	confidential?: boolean
+	condition?: Condition
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
+}
+
+declare class ModelLoader extends Deletable {
+	constructor(id: string, options: ModelLoaderOptions)
+	constructor(options: ModelLoaderOptions)
+
+	id: string
+	icon: string
+	name: string
+	description: string
+	category: string
+	target: string | string[]
+	confidential: boolean
+	condition?: Condition
+	show_on_start_screen: boolean
+	format_page?: FormatPage
+	onFormatPage?(): void
+	onStart?(): void
+}

package/types/index.d.ts

@@ -11,6 +11,7 @@
 /// <reference types="./format" />
 /// <reference types="./global" />
 /// <reference types="./interface" />
+/// <reference types="./dialog" />
 /// <reference types="./panel" />
 /// <reference types="./keyframe" />
 /// <reference types="./legacy" />
@@ -55,7 +56,10 @@ type EventName = 'remove_animation'
 	| 'reset_project'
 	| 'close_project'
 	| 'add_cube'
+	| 'add_mesh'
 	| 'add_group'
+	| 'add_texture_mesh'
+	| 'group_elements'
 	| 'update_selection'
 	| 'update_keyframe_selection'
 	| 'select_all'
@@ -72,6 +76,19 @@ type EventName = 'remove_animation'
 	| 'load_undo_save'
 	| 'select_mode'
 	| 'unselect_mode'
+	| 'change_active_panel'
+	| 'resize_window'
+	| 'press_key'
+	| 'convert_format'
+	| 'select_project'
+	| 'unselect_project'
+	| 'setup_project'
+	| 'update_project_resolution'
+	| 'update_project_settings'
+	| 'merge_project'
+	| 'update_view'
+	| 'update_camera_position'
+	| 'render_frame'
 
 type IconString = string;
 

package/types/interface.d.ts

@@ -1,154 +1,81 @@
-interface DialogFormElement {
-	label: string
-	description?: string
-	type: 'text' | 'number' | 'checkbox' | 'select' | 'radio' | 'textarea' | 'vector' | 'color' | 'file' | 'folder' | 'save' | 'info'
-	nocolon?: boolean
-	readonly?: boolean
-	value?: any
-	placeholder?: string
-	text?: string
-	colorpicker?: any
-	min?: number
-	max?: number
-	step?: number
-	height?: number
-	options?: object
+interface ResizeLineOptions {
+	condition?: Condition
+	horizontal?: boolean
+	position(): void
+	get(): void
+	set(): void
 }
+declare class ResizeLine {
+	constructor(id: string, options: ResizeLineOptions)
 
-type FormResultValue = string|number|boolean|[]
-
-interface ActionInterface {
-	name: string
-	description?: string
-	icon: string,
-	click: (event: Event) => void
-	condition: Condition
-}
-interface DialogOptions {
-	title: string
 	id: 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
-	 */
-	onButton?: (button_index: number, event?: Event) => void
-	/**
-	 * Function to run when anything in the form is changed
-	 */
-	onFormChange?: (form_result: {[key: string]: FormResultValue}) => void
-	/**
-	 * Array of HTML object strings for each line of content in the dialog.
-	 */
-	lines?: (string|HTMLElement)[]
-	/**
-	 * Creates a form in the dialog
-	 */
-	form?: {
-		[formElement: string]: '_' | DialogFormElement
-	}
-	/**
-	 * Vue component
-	 */
-	component?: Vue.Component
-	/**
-	 * Order that the different interface types appear in the dialog. Default is 'form', 'lines', 'component'.
-	 */
-	part_order?: string[]
-	form_first?: boolean
-	/**
-	 * Creates a dialog sidebar
-	 */
-	sidebar?: DialogSidebarOptions
-	/**
-	 * Menu in the handle bar
-	 */
-	title_menu?: Menu
-	/**
-	 * If true, the dialog will only have one button to close it
-	 */
-	singleButton?: boolean
-	/**
-	 * List of buttons
-	 */
-	buttons?: string[]
+	horizontal: boolean
+	condition?: Condition
+	width: number
+	get(): void
+	set(): void
+	node: HTMLElement
+	update(): void
+	setPosition(data: {top?: number, bottom?: number, left?: number, right?: number}): void
 }
 
-interface DialogSidebarOptions {
-	pages?: {
-		[key: string]: string | {label: string, icon: IconString, color?: string}
-	}
-	page?: string
-	actions?: (Action|ActionInterface|string)[],
-	onPageSwitch?: (page: string) => void
-}
-declare class DialogSidebar {
-	constructor(options: DialogSidebarOptions)
+declare namespace Interface {
+	function createElement(type: keyof HTMLElementTagNameMap, attributes?: {}, content?: string | HTMLElement | HTMLElement[]): HTMLElement
 
-	pages: {
-		[key: string]: string
+	const data: {
+		left_bar_width: number
+		right_bar_width: number
+		quad_view_x: number
+		quad_view_y: number
+		timeline_head: number
+		left_bar: string[]
+		right_bar: string[]
 	}
-	page: string
-	actions: (Action|string)[]
-	onPageSwitch(page: string): void
-	build(): void
-	toggle(state?: boolean): void
-	setPage(page: string): void
-}
+	let left_bar_width: number
+	let right_bar_width: number
+	let top_panel_height: number
+	let bottom_panel_height: number
+	function getTopPanel(): Panel[]
+	function getBottomPanel(): Panel[]
+	function getLeftPanels(): Panel[]
+	function getRightPanels(): Panel[]
+	const Resizers: {
+		left: ResizeLine
+		right: ResizeLine
+		quad_view_x: ResizeLine
+		quad_view_y: ResizeLine
+		top: ResizeLine
+		bottom: ResizeLine
+		timeline_head: ResizeLine
+	}
+	const status_bar: {
+		menu: Menu
+		vue: Vue
+	}
+	const Panels: {
+		(key: string): Panel
+	}
+	function toggleSidebar(side, status): void
 
-declare class Dialog {
-	constructor (options: DialogOptions)
+	const text_edit_menu: Menu
 
-	id: string
-	component: Vue.Component
-	sidebar: DialogSidebar | null
+	function addSuggestedModifierKey(key: 'ctrl' | 'shift' | 'alt', text: string): void
+	function removeSuggestedModifierKey(key: 'ctrl' | 'shift' | 'alt', text: string): void
 
+	const center_screen: HTMLElement
+	const page_wrapper: HTMLElement
+	const preview: HTMLElement
+	const work_screen: HTMLElement
+	const right_bar: HTMLElement
+	const left_bar: HTMLElement
 
-	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
+	namespace CustomElements {
+		function SelectInput(id: string, options: {
+			value?: string
+			default?: string
+			options: {key: string, value: string}
+			onChange?(): void
+		}): HTMLElement
+		const ResizeLine;
 	}
-	/**
-	 * 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
-
-	/**
-	 * Currently opened dialog
-	 */
-	static open: Dialog | null
 }

package/types/menu.d.ts

@@ -62,9 +62,12 @@ declare namespace MenuBar {
         file: Menu
         edit: Menu
         transform: Menu
-        display: Menu
-        filter: Menu
+        uv: Menu
+        texture: Menu
         animation: Menu
+        keyframe: Menu
+        display: Menu
+        tools: Menu
         view: Menu
         help: Menu
         [id: string]: Menu

package/types/outliner.d.ts

@@ -1,3 +1,4 @@
+type ArrayVector4 = [number, number, number, number]
 type ArrayVector3 = [number, number, number]
 type ArrayVector2 = [number, number]
 

package/types/preview_scene.d.ts

@@ -0,0 +1,109 @@
+interface PreviewModelCubeTemplate {
+	position: ArrayVector3
+	size: ArrayVector3
+	origin?: ArrayVector3
+	rotation?: ArrayVector3
+	faces: {
+		north?: {uv: ArrayVector4}
+		east?: {uv: ArrayVector4}
+		west?: {uv: ArrayVector4}
+		south?: {uv: ArrayVector4}
+		up?: {uv: ArrayVector4}
+		down?: {uv: ArrayVector4}
+	}
+}
+
+interface PreviewModelOptions {
+	condition?: Condition
+	cubes: PreviewModelCubeTemplate[]
+	/**
+	 * Source of the model's texture
+	 */
+	texture?: string
+	/**
+	 * Model tint color
+	 */
+	color?: string
+	/**
+	 * Enable shading on the material
+	 */
+	shading?: boolean
+	/**
+	 * THREE.JS material render side
+	 */
+	render_side?: number
+	texture_size?: [number, number]
+	onUpdate?(): void
+}
+
+declare class PreviewModel extends Deletable {
+	constructor(id: string, options: PreviewModelOptions)
+	
+	static models: {
+		(id: string): PreviewModel
+	}
+	static getActiveModels(): PreviewModel[]
+	
+	id: string
+	model_3d: THREE.Object3D
+	cubes: PreviewModelCubeTemplate[]
+	texture?: string
+	color?: string
+	shading: boolean
+	render_side: number
+	texture_size: [number, number]
+	onUpdate?:() => void
+	/**
+	 * Enables the model in the preview
+	 */
+	enable(): void
+	/**
+	 * Disables the model in the preview
+	 */
+	disable(): boolean
+	/**
+	 * Update the appearance and visibility of the model
+	 */
+	update(): void
+	buildModel(): void
+}
+
+
+
+interface PreviewSceneOptions {
+	name?: string
+	description?: string
+	light_color?: string
+	light_side?: number
+	condition?: Condition
+	preview_models?: string[]
+}
+
+declare class PreviewScene extends Deletable {
+	constructor(id: string, options: PreviewSceneOptions)
+
+	static scenes: {
+		(id: string): PreviewScene
+	}
+	static active: PreviewScene | null
+	select_options: {
+		(id: string): string
+	}
+	
+	id: string
+	name: string
+	description: string
+	light_color: string
+	light_side: number
+	condition?: Condition
+	preview_models: string[]
+
+	/**
+	 * Selects this preview scene
+	 */
+	select(): void
+	/**
+	 * Unselects this preview scene
+	 */
+	unselect(): void
+}

package/types/project.d.ts

@@ -11,6 +11,7 @@ declare class ModelProject {
 	name: string
 	uuid: UUID
 	selected: boolean
+	model_identifier: string
 	/**
 	 * When set to true, the project tab can no longer be selected or unselected
 	 */