Blockbench

https://web.blockbench.net/docs
Admin
Blockbench is a 3D model editor, and this documentation provides reference for plugin creators to...
Tokens:288,216
Snippets:3,319
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Plugin Method: install

Source: https://web.blockbench.net/docs/classes/generated_plugin_loader.Plugin.html

Installs the plugin.

```APIDOC
## install
  * install(): Promise<void>
#### Returns Promise<void>
```

--------------------------------

### start Method

Source: https://web.blockbench.net/docs/classes/generated_lib_canvas2apng.APNGencoder.html

Starts the APNG encoding process.

```APIDOC
## start
  * start(): number

### Returns
number - A status code indicating the result of starting the process.
```

--------------------------------

### start Method

Source: https://web.blockbench.net/docs/classes/generated_edit_sessions.EditSession.html

Starts a new editing session with a given username.

```APIDOC
## start
  * start(username: any): void
#### Parameters
    * username: any
#### Returns void
```

--------------------------------

### StartScreen.open()

Source: https://web.blockbench.net/docs/functions/generated_interface_start_screen.StartScreen.open.html

Opens the start screen interface.

```APIDOC
## StartScreen.open()

### Description
Opens the start screen interface.

### Method
open()

### Returns
void
```

--------------------------------

### start Method

Source: https://web.blockbench.net/docs/classes/custom_edit_session.EditSession.html

Starts the edit session, optionally with a specified username.

```APIDOC
## start
  * start(username?: string): void

### Parameters
    * `Optional`username: string

### Returns
void
```

--------------------------------

### onVueSetup

Source: https://web.blockbench.net/docs/modules/custom_util.html

Callback for Vue component setup.

```APIDOC
## Function: onVueSetup

### Description
Registers a callback function to be executed when a Vue component is set up or initialized.

### Parameters
- **callback** (function) - The function to execute upon component setup.
```

--------------------------------

### record

Source: https://web.blockbench.net/docs/classes/generated_interface_keyboard.Keybind.html

Starts recording key presses for the keybind.

```APIDOC
## record
  * record(): this
#### Returns this
```

--------------------------------

### setStartScreen

Source: https://web.blockbench.net/docs/functions/generated_io_project.setStartScreen.html

Sets the starting screen for the project. This function takes a state object as input and returns nothing.

```APIDOC
## Function setStartScreen

### Description
Sets the starting screen for the project.

### Signature
`setStartScreen(state: any): void`

### Parameters
#### Parameters
- **state** (any) - Required - The state object representing the desired start screen.
```

--------------------------------

### StartScreen.open

Source: https://web.blockbench.net/docs/modules/generated_interface_start_screen.StartScreen.html

Opens the start screen interface. This function is used to display the initial screen to the user.

```APIDOC
## StartScreen.open

### Description
Opens the start screen interface.

### Method
(Not specified, likely a function call in an SDK)

### Parameters
(No parameters explicitly documented)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

--------------------------------

### installed_plugin

Source: https://web.blockbench.net/docs/interfaces/custom_misc.BlockbenchEventMap.html

Fired when a plugin has been successfully installed.

```APIDOC
## installed_plugin

### Description
Notifies that a plugin has been installed.

### Parameters
#### Request Body
- **plugin** (Plugin) - Required - The installed plugin object.
```

--------------------------------

### addStartScreenSection

Source: https://web.blockbench.net/docs/modules/generated_interface_start_screen.html

Adds a new section to the start screen.

```APIDOC
## addStartScreenSection

### Description
Adds a new section to the start screen interface.

### Parameters
This function does not appear to have any documented parameters in the source text.

### Returns
This function does not appear to have any documented return values in the source text.
```

--------------------------------

### Plugin Method: isInstallable

Source: https://web.blockbench.net/docs/classes/generated_plugin_loader.Plugin.html

Checks if the plugin is installable.

```APIDOC
## isInstallable
  * isInstallable(): string | true
#### Returns string | true
```

--------------------------------

### initSelection

Source: https://web.blockbench.net/docs/classes/custom_undo.UndoSystem.html

Starts a selection change in the current project.

```APIDOC
## initSelection

### Description
Starts a selection change in the current project.

### Parameters
- **aspects** (UndoSelectionAspects) - Optional: Aspects to save.

### Returns
UndoEntry: The initial undo entry.
```

--------------------------------

### Timeline.start()

Source: https://web.blockbench.net/docs/functions/custom_timeline.Timeline.start.html

Starts playing the animation. This function does not return any value.

```APIDOC
## Function start
  * start(): void
Start playing the animation
#### Returns void
```

--------------------------------

### ArmatureBone.size

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_armature_bone.ArmatureBone.html

Gets the size of the ArmatureBone. Can be called without arguments to get a Vector3, or with an axis to get the size along that axis.

```APIDOC
## size

