Class Blockbench

Index

Constructors

Properties

Action addDragHandler Animation AnimationController AnimationControllerState AnimationItem Animator argv BarItem BarItems BarMenu BarSelect BarSlider BarText BillboardFace BoneAnimator Codec ColorPicker Cube CubeFace Dialog DisplaySlot drag_handlers EffectAnimator events export exportFile Face findFileFromContent flags Format Group import importFile InputForm isLandscape isMobile isTouch isWeb Keybind KeybindItem Keyframe KeyframeDataPoint Language Locator Menu Mesh MeshFace Mode ModelFormat ModelLoader ModelProject NodePreviewController NullObject NullObjectAnimator NumSlider openTime operating_system Outliner OutlinerElement OutlinerNode Painter Panel pickDirectory platform Plugin Preview Project read readFile removeDragHandler ResizeLine Reusable Screencam Setting Settings setup_successful ShapelessDialog SharedActions SplineCurve SplineHandle SplineMesh Texture TextureAnimator TextureLayer TextureMesh Timeline TimelineMarker Toggle Tool Toolbar Toolbox ToolConfig version Widget writeFile

Accessors

isPWA Undo

Constructors

constructor

new Blockbench(): Blockbench
Returns Blockbench

Properties

`Static`Action

Action: typeof Action

`Static`addDragHandler

addDragHandler: any

`Static`Animation

Animation: typeof _Animation

`Static`AnimationController

AnimationController: typeof AnimationController

`Static`AnimationControllerState

AnimationControllerState: typeof AnimationControllerState

`Static`AnimationItem

AnimationItem: typeof AnimationItem

`Static`Animator

Animator: typeof Animator

`Static`argv

argv: string[]

`Static`BarItem

BarItem: typeof BarItem

`Static`BarItems

BarItems: Record<string, BarItem>

`Static`BarMenu

BarMenu: typeof BarMenu

`Static`BarSelect

BarSelect: typeof BarSelect

`Static`BarSlider

BarSlider: typeof BarSlider

`Static`BarText

BarText: typeof BarText

`Static`BillboardFace

BillboardFace: any

`Static`BoneAnimator

BoneAnimator: typeof BoneAnimator

`Static`Codec

Codec: typeof Codec

`Static`ColorPicker

ColorPicker: typeof ColorPicker

`Static`Cube

Cube: typeof Cube

`Static`CubeFace

CubeFace: typeof CubeFace

`Static`Dialog

Dialog: typeof Dialog

`Static`DisplaySlot

DisplaySlot: typeof DisplaySlot

`Static`drag_handlers

drag_handlers: {}

`Static`EffectAnimator

EffectAnimator: typeof EffectAnimator

`Static`events

events: Record<string, Function[]>

`Static`export

export: any

`Static`exportFile

exportFile: any

`Static`Face

Face: typeof Face

`Static`findFileFromContent

findFileFromContent: any

`Static`flags

flags: any[]

`Static`Format

Format: number | ModelFormat

`Static`Group

Group: typeof Group

`Static`import

import: any

`Static`importFile

importFile: any

`Static`InputForm

InputForm: typeof InputForm

`Static`isLandscape

isLandscape: boolean

`Static`isMobile

isMobile: boolean

`Static`isTouch

isTouch: boolean

`Static`isWeb

isWeb: boolean

`Static`Keybind

Keybind: typeof Keybind

`Static`KeybindItem

KeybindItem: typeof KeybindItem

`Static`Keyframe

Keyframe: any

`Static`KeyframeDataPoint

KeyframeDataPoint: typeof KeyframeDataPoint

`Static`Language

Language: {
    code: string;
    data: {};
    options: {
        cz: string;
        de: string;
        en: string;
        es: string;
        fr: string;
        it: string;
        ja: string;
        ko: string;
        nl: string;
        pl: string;
        pt: string;
        pt_br: string;
        ru: string;
        sv: string;
        tr: string;
        uk: string;
        vi: string;
        zh: string;
        zh_tw: string;
    };
    toString: () => string;
    addTranslations(language: string, strings: Record<string, string>): void;
}

