blockbench-types 4.5.0 → 4.6.0

package/types/index.d.ts

@@ -7,6 +7,7 @@
 /// <reference types="./textures" />
 /// <reference types="./action" />
 /// <reference types="./animation" />
+/// <reference types="./animation_controller" />
 /// <reference types="./canvas" />
 /// <reference types="./codec" />
 /// <reference types="./file_system" />
@@ -19,117 +20,32 @@
 /// <reference types="./legacy" />
 /// <reference types="./menu" />
 /// <reference types="./outliner" />
+/// <reference types="./cube" />
 /// <reference types="./plugin" />
 /// <reference types="./preview" />
 /// <reference types="./project" />
+/// <reference types="./mode" />
 /// <reference types="./settings" />
 /// <reference types="./timeline" />
 /// <reference types="./undo" />
+/// <reference types="./painter" />
+/// <reference types="./screencam" />
 /// <reference types="./validator" />
+/// <reference types="./display_mode" />
+/// <reference types="./misc" />
 /// <reference types="./util" />
 
 
-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'
-	| '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'
-	| '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
+declare namespace Blockbench {
+	const platform: 'web' | 'win32' | 'darwin' | 'linux'
 	/**
-	 * Index of the cancel button within the buttons array
+	 * Blockbench version number
 	 */
-	cancel: number
-	buttons: string[]
-	translateKey?: string
-	title?: string
-	message?: string
-	icon?: string
-	width: number
+	const version: string
 	/**
-	 * 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.
+	 * URL queries when opened as web app using a link that contained queries
 	 */
-	commands?: {
-		[id: string]: string | {text: string}
-	}
-}
-
-declare namespace Blockbench {
-	const platform: 'web' | 'win32' | 'darwin' | 'linux'
-	const version: string
+	const queries: {[key: string]: string} | undefined
 	/**
 	 * Time when Blockbench was opened
 	 */
@@ -218,95 +134,123 @@ declare namespace Blockbench {
 	function removeListener(event_names: EventName): void
 }
 
-
-interface PluginData {
-	title: string
-	author: string
-	description: string
-	icon: string
-	variant: 'desktop' | 'web' | 'both'
-	about?: string
-	min_version: string
-	max_version: string
-	onload: () => void
-	onunload: () => void
-	oninstall: () => void
-	onuninstall: () => void
-}
-
-declare class Plugin {
-	static register(id: string, data: PluginData): Plugin
-	constructor()
-}
-
-type Condition = any
-
-
-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})
+type BlockbenchTypeOutliner = typeof Outliner
+type BlockbenchTypeOutlinerNode = typeof OutlinerNode
+type BlockbenchTypeOutlinerElement = typeof OutlinerElement
+type BlockbenchTypeGroup = typeof Group
+type BlockbenchTypeCube = typeof Cube
+type BlockbenchTypeMesh = typeof Mesh
+type BlockbenchTypeLocator = typeof Locator
+type BlockbenchTypeNullObject = typeof NullObject
+type BlockbenchTypeTextureMesh = typeof TextureMesh
+type BlockbenchTypeFace = typeof Face
+type BlockbenchTypeCubeFace = typeof CubeFace
+type BlockbenchTypeMeshFace = typeof MeshFace
+type BlockbenchTypeNodePreviewController = typeof NodePreviewController
+type BlockbenchTypeAnimator = typeof Animator
+type BlockbenchTypeTimeline = typeof Timeline
+type BlockbenchTypeAnimationItem = typeof AnimationItem
+type BlockbenchTypeAnimation = typeof Animation
+type BlockbenchTypeAnimationController = typeof AnimationController
+type BlockbenchTypeKeyframe = typeof Keyframe
+type BlockbenchTypeKeyframeDataPoint = typeof KeyframeDataPoint
+type BlockbenchTypeBoneAnimator = typeof BoneAnimator
+type BlockbenchTypeNullObjectAnimator = typeof NullObjectAnimator
+type BlockbenchTypeEffectAnimator = typeof EffectAnimator
+type BlockbenchTypeTimelineMarker = typeof TimelineMarker
+type BlockbenchTypePanel = typeof Panel
+type BlockbenchTypeMode = typeof Mode
+type BlockbenchTypeDialog = typeof Dialog
+type BlockbenchTypeSetting = typeof Setting
+type BlockbenchTypePlugin = typeof Plugin
+type BlockbenchTypePreview = typeof Preview
+type BlockbenchTypeToolbar = typeof Toolbar
+type BlockbenchTypeLanguage = typeof Language
+type BlockbenchTypePainter = typeof Painter
+type BlockbenchTypeScreencam = typeof Screencam
+type BlockbenchTypeSettings = typeof Settings
+type BlockbenchTypeTextureAnimator = typeof TextureAnimator
+type BlockbenchTypeToolbox = typeof Toolbox
+type BlockbenchTypeBarItems = typeof BarItems
+type BlockbenchTypeBarItem = typeof BarItem
+type BlockbenchTypeAction = typeof Action
+type BlockbenchTypeTool = typeof Tool
+type BlockbenchTypeToggle = typeof Toggle
+type BlockbenchTypeWidget = typeof Widget
+type BlockbenchTypeBarSelect = typeof BarSelect
+type BlockbenchTypeBarSlider = typeof BarSlider
+type BlockbenchTypeBarText = typeof BarText
+type BlockbenchTypeNumSlider = typeof NumSlider
+type BlockbenchTypeColorPicker = typeof ColorPicker
+type BlockbenchTypeKeybind = typeof Keybind
+type BlockbenchTypeKeybindItem = typeof KeybindItem
+type BlockbenchTypeMenu = typeof Menu
+type BlockbenchTypeBarMenu = typeof BarMenu
+type BlockbenchTypeResizeLine = typeof ResizeLine
+type BlockbenchTypeModelProject = typeof ModelProject
+type BlockbenchTypeModelFormat = typeof ModelFormat
+type BlockbenchTypeCodec = typeof Codec
+type BlockbenchTypeDisplaySlot = typeof DisplaySlot
+type BlockbenchTypeReusable = typeof Reusable
+type BlockbenchTypeTexture = typeof Texture
+declare namespace Blockbench {
+	const Outliner: BlockbenchTypeOutliner
+	const OutlinerNode: BlockbenchTypeOutlinerNode
+	const OutlinerElement: BlockbenchTypeOutlinerElement
+	const Group: BlockbenchTypeGroup
+	const Cube: BlockbenchTypeCube
+	const Mesh: BlockbenchTypeMesh
+	const Locator: BlockbenchTypeLocator
+	const NullObject: BlockbenchTypeNullObject
+	const TextureMesh: BlockbenchTypeTextureMesh
+	const Face: BlockbenchTypeFace
+	const CubeFace: BlockbenchTypeCubeFace
+	const MeshFace: BlockbenchTypeMeshFace
+	const NodePreviewController: BlockbenchTypeNodePreviewController
+	const Animator: BlockbenchTypeAnimator
+	const Timeline: BlockbenchTypeTimeline
+	const AnimationItem: BlockbenchTypeAnimationItem
+	const Animation: BlockbenchTypeAnimation
+	const AnimationController: BlockbenchTypeAnimationController
+	const Keyframe: BlockbenchTypeKeyframe
+	const KeyframeDataPoint: BlockbenchTypeKeyframeDataPoint
+	const BoneAnimator: BlockbenchTypeBoneAnimator
+	const NullObjectAnimator: BlockbenchTypeNullObjectAnimator
+	const EffectAnimator: BlockbenchTypeEffectAnimator
+	const TimelineMarker: BlockbenchTypeTimelineMarker
+	const Panel: BlockbenchTypePanel
+	const Mode: BlockbenchTypeMode
+	const Dialog: BlockbenchTypeDialog
+	const Setting: BlockbenchTypeSetting
+	const Plugin: BlockbenchTypePlugin
+	const Preview: BlockbenchTypePreview
+	const Toolbar: BlockbenchTypeToolbar
+	const Language: BlockbenchTypeLanguage
+	const Painter: BlockbenchTypePainter
+	const Screencam: BlockbenchTypeScreencam
+	const Settings: BlockbenchTypeSettings
+	const TextureAnimator: BlockbenchTypeTextureAnimator
+	const Toolbox: BlockbenchTypeToolbox
+	const BarItems: BlockbenchTypeBarItems
+	const BarItem: BlockbenchTypeBarItem
+	const Action: BlockbenchTypeAction
+	const Tool: BlockbenchTypeTool
+	const Toggle: BlockbenchTypeToggle
+	const Widget: BlockbenchTypeWidget
+	const BarSelect: BlockbenchTypeBarSelect
+	const BarSlider: BlockbenchTypeBarSlider
+	const BarText: BlockbenchTypeBarText
+	const NumSlider: BlockbenchTypeNumSlider
+	const ColorPicker: BlockbenchTypeColorPicker
+	const Keybind: BlockbenchTypeKeybind
+	const KeybindItem: BlockbenchTypeKeybindItem
+	const Menu: BlockbenchTypeMenu
+	const BarMenu: BlockbenchTypeBarMenu
+	const ResizeLine: BlockbenchTypeResizeLine
+	const ModelProject: BlockbenchTypeModelProject
+	const ModelFormat: BlockbenchTypeModelFormat
+	const Codec: BlockbenchTypeCodec
+	const DisplaySlot: BlockbenchTypeDisplaySlot
+	const Reusable: BlockbenchTypeReusable
+	const Texture: BlockbenchTypeTexture
 }