### Description
Gets the size of the ArmatureBone. Can be called without arguments to get a `Vector3` representing the size in all dimensions, or with an axis to get the size along that specific axis.

### Method
`size(): ArrayVector3`

### Returns
A `Vector3` representing the size of the bone.

### Method
`size(axis: axisLetter): number`

### Parameters
#### Path Parameters
- **axis** (axisLetter) - The axis ('x', 'y', or 'z') to get the size for.
```

--------------------------------

### setupProject

Source: https://web.blockbench.net/docs/modules/generated_io_project.html

Initializes or sets up a project.

```APIDOC
## setupProject

### Description
Initializes or sets up a project.

### Method
(Not specified, likely a function call in an SDK)

### Parameters
(No parameters specified)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

--------------------------------

### MenuBar.setup()

Source: https://web.blockbench.net/docs/functions/custom_menu.MenuBar.setup.html

Initializes the MenuBar. This function does not return any value.

```APIDOC
## Function setup
  * setup(): void
#### Returns void
```

--------------------------------

### Plugin Method: installDependencies

Source: https://web.blockbench.net/docs/classes/generated_plugin_loader.Plugin.html

Installs the plugin's dependencies.

```APIDOC
## installDependencies
  * installDependencies(first: any): Promise<boolean>
#### Parameters
    * first: any
#### Returns Promise<boolean>
```

--------------------------------

### setupProject

Source: https://web.blockbench.net/docs/functions/generated_io_project.setupProject.html

Initializes a new project with a specified model format and an optional UUID.

```APIDOC
## setupProject(format: string | ModelFormat, uuid?: string): boolean

### Description
Initializes a new project with the specified model format and an optional unique identifier.

### Parameters
#### Path Parameters
* **format** (string | ModelFormat) - Required - The model format for the new project.
* **uuid** (string) - Optional - A unique identifier for the project.

### Returns
* **boolean** - Returns true if the project was set up successfully, false otherwise.
```

--------------------------------

### TextureAnimator.start()

Source: https://web.blockbench.net/docs/functions/custom_textures.TextureAnimator.start.html

Starts the texture animation. This function does not take any arguments and returns void.

```APIDOC
## Function start
  * start(): void
#### Returns void
```

--------------------------------

### setup_project

Source: https://web.blockbench.net/docs/interfaces/custom_misc.BlockbenchEventMap.html

An event to set up a new project, with no specific parameters documented.

```APIDOC
## setup_project

### Description
Configures initial settings and structure for a new project.

### Parameters
This event does not have any documented parameters.
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/custom_preview.Preview.html

Initializes a new Preview instance with specified options.

```APIDOC
## constructor
  * new Preview(options: PreviewOptions): Preview
#### Parameters
    * options: PreviewOptions
#### Returns Preview
```

--------------------------------

### setupToolbars()

Source: https://web.blockbench.net/docs/functions/custom_toolbars.BARS.setupToolbars.html

Initializes and sets up custom toolbars. This function does not take any arguments and returns void.

```APIDOC
## Function setupToolbars

### Description
Initializes custom toolbars within the Blockbench interface.

### Signature
`setupToolbars(): void`

### Parameters
This function does not accept any parameters.

### Returns
`void` - This function does not return any value.
```

--------------------------------

### Setting the Mesh in Setup

Source: https://web.blockbench.net/docs/interfaces/custom_canvas.NodePreviewControllerOptions.html

The `mesh` property is for type checking only. It should be set within the `setup` function using `this.mesh`.

```typescript
setup(element) {
   this.mesh = new THREE.Mesh()
}
```

--------------------------------

### Keybind.loadKeymap (Static)

Source: https://web.blockbench.net/docs/classes/custom_toolbars.Keybind.html

Loads a predefined keymap by its ID, optionally from the start screen.

```APIDOC
## loadKeymap(id: string, from_start_screen?: boolean): true | void

### Description
Load an included keymap by ID

### Parameters
* id: string
* `Optional`from_start_screen: boolean

### Returns true | void
```

--------------------------------

### setupPanels()

Source: https://web.blockbench.net/docs/functions/generated_interface_panels.setupPanels.html

Initializes the panels for the Blockbench interface. This function does not return any value.

```APIDOC
## Function setupPanels

### Description
Initializes the panels for the Blockbench interface.

### Signature
`setupPanels(): void`

### Returns
void
```

--------------------------------

### size

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_cube.Cube.html

Gets the size of the cube.

```APIDOC
## size

### Description
Gets the size of the cube.

### Method
`size(axis: any, floored: any): number | number[]`

### Parameters
* **axis** (any) - Description not provided.
* **floored** (any) - Description not provided.
```

--------------------------------

### Client Constructor

Source: https://web.blockbench.net/docs/classes/generated_edit_sessions.EditSession.Client.html

Initializes a new Client instance.

```APIDOC
## constructor new Client(session: any, data: any): Client