Type Declaration

code: string
Language code indicating the currently selected language
data: {}
Translation data for the current language
options: {
    cz: string;
    de: string;
    en: string;
    es: string;
    fr: string;
    it: string;
    ja: string;
    ko: string;
    nl: string;
    pl: string;
    pt: string;
    pt_br: string;
    ru: string;
    sv: string;
    tr: string;
    uk: string;
    vi: string;
    zh: string;
    zh_tw: string;
}
toString: () => string
addTranslations: function
- addTranslations(language: string, strings: Record<string, string>): void
  Add translations for custom translation strings
  Parameters
  - language: string
    Two letter language code, e. G. 'en'
  - strings: Record<string, string>
    Object listing the translation keys and values
  Returns void
  - Defined in types/generated/languages.d.ts:86

`Static`Locator

Locator: typeof Locator

`Static`Menu

Menu: typeof Menu

`Static`Mesh

Mesh: typeof Mesh

`Static`MeshFace

MeshFace: typeof MeshFace

`Static`Mode

Mode: typeof Mode

`Static`ModelFormat

ModelFormat: typeof ModelFormat

`Static`ModelLoader

ModelLoader: typeof ModelLoader

`Static`ModelProject

ModelProject: typeof ModelProject

`Static`NodePreviewController

NodePreviewController: typeof NodePreviewController

`Static`NullObject

NullObject: typeof NullObject

`Static`NullObjectAnimator

NullObjectAnimator: typeof NullObjectAnimator

`Static`NumSlider

NumSlider: typeof NumSlider

`Static`openTime

openTime: Date

`Static`operating_system

operating_system: string

`Static`Outliner

Outliner: typeof Outliner

`Static`OutlinerElement

OutlinerElement: typeof OutlinerElement

`Static`OutlinerNode

OutlinerNode: typeof OutlinerNode

`Static`Painter

Painter: typeof Painter

`Static`Panel

Panel: typeof Panel

`Static`pickDirectory

pickDirectory: any

`Static`platform

platform: string

`Static`Plugin

Plugin: typeof Plugin

`Static`Preview

Preview: typeof Preview

`Static`Project

Project: number | ModelProject

`Static`read

read: any

`Static`readFile

readFile: any

`Static`removeDragHandler

removeDragHandler: any

`Static`ResizeLine

ResizeLine: typeof ResizeLine

`Static`Reusable

Reusable: typeof Reusable

`Static`Screencam

Screencam: typeof Screencam

`Static`Setting

Setting: typeof Setting

`Static`Settings

Settings: {
    dialog: Dialog;
    old: {};
    profile_menu_button: HTMLElement;
    stored: Record<string, SettingsValue>;
    structure: Record<
        string,
        { items: Record<string, Setting>; name: string; open: boolean },
    >;
    addCategory(id: string, data: { name?: string; open?: boolean }): void;
    get(id: string): SettingsValue;
    import(file: any): void;
    openDialog(options?: { profile?: string; search_term?: string }): void;
    save(): void;
    saveLocalStorages(): void;
    showRestartMessage(settings?: Setting[]): void;
    updateProfileButton(): void;
    updateSettingsInProfiles(): void;
}

Type Declaration

dialog: Dialog
old: {}
profile_menu_button: HTMLElement
stored: Record<string, SettingsValue>
structure: Record<string, { items: Record<string, Setting>; name: string; open: boolean }>
addCategory: function
- addCategory(id: string, data: { name?: string; open?: boolean }): void
  Parameters
  - id: string
  - data: { name?: string; open?: boolean }
  Returns void
  - Defined in types/generated/interface/settings.d.ts:162
