blockbench-types 4.8.0 → 4.10.0

package/types/settings.d.ts

@@ -1,99 +1,101 @@
+/// <reference path="./blockbench.d.ts"/>
+declare const settings: {
+	[id: string]: Setting
+}
+
 interface SettingOptions {
-    name: string
-    type?: 'number' | 'string' | 'boolean' | 'password' | 'select' | 'click'
-    value: boolean | number | string
-    condition?: ConditionResolvable
-    category: string
-    description?: string
-    //launch_setting?: boolean
-    min?: number
-    max?: number
-    step?: number
-    icon?: string
-    click?(): void
-    options?: {
-        [id: string]: string
-    }
-    onChange?: (value: any) => void
+	name: string
+	type?: 'number' | 'string' | 'boolean' | 'password' | 'select' | 'click'
+	value: boolean | number | string
+	condition?: ConditionResolvable
+	category: string
+	description?: string
+	//launch_setting?: boolean
+	min?: number
+	max?: number
+	step?: number
+	icon?: string
+	click?(): void
+	options?: {
+		[id: string]: string
+	}
+	onChange?(value: any): void
 }
 
 /**
  * Settings can be used to add global configuration options to Blockbench. All settings are listed under File > Preferences > Settings.
  */
 declare class Setting extends Deletable {
-    constructor(id: string, options: SettingOptions);
-
-    id: string
-    type: string
-    condition: any
-    /**
-     * The master value, not affected by profiles
-     */
-    master_value: any
-    /**
-     * The active value
-     */
-    value: any
-    /**
-     * The value that is displayed in the settings dialog
-     */
-    ui_value: any
-    name: string
-    description: string
-    category: string
-    /**
-     * If true, the setting can be used by the main process before initializing the Blockbench window. This is not available to custom settings created by plugins.
-     */
-    launch_setting: boolean
-    min?: number
-    max?: number
-    step?: number
-    icon?: string
-    options?: {
-        [id: string]: string
-    }
-    hidden?: boolean
-    onChange?: () => {}
-
-    /**
-     * Sets the value of the setting, while triggering the onChange function if available, and saving the change.
-     */
-    set(value): void
-    /**
-     * Triggers the setting, as if selected in action control. This toggles boolean settings, opens a dialog for string or numeric settings, etc.
-     */
-    trigger(event?: Event): void
-
+	constructor(id: string, options: SettingOptions)
+	id: string
+	type: string
+	condition: any
+	/**
+	 * The master value, not affected by profiles
+	 */
+	master_value: any
+	/**
+	 * The active value
+	 */
+	value: any
+	/**
+	 * The value that is displayed in the settings dialog
+	 */
+	ui_value: any
+	name: string
+	description: string
+	category: string
+	/**
+	 * If true, the setting can be used by the main process before initializing the Blockbench window. This is not available to custom settings created by plugins.
+	 */
+	launch_setting: boolean
+	min?: number
+	max?: number
+	step?: number
+	icon?: string
+	options?: {
+		[id: string]: string
+	}
+	hidden?: boolean
+	onChange?: () => {}
 
+	/**
+	 * Sets the value of the setting, while triggering the onChange function if available, and saving the change.
+	 */
+	set(value: any): void
+	/**
+	 * Triggers the setting, as if selected in action control. This toggles boolean settings, opens a dialog for string or numeric settings, etc.
+	 */
+	trigger(event?: Event): void
 }
 /**
  * Global namespace handling data and functionality related to settings.
  */
+declare type SettingItems = Record<string, { name: string; open: boolean; items: SettingItems }>
+
 declare namespace Settings {
-    const structure: {};
-    const stored: {};
-    /**
-     * Opens the settings dialog
-     * @param options 
-     */
-    function open(options?: Partial<{
-        search: string
-        tab: 'setting' | 'keybindings' | 'layout_settings' | 'credits'
-    }>): void;
-    /**
-     * Save all settings to the local storage
-     */
-    function saveLocalStorages(): void;
-    /**
-     * Save the settings and apply changes
-     */
-    function save(): void;
-    /**
-     * Returns the value of the specified setting
-     */
-    function get(setting_id: string): any;
+	const structure: Record<string, SettingItems>
+	const stored: Record<string, Setting>
+	/**
+	 * Opens the settings dialog
+	 * @param options
+	 */
+	function open(
+		options?: Partial<{
+			search: string
+			tab: 'setting' | 'keybindings' | 'layout_settings' | 'credits'
+		}>
+	): void
+	/**
+	 * Save all settings to the local storage
+	 */
+	function saveLocalStorages(): void
+	/**
+	 * Save the settings and apply changes
+	 */
+	function save(): void
+	/**
+	 * Returns the value of the specified setting
+	 */
+	function get(setting_id: string): any
 }
-
-declare const settings: {
-    [id: string]: Setting
-};