### Parameters
* **session** (any)
* **data** (any)

### Returns Client
```

--------------------------------

### getCurrentGroup

Source: https://web.blockbench.net/docs/modules/custom_util.html

Gets the current active group.

```APIDOC
## Function: getCurrentGroup

### Description
Retrieves the currently selected or active group within the application's context.

### Returns
- (object | null) The current group object, or null if no group is active.
```

--------------------------------

### getSpatialInterval

Source: https://web.blockbench.net/docs/modules/generated_modeling_transform.html

Gets the spatial interval for elements.

```APIDOC
## getSpatialInterval

### Description
Gets the spatial interval.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### initialize

Source: https://web.blockbench.net/docs/variables/generated_auto_backup.AutoBackup.html

Initializes the AutoBackup system.

```APIDOC
## initialize

### Description
Initializes the AutoBackup system.

### Method
`initialize(): void`

### Returns
void
```

--------------------------------

### getRotationInterval

Source: https://web.blockbench.net/docs/modules/generated_modeling_transform.html

Gets the rotation interval for elements.

```APIDOC
## getRotationInterval

### Description
Gets the rotation interval.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### addStartScreenSection

Source: https://web.blockbench.net/docs/functions/generated_interface_start_screen.addStartScreenSection.html

Adds a section to the start screen. It takes an ID and data object, and returns an object with a delete method.

```APIDOC
## Function addStartScreenSection
  * addStartScreenSection(
id: string,
data: {
graphic: {
aspect_ratio?: number;
description?: string;
height?: number;
icon?: string;
source?: string;
text_color?: string;
type: string;
width?: number;
};
},
): { delete(): void }

#### Parameters
    * id: string
Identifier
    * data: {
graphic: {
aspect_ratio?: number;
description?: string;
height?: number;
icon?: string;
source?: string;
text_color?: string;
type: string;
width?: number;
};
}
#### Returns { delete(): void }
```

--------------------------------

### getSelectionRotation

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_spline_mesh.SplineMesh.html

Gets the rotation of the current selection.

```APIDOC
## getSelectionRotation

### Description
Gets the rotation of the current selection.

### Method
`getSelectionRotation(): Euler`

### Returns
Euler
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_cube.Cube.html

Initializes the cube.

```APIDOC
## init

### Description
Initializes the cube.

### Method
init

### Returns
- **this** - The current Cube instance after initialization.
```

--------------------------------

### rotationAxis

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_cube.Cube.html

Gets the rotation axis of the cube.

```APIDOC
## rotationAxis

### Description
Gets the rotation axis of the cube.

### Method
rotationAxis

### Returns
- **string** - The rotation axis of the cube.
```

--------------------------------

### getText

Source: https://web.blockbench.net/docs/classes/generated_interface_keyboard.Keybind.html

Gets the text representation of the keybind.

```APIDOC
## getText
  * getText(colorized?: boolean): string
#### Parameters
    * `Optional`colorized: boolean
#### Returns string
```

--------------------------------

### startPath Method

Source: https://web.blockbench.net/docs/classes/custom_codec.Codec.html

Generates the suggested file path for exporting.

```APIDOC
## startPath
  * startPath(): string
Generates the suggested file path. This is the path that the explorer opens in when exporting this type
#### Returns string
```

--------------------------------

### constructor

Source: https://web.blockbench.net/docs/classes/generated_interface_keyboard.Keybind.html

Creates a new Keybind instance.

```APIDOC
## constructor
  * new Keybind(
keys: {
alt: boolean;
ctrl: boolean;
key: string | number;
meta: boolean;
shift: boolean;
},
variations: any,
): Keybind
Create a keybind
#### Parameters
    * keys: {
alt: boolean;
ctrl: boolean;
key: string | number;
meta: boolean;
shift: boolean;
}
Set up the default keys that need to be pressed
      * ##### alt: boolean
Alt key
      * ##### ctrl: boolean
Control key. On MacOS this automatically works for Cmd
      * ##### key: string | number
Main key. Check keycode.info to find out the numeric value, or simply use letters for letter keys
      * ##### meta: boolean
Meta key
      * ##### shift: boolean
Shift key
    * variations: any
#### Returns Keybind
```

--------------------------------

### getUVWidth

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Gets the UV width of the texture.

```APIDOC
## getUVWidth
### Description
Gets the UV width of the texture. If the format uses per-texture UV size, it returns that; otherwise, it returns the project texture width.
### Returns
number
```

--------------------------------

### getUVHeight

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Gets the UV height of the texture.

```APIDOC
## getUVHeight
### Description
Gets the UV height of the texture. If the format uses per-texture UV size, it returns that; otherwise, it returns the project texture height.
### Returns
number
```

--------------------------------

### getMaterial

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Gets the material that the texture displays.