get: function
- get(id: string): SettingsValue
  Returns the value of the specified setting
  Parameters
  - id: string
  Returns SettingsValue
  - Defined in types/generated/interface/settings.d.ts:180
import: function
- import(file: any): void
  Parameters
  - file: any
  Returns void
  - Defined in types/generated/interface/settings.d.ts:176
openDialog: function
- openDialog(options?: { profile?: string; search_term?: string }): void
  Parameters
  - Optionaloptions: { profile?: string; search_term?: string }
  Returns void
  - Defined in types/generated/interface/settings.d.ts:181
save: function
- save(): void
  Save the settings and apply changes
  
  Returns void
  - Defined in types/generated/interface/settings.d.ts:173
saveLocalStorages: function
- saveLocalStorages(): void
  Save all settings to the local storage
  
  Returns void
  - Defined in types/generated/interface/settings.d.ts:169
showRestartMessage: function
- showRestartMessage(settings?: Setting[]): void
  Parameters
  - Optionalsettings: Setting[]
  Returns void
  - Defined in types/generated/interface/settings.d.ts:185
updateProfileButton: function
- updateProfileButton(): void
  Returns void
  - Defined in types/generated/interface/settings.d.ts:175
updateSettingsInProfiles: function
- updateSettingsInProfiles(): void
  Returns void
  - Defined in types/generated/interface/settings.d.ts:174

`Static`setup_successful

setup_successful: true

`Static`ShapelessDialog

ShapelessDialog: typeof ShapelessDialog

`Static`SharedActions

SharedActions: {
    actions: Record<string, SharedActionHandler[]>;
    add(action_id: string, handler: SharedActionHandler): Deletable;
    condition(action_id: string): boolean;
    find(action_id: string, event?: Event, context?: any): SharedActionHandler;
    run(action_id: string, event?: Event, context?: any): boolean;
    runSpecific(
        action_id: string,
        subject: string,
        event?: Event,
        context?: any,
        force?: boolean,
    ): boolean;
}

Type Declaration

actions: Record<string, SharedActionHandler[]>
add: function
- add(action_id: string, handler: SharedActionHandler): Deletable
  Add a method to handle a specific use case of a shared action
  Parameters
  - action_id: string
    Action ID
  - handler: SharedActionHandler
    Handler options
  Returns Deletable
  - Defined in types/generated/interface/shared_actions.d.ts:90
condition: function
- condition(action_id: string): boolean
  Check if there is an active and available handler in the current situation for a shared action
  Parameters
  - action_id: string
  Returns boolean
  - Defined in types/generated/interface/shared_actions.d.ts:111
find: function
- find(action_id: string, event?: Event, context?: any): SharedActionHandler
  Find the active handler in the current situation for a shared action
  Parameters
  - action_id: string
  - Optionalevent: Event
  - Optionalcontext: any
  Returns SharedActionHandler
  - Defined in types/generated/interface/shared_actions.d.ts:118
run: function
- run(action_id: string, event?: Event, context?: any): boolean
  Run the active handler for a specific subject manually
  Parameters
  - action_id: string
    Action ID
  - Optionalevent: Event
    Event that triggered the interaction
  - Optionalcontext: any
    Optional context variable
  Returns boolean
  - Defined in types/generated/interface/shared_actions.d.ts:97
runSpecific: function
- runSpecific(
      action_id: string,
      subject: string,
      event?: Event,
      context?: any,
      force?: boolean,
  ): boolean
  Run a specific handler manually
  Parameters
  - action_id: string
    Action ID
  - subject: string
    Subject to run on
  - Optionalevent: Event
    Event that triggered the interaction
  - Optionalcontext: any
    Optional context variable
  - Optionalforce: boolean
    Force the specified handler to run and ignore its condition
  Returns boolean
  - Defined in types/generated/interface/shared_actions.d.ts:106

`Static`SplineCurve

SplineCurve: any

`Static`SplineHandle

SplineHandle: any

`Static`SplineMesh

