editorAPI reference

Find the API area you need

The entry point is window.editorAPI. Each article describes signatures, default values, return values, and effects on the editor. Dependencies on internals through window.editor are identified separately.

Some interfaces, including editorAPI.headPaint, become available after the GUI is created. See Events and lifecycle for the plugin startup sequence and the bde:started event.

API groups

Windows, buttons, and menusRegular and modal windows, iframes, the dock, toolbars, and file menus.

Objects and selectionCreate, find, and delete objects, update the interface, and understand undo history effects.

Projects, lists, and geometrymergeContent, exportToJSON, block and item lists, and mesh snapshots.

HeadPaint APIColor, opacity, the palette, and registering a custom tool and its handler.

Environment APIeditorAPI.sky: activation, time, moon phase, gamma, render distance, and state.

Events and lifecycleEditor readiness, project and mode events, animation, and cleanup.

TranslationsregisterTranslations, plugin keys, gT, language fallback, and your own DOM.

Custom objects and global dependenciesTHREE, Selectable, transforms, adding geometry, and export boundaries.