```APIDOC
## getMaterial
### Description
Gets the material that the texture displays. When previewing PBR, this will return the shared PBR material.
### Returns
ShaderMaterial | MeshStandardMaterial
```

--------------------------------

### setupResizeLines()

Source: https://web.blockbench.net/docs/functions/generated_interface_resize_lines.setupResizeLines.html

Initializes the line resizing functionality. This function does not take any arguments and returns void.

```APIDOC
## Function setupResizeLines

### Description
Initializes the line resizing functionality.

### Signature
`setupResizeLines(): void`

### Returns
`void`
```

--------------------------------

### setupActions Function

Source: https://web.blockbench.net/docs/functions/custom_toolbars.BARS.setupActions.html

The setupActions function is a void function that initializes or sets up actions for custom toolbars.

```APIDOC
## Function setupActions

### Description
Initializes or sets up actions for custom toolbars.

### Signature
`setupActions(): void`

### Returns
`void`
```

--------------------------------

### get

Source: https://web.blockbench.net/docs/classes/custom_textures.IntMatrix.html

Retrieves the value of a specified pixel.

```APIDOC
## get
  * get(x: number, y: number): number | boolean
Get the value at the specified pixel

#### Parameters
    * x: number
X coordinate
    * y: number
Y coordinate

#### Returns number | boolean
The value of the targeted pixel
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/custom_preview_scene.PreviewScene.html

Creates a new PreviewScene instance.

```APIDOC
## constructor
  * new PreviewScene(id: string, options: PreviewSceneOptions): PreviewScene
#### Parameters
    * id: string
    * options: PreviewSceneOptions
#### Returns PreviewScene
```

--------------------------------

### getSaveCopy

Source: https://web.blockbench.net/docs/classes/custom_outliner.NullObject.html

Gets a savable copy of the element.

```APIDOC
## getSaveCopy
  * getSaveCopy(): any

#### Returns any
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/generated_interface_themes.CustomTheme.html

Initializes a new CustomTheme instance. Optionally takes partial theme data to pre-populate the theme.

```APIDOC
## Constructor

### new CustomTheme(data?: Partial<ThemeData>): CustomTheme

#### Parameters

* `Optional`data: Partial<ThemeData> - Partial theme data to initialize with.

#### Returns

CustomTheme - A new instance of CustomTheme.
```

--------------------------------

### guid

Source: https://web.blockbench.net/docs/modules/custom_util.html

Generates a globally unique identifier.

```APIDOC
## Function: guid

### Description
Generates a standard GUID (Globally Unique Identifier) string.

### Returns
- (string) A unique identifier string.
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_billboard.Billboard.html

Initializes the billboard object.

```APIDOC
## init

### Description
Initializes the billboard object, setting up its default state and properties.

### Method
`init()`

### Returns
- `this` - The initialized billboard instance.
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/generated_util_property.Property.html

Initializes a new Property instance.

```APIDOC
## constructor
  * new Property<T extends keyof IPropertyType>(
target_class: any,
type: T,
name: string,
options?: PropertyOptions,
): Property<T>
#### Type Parameters
  * T extends keyof IPropertyType
#### Parameters
  * target_class: any
  * type: T
  * name: string
  * `Optional`options: PropertyOptions
#### Returns Property<T>
```

--------------------------------

### guid()

Source: https://web.blockbench.net/docs/functions/custom_util.guid.html

Generates a new random UUID.

```APIDOC
## Function guid
  * guid(): string
Generate a new random UUID
#### Returns string
```

--------------------------------

### get

Source: https://web.blockbench.net/docs/modules/custom_util.html

Retrieves a value from an object, potentially nested.

```APIDOC
## Function: get

### Description
Safely retrieves a value from a nested object structure using a path.

### Parameters
- **obj** (object) - The object to retrieve the value from.
- **path** (string | string[]) - The path to the desired value (e.g., 'a.b.c' or ['a', 'b', 'c']).
- **defaultValue** (any, optional) - The value to return if the path does not exist.

### Returns
- (any) The retrieved value or the defaultValue.
```

--------------------------------

### show

Source: https://web.blockbench.net/docs/classes/generated_interface_dialog.ToolConfig.html

Opens the configuration menu. Can optionally be anchored to a specific HTML element.

```APIDOC
## show

### Description
Open the config menu.

### Parameters
* `anchor` (optional): HTMLElement - Optional element to anchor the menu to.

### Returns
this
```

--------------------------------

### name_regex

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_group.Group.html

Gets the name of the element as a regular expression.

```APIDOC
## name_regex

### Description
Gets the name of the element as a regular expression.

### Method
name_regex

### Returns
string | false
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/custom_group.Group.html

Initializes the node.

```APIDOC
## init()