package/types/interface.d.ts

@@ -1,5 +1,5 @@
 interface ResizeLineOptions {
-	condition?: Condition
+	condition?: ConditionResolvable
 	horizontal?: boolean
 	position(): void
 	get(): void
@@ -10,7 +10,7 @@ declare class ResizeLine {
 
 	id: string
 	horizontal: boolean
-	condition?: Condition
+	condition?: ConditionResolvable
 	width: number
 	get(): void
 	set(): void

package/types/keyframe.d.ts

@@ -12,6 +12,14 @@ type axisLetter = 'x' | 'y' | 'z'
 
 declare class Keyframe {
     constructor(options: KeyframeOptions, uuid: any);
+
+    animator: GeneralAnimator;
+    bezier_left_time: ArrayVector3;
+    bezier_right_time: ArrayVector3;
+    bezier_left_value: ArrayVector3;
+    bezier_right_value: ArrayVector3;
+
+
     extend(data: KeyframeOptions): this;
     get(axis: axisLetter, data_point?: number): any;
     calc(axis: axisLetter, data_point?: number): any;

package/types/mesh.d.ts

@@ -0,0 +1,137 @@
+type OccupationMatrix = {
+	[x: number]: {
+		[y: number]: boolean
+	}
+}
+type MeshEdge = [string, string]
+interface MeshFaceOptions extends FaceOptions {
+
+}
+declare class MeshFace extends Face {
+	constructor(mesh: Mesh, data: MeshFaceOptions)
+	/**
+	 * The vertices that make up the face, as vertex keys. The vertices go around the face counter-clockwise when looking at the front side of the face. That also means that reversing the vertex order reverses the face direction.
+	 */
+	vertices: string[]
+	mesh: Mesh
+	uv: {
+		[vertex: string]: ArrayVector2
+	}
+	extend: (data: MeshFaceOptions) => void
+	/**
+	 * Returns the face normal in mesh space as calculated from the vertex positions
+	 */
+	getNormal: (normalize) => ArrayVector3
+	/**
+	 * Calculates which pixels the UV face occupies, and returns them as a map
+	 */
+	getOccupationMatrix: (texture_space?: boolean, start_offset?: ArrayVector2, matrix?: OccupationMatrix) => OccupationMatrix
+	/**
+	 * Get the keys of this face and all faces that are connected with it on the UV map
+	 */
+	getUVIsland: () => string[]
+	/**
+	 * Returns the angle between two faces in degrees
+	 */
+	getAngleTo: (other_face: MeshFace) => number
+	/**
+	 * Inverts the direction of the face
+	 */
+	invert: () => void
+	/**
+	 * Returns whether the face is selected
+	 */
+	isSelected: () => boolean
+	/**
+	 * Returns the vertices of a quad in an order that creates a convex quad shape if possible. If the face has less than 4 vertices, it just returns the vertices in original order.
+	 */
+	getSortedVertices: () => string[]
+	/**
+	 * Get the adjacent face in the specified side
+	 */
+	getAdjacentFace: (side_index: number) => {face: MeshFace, key: string, edge: MeshEdge, index: number} | null
+	/**
+	 * Returns the face key
+	 */
+	getFaceKey: () => string
+	/**
+	 * Takes a UV coordinate and turns it into a 3D space coordinate in local space of the mesh. On quads, the first triangle is used for calculation, so the coordinates on warped quads may be inaccurate.
+	 */
+	UVToLocal: (uv: ArrayVector2) => THREE.Vector3
+	/**
+	 * Takes a 3D coordinate in local space of the mesh, and turns it into a coordinate on the UV map using barycentric coordinates. On quads, the first triangle is used for calculation, so the coordinates on warped quads may be inaccurate.
+	 */
+	localToUV: (vector: THREE.Vector3) => ArrayVector2
+	/**
+	 * Get the face center by weight in local space
+	 */
+	getCenter: () => ArrayVector3
+}
+
+type MeshSeamValue = 'auto' | 'divide' | 'join'
+interface MeshOptions {
+	name?: string
+	color?: number
+	visibility?: boolean
+	rotation?: ArrayVector3
+	origin?: ArrayVector3
+	vertices?: {
+		[vkey: string]: ArrayVector3
+	}
+}
+declare class Mesh extends OutlinerElement {
+	constructor (options: Partial<MeshOptions>, uuid?: string)
+
+	visibility: boolean
+	color: number
+
+	vertices: {
+		[vkey: string]: ArrayVector3
+	}
+	faces: {
+		[fkey: string]: MeshFace
+	}
+	seams: {
+		[vkey: string]: MeshSeamValue
+	}
+
+	extend(options: Partial<MeshOptions>): this
+
+	/**
+	 * Get selected vertices as vertex keys
+	 * @param can_write If true, the array can safely be modified to update the selection
+	 */
+	getSelectedVertices(can_write: boolean): string[]
+	/**
+	 * Get selected edges as vertex key pairs
+	 * @param can_write If true, the array can safely be modified to update the selection
+	 */
+	getSelectedEdges(can_write: boolean): ([string, string])[]
+	/**
+	 * Get selected faces as face keys
+	 * @param can_write If true, the array can safely be modified to update the selection
+	 */
+	getSelectedVertices(can_write: boolean): string[]
+
+	setSeam(edge: MeshEdge, value)
+	getSeam(edge: MeshEdge): MeshSeamValue
+	getWorldCenter(ignore_mesh_selection?: boolean): THREE.Vector3
+	addVertices(...ArrayVector3): string[]
+	addFaces(...MeshFace): string[]
+	extend(data: MeshOptions): void
+	getUndoCopy(aspects?: object): object
+	getSaveCopy(project?: boolean): object
+	getSelectionRotation(): THREE.Euler
+	getCenter(global: boolean): THREE.Vector3
+	forAllFaces(callback: (face: MeshFace, key: string) => void): void
+	transferOrigin(origin: ArrayVector3, update?: boolean): void
+	setColor(color: number): void
+	roll(axis: number, steps: number, origin?: ArrayVector3): void
+	flip(axis: number): void
+	moveVector(offset: ArrayVector3, axis: number, update?: boolean): void
+	resize(val: number, axis: number, negative: boolean, allow_negative: boolean, bidirectional?: boolean): void
+	applyTexture(texture: Texture, faces?: true | undefined | string[]): void
+
+	static all: Mesh[]
+	static selected: Mesh[]
+}