SplineMesh: any

`Static`Texture

Texture: typeof Texture

`Static`TextureAnimator

TextureAnimator: typeof TextureAnimator

`Static`TextureLayer

TextureLayer: typeof TextureLayer

`Static`TextureMesh

TextureMesh: typeof TextureMesh

`Static`Timeline

Timeline: typeof Timeline

`Static`TimelineMarker

TimelineMarker: typeof TimelineMarker

`Static`Toggle

Toggle: typeof Toggle

`Static`Tool

Tool: typeof Tool

`Static`Toolbar

Toolbar: typeof Toolbar

`Static`Toolbox

Toolbox: _ToolToolbar

`Static`ToolConfig

ToolConfig: typeof ToolConfig

`Static`version

version: string

`Static`Widget

Widget: typeof Widget

`Static`writeFile

writeFile: any

Accessors

`Static`isPWA

get isPWA(): boolean
Returns boolean
- Defined in types/generated/api.d.ts:39

`Static`Undo

get Undo(): UndoSystem
Returns UndoSystem
- Defined in types/generated/api.d.ts:97

Methods

`Static`addCSS

addCSS(css: string, layer?: string): Deletable
Parameters
- css: string
- Optionallayer: string
Returns Deletable
- Defined in types/generated/api.d.ts:85

`Static`addFlag

addFlag(flag: string): void
Parameters
- flag: string
Returns void
- Defined in types/generated/api.d.ts:86

`Static`addListener

addListener<T extends keyof BlockbenchEventMap, D extends any>(
event_name: T,
cb: (data: D) => any,
): Deletable
Type Parameters
- T extends keyof BlockbenchEventMap
- D extends any
Parameters
- event_name: T
- cb: (data: D) => any
Returns Deletable
- Defined in types/generated/api.d.ts:92

`Static`addMenuEntry

addMenuEntry(name: string, icon: string, click: any): void
Parameters
- name: string
- icon: string
- click: any
Returns void
- Defined in types/generated/api.d.ts:81

`Static`dispatchEvent

dispatchEvent<T extends keyof BlockbenchEventMap, D extends any>(
event_name: T,
data: D,
): any[]
Type Parameters
- T extends keyof BlockbenchEventMap
- D extends any
Parameters
- event_name: T
- data: D
Returns any[]
- Defined in types/generated/api.d.ts:89

`Static`edit

edit(aspects: UndoAspects, cb: () => void): void
Parameters
- aspects: UndoAspects
- cb: () => void
Returns void
Deprecated
Use Undo.initEdit and Undo.finishEdit instead
- Defined in types/generated/api.d.ts:52

`Static`getIconNode

getIconNode(
    icon:
        | string
        | boolean
        | HTMLElement
        | (() => string | boolean | HTMLElement),
    color?: string,
): HTMLElement
Parameters
- icon: string | boolean | HTMLElement | (() => string | boolean | HTMLElement)
- Optionalcolor: string
Returns HTMLElement
- Defined in types/generated/api.d.ts:57

`Static`hasFlag

hasFlag(flag: string): boolean
Parameters
- flag: string
Returns boolean
- Defined in types/generated/api.d.ts:88

`Static`isNewerThan

isNewerThan(version: string): boolean
Parameters
- version: string
Returns boolean
- Defined in types/generated/api.d.ts:54

`Static`isOlderThan

isOlderThan(version: string): boolean
Parameters
- version: string
Returns boolean
- Defined in types/generated/api.d.ts:55

`Static`notification

notification(title: string, text: string, icon?: string): void
Parameters
- title: string
- text: string
- Optionalicon: string
Returns void
- Defined in types/generated/api.d.ts:84

`Static`on

on<T extends keyof BlockbenchEventMap, D extends any>(
event_name: T,
cb: (data: D) => any,
): Deletable
Type Parameters
- T extends keyof BlockbenchEventMap
- D extends any
Parameters
- event_name: T
- cb: (data: D) => any
Returns Deletable
- Defined in types/generated/api.d.ts:90