### Description
Initializes the node. This should always be called when creating nodes that will be used in the outliner.
```

--------------------------------

### getWorldCenter

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_billboard.Billboard.html

Gets the world center coordinates of the billboard.

```APIDOC
## getWorldCenter

### Description
Calculates and returns the world-space center coordinates of the billboard.

### Method
`getWorldCenter()`

### Returns
- `Vector3` - A Vector3 object representing the world center.
```

--------------------------------

### setupResizeLines

Source: https://web.blockbench.net/docs/modules/generated_interface_resize_lines.html

Initializes the resize lines functionality for the interface.

```APIDOC
## Function: setupResizeLines

### Description
Sets up the resize lines interface, allowing users to adjust element dimensions.

### Parameters
This function does not take any parameters.

### Returns
This function does not return any value.
```

--------------------------------

### getCode

Source: https://web.blockbench.net/docs/classes/generated_interface_keyboard.Keybind.html

Gets the key code for a given key.

```APIDOC
## getCode
  * getCode(key: any): string
#### Parameters
    * key: any
#### Returns string
```

--------------------------------

### PointerTarget.active

Source: https://web.blockbench.net/docs/classes/generated_interface_pointer_target.PointerTarget.html

Gets or sets the currently active PointerTargetType.

```APIDOC
## Property: active

`static active: PointerTargetType`

Represents the currently active target for the pointer or pointer drag.
```

--------------------------------

### Window Constructor

Source: https://web.blockbench.net/docs/variables/custom_util_version_util.Window.html

Provides information about creating a new Window instance.

```APIDOC
## Window Constructor

### Description
Creates a new instance of the Window utility.

### Method
`new()`

### Returns
- **Window**: A new Window object.
```

--------------------------------

### getActiveLayer

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Gets the currently selected texture layer.

```APIDOC
## getActiveLayer
### Description
Gets the selected layer. If no layer is selected, it returns the bottom layer.
### Returns
TextureLayer
```

--------------------------------

### KeybindItem Constructor

Source: https://web.blockbench.net/docs/classes/generated_interface_actions.KeybindItem.html

Initializes a new KeybindItem instance.

```APIDOC
## constructor

### Description
Initializes a new KeybindItem.

### Parameters
* **id** (string) - The unique identifier for the keybind item.
* **data** (KeybindItemOptions & { id: string }) - An object containing keybind options and the id.

### Returns
KeybindItem - The newly created KeybindItem instance.
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/custom_cube.Cube.html

Initializes the node, preparing it for use in the outliner.

```APIDOC
## init

### Description
Initializes the node. This should always be called when creating nodes that will be used in the outliner.

### Method
`init(): this`

### Returns
`this` (the current instance).
```

--------------------------------

### getUndoCopy

Source: https://web.blockbench.net/docs/classes/custom_outliner.NullObject.html

Gets a copy of the element for undo operations.

```APIDOC
## getUndoCopy
  * getUndoCopy(): any

#### Returns any
```

--------------------------------

### SplineHandle.getHandleKey Method

Source: https://web.blockbench.net/docs/classes/custom_spline_mesh.SplineHandle.html

Gets the unique key for this handle.

```APIDOC
## getHandleKey
  * getHandleKey(): string
#### Returns string
```

--------------------------------

### SplineHandle.element Accessor

Source: https://web.blockbench.net/docs/classes/custom_spline_mesh.SplineHandle.html

Gets the SplineMesh associated with this handle.

```APIDOC
## element
  * get element(): SplineMesh
#### Returns SplineMesh
```

--------------------------------

### setupFloatHandles

Source: https://web.blockbench.net/docs/classes/generated_interface_panels.Panel.html

Initializes or sets up the floating handles for the panel.

```APIDOC
## setupFloatHandles

### Description
Initializes or sets up the floating handles for the panel, likely for drag-and-drop or resizing functionality.

### Returns
this: The panel instance for chaining.
```

--------------------------------

### setStartScreen

Source: https://web.blockbench.net/docs/modules/generated_io_project.html

Sets the initial screen or view for the project.

```APIDOC
## setStartScreen

### Description
Sets the initial screen or view for the project.

### Method
(Not specified, likely a function call in an SDK)

### Parameters
(No parameters specified)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

--------------------------------

### on

Source: https://web.blockbench.net/docs/classes/generated_interface_form.InputForm.html

Shorthand for addListener.

```APIDOC
## on(event_name: string, cb: EventListener)

### Description
Shorthand method for adding an event listener.

### Parameters
* **event_name**: string - The name of the event to listen for.
* **cb**: EventListener - The callback function to execute when the event is triggered.

### Returns
Deletable - An object that can be used to remove the listener.
```

--------------------------------

### Cube Constructor

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_cube.Cube.html

Initializes a new Cube instance.

```APIDOC
## constructor

### Description
Initializes a new Cube instance.

### Method
constructor