package/types/shared_actions.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Shared Actions is a system in Blockbench to allow actions (including in toolbars, menus, via action control, or keybinding) to run different code in different cases, such as in different modes or different panels.
+ * As an example, the "Duplicate" action runs code to duplicate elements when used in the outliner, and duplicates textures when used in the textures panel.
+ * 
+ * 
+ * Handlers can be added for existing actions like this:
+
+### Example:
+
+```javascript
+	// Duplicate layers when using "Duplicate" in the layers panel
+	SharedActions.add('duplicate', {
+		subject: 'layer',
+		condition: () => Prop.active_panel == 'layers' && TextureLayer.selected,
+		run() {
+			let texture = Texture.selected;
+			let original = texture.getActiveLayer();
+			let copy = original.getUndoCopy(true);
+			copy.name += '-copy';
+			Undo.initEdit({textures: [texture]});
+			let layer = new TextureLayer(copy, texture);
+			layer.addForEditing();
+			Undo.finishEdit('Duplicate layer');
+		}
+	})
+```
+ * 
+ */
+declare namespace SharedActions {
+	const checks: {
+		[id: SharedActionID]: SharedActionHandler
+	}
+
+	/**
+	 * Add a new handler to a shared action
+	 * @param action_id Action ID
+	 * @param handler Handler options
+	 */
+	function add(action_id: SharedActionID, handler: SharedActionHandler): Deletable
+	/**
+	 * Run the active handler for a specific subject manually
+	 * @param action_id Action ID
+	 * @param event Event that triggered the interaction
+	 * @param context Optional context variable
+	 */
+	function run(action_id: SharedActionID, event?: Event, context?: any): boolean
+	/**
+	 * Run a specific handler manually
+	 * @param action_id Action ID
+	 * @param subject Subject to run on
+	 * @param event Event that triggered the interaction
+	 * @param context Optional context variable
+	 * @param force Force the specified handler to run and ignore its condition
+	 */
+	function runSpecific(
+		action_id: SharedActionID,
+		subject: string,
+		event?: Event,
+		context?: any,
+		force?: boolean
+	): boolean
+	/**
+	 * Check if there is an active and available handler in the current situation for a shared action
+	 * @param action_id
+	 */
+	function condition(action_id: SharedActionID): boolean
+	/**
+	 * Find the active handler in the current situation for a shared action
+	 * @param action_id
+	 * @param event
+	 * @param context
+	 */
+	function find(
+		action_id: SharedActionID,
+		event?: Event,
+		context?: any
+	): SharedActionHandler | null
+}
+
+interface SharedActionHandler {
+	priority: number
+	subject: string
+	condition: ConditionResolvable
+	run: (event?: Event, context?: any) => void
+}
+
+type SharedActionID =
+	| string
+	| 'rename'
+	| 'delete'
+	| 'duplicate'
+	| 'select_all'
+	| 'unselect_all'
+	| 'invert_selection'

package/types/texture_layers.d.ts

@@ -0,0 +1,117 @@
+/// <reference types="three" />
+
+interface TextureLayerData {
+	name?: string
+	in_limbo?: boolean
+	offset?: ArrayVector2
+	scale?: ArrayVector2
+	opacity?: number
+	visible?: boolean
+	blend_mode?: 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'screen' | 'difference'
+	image_data?: ImageData
+	data_url?: string
+}
+
+/**
+ * Texture layers always belong to a texture and represent the layers of the texture. Each layer has its own HTML canvas and canvas context
+ */
+declare class TextureLayer {
+	constructor(data: TextureLayerData, texture: Texture, uuid?: string)
+
+	name: string
+	uuid: UUID
+	texture: Texture
+	canvas: HTMLCanvasElement
+	ctx: CanvasRenderingContext2D
+	in_limbo: boolean
+	img: HTMLImageElement
+	/**
+	 * Layer offset from the top left corner of the texture to the top left corner of the layer
+	 */
+	offset: ArrayVector2
+	/**
+	 * Layer scale. This is only used by the layer transform tool and should be applied and reset to 1x1 before doing further changes
+	 */
+	scale: ArrayVector2
+	opacity: number
+	visible: boolean
+	blend_mode: 'default' | 'set_opacity' | 'color' | 'multiply' | 'add' | 'screen' | 'difference'
+
+	extend(data: TextureLayerData): void
+	/**
+	 * Selects the layer
+	 */
+	select(): void
+	showContextMenu(event: Event): void
+	/**
+	 * Remove the layer
+	 * @param undo Create an undo point and update the texture
+	 */
+	remove(undo: boolean): void
+	getUndoCopy(image_data: boolean): object
+	getSaveCopy(): object
+	/**
+	 * Set the layer into a limbo state, where clicking Place or clicking next to the layer will place it on the layer below
+	 */
+	setLimbo(): void
+	/**
+	 * Resolves the limbo state by turning the limbo layer into a full layer, or merging it into the layer below
+	 * @param keep_separate If true, the layer is kept as a separate layer
+	 */
+	resolveLimbo(keep_separate: boolean): void
+	/**
+	 * Set the layer size. This resizes the canvas, which discards the layer content
+	 */
+	setSize(width: number, height: number): void
+	/**
+	 * Toggle layer visibility. This creates an undo point
+	 */
+	toggleVisibility(): void
+	/**
+	 * Scroll the layer panel list to
+	 */
+	scrollTo(): void
+	/**
+	 * Add the layer to the associated texture above the previously selected layer, select this layer, and scroll the layer panel list to it
+	 */
+	addForEditing(): void
+	/**
+	 * Merge this texture onto the texture below
+	 * @param undo Create an undo entry
+	 */
+	mergeDown(undo: boolean): void
+	/**
+	 * Expand the layer to include the listed pixels
+	 * @param points
+	 */
+	expandTo(...points: ArrayVector2): void
+	/**
+	 * Flip the texture along an axis
+	 * @param axis Flip axis, where 0 is X and 1 is Y
+	 * @param undo Create an undo entry
+	 */
+	flip(axis: number, undo: boolean): void
+	/**
+	 * Rotate the layer around itself in 90 degree steps
+	 * @param angle Angle in degrees
+	 * @param undo Create an undo entry
+	 */
+	rotate(angle: number, undo: boolean): void
+	/**
+	 * Centers the layer on the texture
+	 */
+	center(): void
+	/**
+	 * Open the properties dialog
+	 */
+	propertiesDialog(): void
+
+	/**
+	 * Get all layers of the active texture
+	 */
+	static all: TextureLayer[]
+	/**
+	 * Get the selected layer
+	 */
+	static selected: TextureLayer
+}