`Static`once

once<T extends keyof BlockbenchEventMap, D extends any>(
event_name: T,
cb: (data: D) => any,
): Deletable
Type Parameters
- T extends keyof BlockbenchEventMap
- D extends any
Parameters
- event_name: T
- cb: (data: D) => any
Returns Deletable
- Defined in types/generated/api.d.ts:91

`Static`onUpdateTo

onUpdateTo(version: any, callback: any): void
Parameters
- version: any
- callback: any
Returns void
- Defined in types/generated/api.d.ts:94

`Static`openLink

openLink(link: string): void
Parameters
- link: string
Returns void
- Defined in types/generated/api.d.ts:83

`Static`registerEdit

registerEdit(): void
Returns void
- Defined in types/generated/api.d.ts:56

`Static`reload

reload(): void
Returns void
- Defined in types/generated/api.d.ts:53

`Static`removeFlag

removeFlag(flag: string): void
Parameters
- flag: string
Returns void
- Defined in types/generated/api.d.ts:87

`Static`removeListener

removeListener<T extends keyof BlockbenchEventMap, D extends any>(
event_name: T,
cb: (data: D) => any,
): void
Type Parameters
- T extends keyof BlockbenchEventMap
- D extends any
Parameters
- event_name: T
- cb: (data: D) => any
Returns void
- Defined in types/generated/api.d.ts:93

`Static`removeMenuEntry

removeMenuEntry(name: string): void
Parameters
- name: string
Returns void
- Defined in types/generated/api.d.ts:82

`Static`setCursorTooltip