### Parameters
* **data** (any) - Required - The data to initialize the cube with.
* **uuid** (any) - Required - The unique identifier for the cube.

### Returns
Cube - The newly created Cube instance.
```

--------------------------------

### getWorldCenter

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_cube.Cube.html

Gets the center position of the cube in world coordinates.

```APIDOC
## getWorldCenter

### Description
Gets the center position of the cube in world coordinates.

### Method
getWorldCenter

### Returns
- **Vector3** - A Vector3 object representing the world center.
```

--------------------------------

### getGlobalVertexPositions

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_cube.Cube.html

Gets the global positions of the cube's vertices.

```APIDOC
## getGlobalVertexPositions

### Description
Gets the global positions of the cube's vertices.

### Method
getGlobalVertexPositions

### Returns
- **Vector3Tuple[]** - An array of Vector3Tuple representing the vertex positions.
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/custom_toolbars._ToolToolbar.html

Initializes a new instance of the _ToolToolbar class.

```APIDOC
## Constructor

### new _ToolToolbar(id: string, data: ToolbarOptions): _ToolToolbar

#### Parameters
    * id: string
    * data: ToolbarOptions

### new _ToolToolbar(data: ToolbarOptions): _ToolToolbar

#### Parameters
    * data: ToolbarOptions

#### Returns _ToolToolbar
```

--------------------------------

### ArmatureBone.getSize

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_armature_bone.ArmatureBone.html

Gets the size of the ArmatureBone along a specified axis.

```APIDOC
## getSize

### Description
Gets the size of the ArmatureBone along a specified axis.

### Method
`getSize(axis: any): number`

### Parameters
#### Path Parameters
- **axis** (any) - The axis along which to get the size.
```

--------------------------------

### buildModel

Source: https://web.blockbench.net/docs/classes/custom_preview_scene.PreviewModel.html

Builds the model, applying all configurations and preparing it for rendering.

```APIDOC
## buildModel
  * buildModel(): void
#### Returns void
```

--------------------------------

### select

Source: https://web.blockbench.net/docs/classes/custom_preview_scene.PreviewScene.html

Selects this PreviewScene, making it the active scene.

```APIDOC
## select
  * select(): void
Selects this preview scene
#### Returns void
```

--------------------------------

### getFacingHeight

Source: https://web.blockbench.net/docs/classes/custom_preview.Preview.html

Gets the current facing height of the preview camera.

```APIDOC
## getFacingHeight
  * getFacingHeight(): "up" | "down" | "middle"
#### Returns "up" | "down" | "middle"
```

--------------------------------

### initConnection Method

Source: https://web.blockbench.net/docs/classes/custom_edit_session.EditSession.html

Initializes a P2P connection for the session.

```APIDOC
## initConnection
  * initConnection(conn: any): void

### Parameters
    * conn: any

### Returns
void
```

--------------------------------

### getFacingDirection

Source: https://web.blockbench.net/docs/classes/custom_preview.Preview.html

Gets the current facing direction of the preview camera.

```APIDOC
## getFacingDirection
  * getFacingDirection(): "east" | "west" | "south" | "north"
#### Returns "east" | "west" | "south" | "north"
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/custom_keyframe._Keyframe.html

Initializes a new _Keyframe instance.

```APIDOC
## constructor
  * new _Keyframe(options: KeyframeOptions, uuid: any): _Keyframe
#### Parameters
    * options: KeyframeOptions
    * uuid: any
#### Returns _Keyframe
```

--------------------------------

### getStateTime

Source: https://web.blockbench.net/docs/classes/custom_animation_controller.AnimationControllerState.html

Gets the current animation time of the state in seconds.

```APIDOC
### getStateTime
  * getStateTime(): number
Returns the current animation time of the state in seconds
```

--------------------------------

### getDepth

Source: https://web.blockbench.net/docs/classes/custom_cube.Cube.html

Gets the depth of the current node in the outliner hierarchy.

```APIDOC
## getDepth

### Description
Gets the depth of the current node in the outliner hierarchy.

### Method
`getDepth(): number`

### Returns
A number representing the depth.
```

--------------------------------

### newProject

Source: https://web.blockbench.net/docs/modules/generated_io_project.html

Creates a new project.

```APIDOC
## newProject

### Description
Creates a new project.

### Method
(Not specified, likely a function call in an SDK)

### Parameters
(No parameters specified)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

--------------------------------

### setupMobilePanelSelector

Source: https://web.blockbench.net/docs/functions/generated_interface_panels.setupMobilePanelSelector.html

Initializes the mobile panel selector interface.

```APIDOC
## Function setupMobilePanelSelector

### Description
Initializes the mobile panel selector interface.

### Signature
`setupMobilePanelSelector(): void`

### Returns
void
```

--------------------------------

### getUndoCopy Method

Source: https://web.blockbench.net/docs/classes/custom_cube.CubeFace.html

Gets a copy of the face for undo tracking.

```APIDOC
## getUndoCopy

### Description
Gets a copy of the face for undo tracking.

### Returns
Face
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/custom_outliner.Locator.html

Initializes a new instance of the Locator class.

```APIDOC
## constructor
  * new Locator(options: Partial<LocatorOptions>, uuid?: string): Locator
#### Parameters
    * options: Partial<LocatorOptions>
    * `Optional`uuid: string
#### Returns Locator
```

--------------------------------

### Constructor

Source: https://web.blockbench.net/docs/classes/generated_preview_reference_images.ReferenceImage.html

Initializes a new instance of the ReferenceImage class.

```APIDOC
## constructor
  * new ReferenceImage(data?: {}): ReferenceImage
#### Parameters
    * `Optional`data: {}
#### Returns ReferenceImage
```

--------------------------------

### initConnection Method

Source: https://web.blockbench.net/docs/classes/generated_edit_sessions.EditSession.html

Initializes a new connection for the session.

```APIDOC
## initConnection
  * initConnection(conn: any): void
#### Parameters
    * conn: any
#### Returns void
```

--------------------------------

### getCenter

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_mesh.Mesh.html

Gets the center point of the mesh, optionally in global coordinates.

```APIDOC
## getCenter

### Description
Gets the center point of the mesh, optionally in global coordinates.

### Method
getCenter(global: any)

### Parameters
#### Path Parameters
- **global** (any) - Description

### Returns
number[]
```

--------------------------------

### getOwnMaterial

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Gets the texture's own material, distinct from shared materials.

```APIDOC
## getOwnMaterial
### Description
Gets the texture's own material, not a shared one.
### Returns
ShaderMaterial
```

--------------------------------

### Keybind.getText

Source: https://web.blockbench.net/docs/classes/custom_toolbars.Keybind.html

Gets a display string for the keybind, optionally formatted with HTML.

```APIDOC
## getText(formatted?: boolean): string

### Description
Get display text showing the keybind

### Parameters
* `Optional`formatted: boolean
If true, the return string will include HTML formatting

### Returns string
```

--------------------------------

### Texture Material Access

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Get or set the ShaderMaterial associated with a texture.

```APIDOC
## get material
### Description
Gets the ShaderMaterial of the texture.
### Returns
ShaderMaterial

## set material
### Description
Sets the ShaderMaterial of the texture.
### Parameters
* `value` (ShaderMaterial) - The ShaderMaterial to set.
### Returns
void
```

--------------------------------

### openSettings

Source: https://web.blockbench.net/docs/classes/generated_io_project.ModelProject.html

Opens the settings dialog for the project.

```APIDOC
## openSettings

### Description
Opens the settings dialog for the project.

### Method
`openSettings(): void`
```

--------------------------------

### getCenter

Source: https://web.blockbench.net/docs/classes/custom_mesh.Mesh.html

Gets the center point of the mesh, optionally in global coordinates.

```APIDOC
## getCenter

### Description
Gets the center point of the mesh, optionally in global coordinates.

### Method
getCenter(global: boolean): Vector3

### Parameters
#### Path Parameters
* **global** (boolean) - If true, returns the global center coordinates.
```

--------------------------------

### getOrMakeKeyframe Method

Source: https://web.blockbench.net/docs/classes/custom_animation.NullObjectAnimator.html

Gets an existing keyframe or creates a new one.

```APIDOC
## getOrMakeKeyframe
  * getOrMakeKeyframe(): { before: _Keyframe; result: _Keyframe }

### Returns
{ before: _Keyframe; result: _Keyframe }
```

--------------------------------

### createBackup

Source: https://web.blockbench.net/docs/modules/custom_desktop.html

Creates a backup of the current project.

```APIDOC
## createBackup

### Description
Creates a backup of the current project.

### Function Signature
createBackup()

### Returns
- **string** - The path to the created backup file.
```

--------------------------------

### Static getDefaultValue

Source: https://web.blockbench.net/docs/classes/generated_interface_form.InputForm.html

Gets the default value for a form input based on its configuration.

```APIDOC
## getDefaultValue(input_config: FormElementOptions)

### Description
Retrieves the default value for a form input element based on its configuration.

### Parameters
* **input_config**: FormElementOptions - The configuration object for the form element.

### Returns
FormResultValue - The default value for the input.
```

--------------------------------

### startConversion

Source: https://web.blockbench.net/docs/modules/custom_io.Extruder.html

Initiates the conversion process within the Extruder namespace. Further details are not provided in the source.

```APIDOC
## startConversion

### Description
Starts the conversion process.

### Method
Not specified in source.

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### getSize

Source: https://web.blockbench.net/docs/classes/custom_spline_mesh.SplineMesh.html

Gets the size of the spline mesh, optionally filtered by axis or selection.