setCursorTooltip(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in types/generated/api.d.ts:60

`Static`setProgress

setProgress(progress: number, time?: number, bar?: string): void
Parameters
- progress: number
- Optionaltime: number
- Optionalbar: string
Returns void
- Defined in types/generated/api.d.ts:61

`Static`setStatusBarText

setStatusBarText(text?: string): void
Parameters
- Optionaltext: string
Returns void
- Defined in types/generated/api.d.ts:63

`Static`showMessage

showMessage(message: any, location: any): void
Parameters
- message: any
- location: any
Returns void
- Defined in types/generated/api.d.ts:64

`Static`showMessageBox

showMessageBox(
    options: MessageBoxOptions,
    cb?: (
        button: string | number,
        result?: Record<string, boolean>,
        event?: Event,
    ) => void,
): MessageBox
Parameters
- options: MessageBoxOptions
- Optionalcb: (
      button: string | number,
      result?: Record<string, boolean>,
      event?: Event,
  ) => void
Returns MessageBox
- Defined in types/generated/api.d.ts:65

`Static`showQuickMessage

showQuickMessage(message: any, time?: number): void
Parameters
- message: any
- Optionaltime: number
Returns void
- Defined in types/generated/api.d.ts:58

`Static`showStatusMessage

showStatusMessage(message: string, time?: number): void
Parameters
- message: string
- Optionaltime: number
Returns void
- Defined in types/generated/api.d.ts:62

`Static`showToastNotification

showToastNotification(options: ToastNotificationOptions): any
Parameters
- options: ToastNotificationOptions
Returns any
- Defined in types/generated/api.d.ts:59

`Static`textPrompt

textPrompt(
    title: string,
    value: string,
    callback: (text: string) => void,
    options?: { description?: string; info?: string; placeholder?: string },
): Promise<unknown>
Parameters
- title: string
- value: string
- callback: (text: string) => void
- Optionaloptions: { description?: string; info?: string; placeholder?: string }
  Options
  - Optionaldescription?: string
    Description for the text input
  - Optionalinfo?: string
    Info text
  - Optionalplaceholder?: string
Returns Promise<unknown>
Input value
- Defined in types/generated/api.d.ts:76

Class Blockbench

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Blockbench

Properties

StaticAction

StaticaddDragHandler

StaticAnimation

StaticAnimationController

StaticAnimationControllerState

StaticAnimationItem

StaticAnimator

Staticargv

StaticBarItem

StaticBarItems

StaticBarMenu

StaticBarSelect

StaticBarSlider

StaticBarText

StaticBillboardFace

StaticBoneAnimator

StaticCodec

StaticColorPicker

StaticCube

StaticCubeFace

StaticDialog

StaticDisplaySlot

Staticdrag_handlers

StaticEffectAnimator

Staticevents

Staticexport

StaticexportFile

StaticFace

StaticfindFileFromContent

Staticflags

StaticFormat

StaticGroup

Staticimport

StaticimportFile

StaticInputForm

StaticisLandscape

StaticisMobile

StaticisTouch

StaticisWeb

StaticKeybind

StaticKeybindItem

StaticKeyframe

StaticKeyframeDataPoint

StaticLanguage

Type Declaration

code: string

data: {}

options: { cz: string; de: string; en: string; es: string; fr: string; it: string; ja: string; ko: string; nl: string; pl: string; pt: string; pt_br: string; ru: string; sv: string; tr: string; uk: string; vi: string; zh: string; zh_tw: string;}

toString: () => string

addTranslations: function

Parameters

Returns void

StaticLocator

StaticMenu

StaticMesh

StaticMeshFace

StaticMode

StaticModelFormat

StaticModelLoader

StaticModelProject

StaticNodePreviewController

StaticNullObject

StaticNullObjectAnimator

StaticNumSlider

StaticopenTime

Staticoperating_system

StaticOutliner

StaticOutlinerElement

StaticOutlinerNode

StaticPainter

`Static`Action

`Static`addDragHandler

`Static`Animation

`Static`AnimationController

`Static`AnimationControllerState

`Static`AnimationItem

`Static`Animator

`Static`argv

`Static`BarItem

`Static`BarItems

`Static`BarMenu

`Static`BarSelect

`Static`BarSlider

`Static`BarText

`Static`BillboardFace

`Static`BoneAnimator

`Static`Codec

`Static`ColorPicker

`Static`Cube

`Static`CubeFace

`Static`Dialog

`Static`DisplaySlot

`Static`drag_handlers

`Static`EffectAnimator

`Static`events

`Static`export

`Static`exportFile

`Static`Face

`Static`findFileFromContent

`Static`flags

`Static`Format

`Static`Group

`Static`import

`Static`importFile

`Static`InputForm

`Static`isLandscape

`Static`isMobile

`Static`isTouch

`Static`isWeb

`Static`Keybind

`Static`KeybindItem

`Static`Keyframe

`Static`KeyframeDataPoint

`Static`Language

options: {
cz: string;
de: string;
en: string;
es: string;
fr: string;
it: string;
ja: string;
ko: string;
nl: string;
pl: string;
pt: string;
pt_br: string;
ru: string;
sv: string;
tr: string;
uk: string;
vi: string;
zh: string;
zh_tw: string;
}

`Static`Locator

`Static`Menu

`Static`Mesh

`Static`MeshFace

`Static`Mode

`Static`ModelFormat

`Static`ModelLoader

`Static`ModelProject

`Static`NodePreviewController

`Static`NullObject

`Static`NullObjectAnimator

`Static`NumSlider

`Static`openTime

`Static`operating_system

`Static`Outliner

`Static`OutlinerElement

`Static`OutlinerNode

`Static`Painter

`Static`Panel

`Static`pickDirectory

`Static`platform

`Static`Plugin

`Static`Preview

`Static`Project

`Static`read

`Static`readFile

`Static`removeDragHandler

`Static`ResizeLine

`Static`Reusable

`Static`Screencam

`Static`Setting

`Static`Settings

`Static`setup_successful

`Static`ShapelessDialog

`Static`SharedActions