```APIDOC
## getSize

### Description
Gets the size of the spline mesh.

### Method
`getSize(axis?: axisNumber, selection_only?: any): number`

### Parameters
#### Optional Parameters
- **axis** (axisNumber) - Specifies the axis for which to get the size.
- **selection_only** (any) - Filters the size calculation based on selection.

### Returns
number - The size of the spline mesh.
```

--------------------------------

### PreviewModel Constructor

Source: https://web.blockbench.net/docs/classes/custom_preview_scene.PreviewModel.html

Initializes a new PreviewModel instance. Requires a unique ID and optional configuration options.

```APIDOC
## constructor
  * new PreviewModel(id: string, options: PreviewModelOptions): PreviewModel
#### Parameters
    * id: string
    * options: PreviewModelOptions
#### Returns PreviewModel
```

--------------------------------

### getWorldCenter

Source: https://web.blockbench.net/docs/classes/custom_mesh.Mesh.html

Gets the world-space center of the mesh, with an option to ignore mesh selection.

```APIDOC
## getWorldCenter

### Description
Gets the world-space center of the mesh, with an option to ignore mesh selection.

### Method
getWorldCenter(ignore_mesh_selection?: boolean): Vector3

### Parameters
#### Path Parameters
* **ignore_mesh_selection** (boolean) - Optional. If true, ignores the current mesh selection when calculating the center.
```

--------------------------------

### BillboardFace Constructor

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_billboard.BillboardFace.html

Initializes a new instance of the BillboardFace class.

```APIDOC
## constructor
  * new BillboardFace(data: any, billboard: any): BillboardFace
#### Parameters
    * data: any
    * billboard: any
#### Returns BillboardFace
```

--------------------------------

### IntMatrix Constructor

Source: https://web.blockbench.net/docs/classes/custom_textures.IntMatrix.html

Initializes a new IntMatrix with the specified width and height.

```APIDOC
## constructor
  * new IntMatrix(width: number, height: number): IntMatrix

### Parameters
    * width: number
    * height: number

### Returns IntMatrix
```

--------------------------------

### SplineHandle.getUndoCopy Method

Source: https://web.blockbench.net/docs/classes/custom_spline_mesh.SplineHandle.html

Gets a copy of the handle's data for undo operations.

```APIDOC
## getUndoCopy
  * getUndoCopy(): any
#### Returns any
```

--------------------------------

### SplineHandle.getSaveCopy Method

Source: https://web.blockbench.net/docs/classes/custom_spline_mesh.SplineHandle.html

Gets a copy of the handle's data suitable for saving.

```APIDOC
## getSaveCopy
  * getSaveCopy(): {
control1: any;
control2: any;
joint: any;
size: any;
tilt: any;
}
#### Returns { control1: any; control2: any; joint: any; size: any; tilt: any }
```

--------------------------------

### BoundingBox Constructor

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_bounding_box.BoundingBox.html

Initializes a new BoundingBox instance.

```APIDOC
## constructor
  * new BoundingBox(data?: BoundingBoxOptions, uuid?: string): BoundingBox
#### Parameters
    * `Optional`data: BoundingBoxOptions
    * `Optional`uuid: string
#### Returns BoundingBox
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/custom_outliner.NullObject.html

Initializes the node. This should always be called when creating nodes that will be used in the outliner.

```APIDOC
## init
  * init(): this
Initializes the node. This should always be called when creating nodes that will be used in the outliner.

#### Returns this
```

--------------------------------

### get

Source: https://web.blockbench.net/docs/classes/custom_keyframe._Keyframe.html

Retrieves a specific value from the keyframe for a given axis and data point.

```APIDOC
## get
  * get(axis: axisLetter, data_point?: number): string | number
#### Parameters
    * axis: axisLetter
    * `Optional`data_point: number
#### Returns string | number
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_mesh.Mesh.html

Initializes the node. This should always be called when creating nodes that will be used in the outliner.

```APIDOC
## init

### Description
Initializes the node. This should always be called when creating nodes that will be used in the outliner.

### Method
init()

### Returns
this
```

--------------------------------

### init

Source: https://web.blockbench.net/docs/classes/generated_outliner_types_bounding_box.BoundingBox.html

Initializes the node. This should always be called when creating nodes that will be used in the outliner.

```APIDOC
## init

### Description
Initializes the node. This should always be called when creating nodes that will be used in the outliner.

### Method
POST

### Endpoint
/BoundingBox/init

### Returns
- this - The initialized node.
```

--------------------------------

### startWatcher

Source: https://web.blockbench.net/docs/classes/custom_textures.Texture.html

Starts listening for changes to the linked file. This is only available in the desktop application.

```APIDOC
## startWatcher

### Description
Start listening for changes to the linked file. Desktop only.

### Method
startWatcher(): void
```
Tokens:
Raw