@wonderlandengine/editor-api
Version:
Wonderland Engine's Editor API for plugins - very experimental.
50 lines (49 loc) • 1.24 kB
TypeScript
export * from './data.js';
export * from './editor-state.js';
export * as ui from './ui.js';
export * as tools from './tools.js';
export * from './workspace.js';
/** Editor plugin */
export declare class EditorPlugin {
/** Name of the plugin */
name: string;
/**
* Called periodically to update the plugin before {@link #draw()}.
*/
update?(): void;
/**
* Called to let the plugin draw it's ui. See {@link ui}.
*/
draw?(): void;
/**
* Called when the plugin is deactivated or reloaded.
*
* Plugins get deactivated when the editor is closed
* or projects are switched.
*/
unload?(): void;
/**
* Called before a project is saved
*
* @returns `false` to indicate failure to save.
*/
preProjectSave?(): boolean;
/**
* Called after a project is loaded
*
* @returns `false` to indicate failure to load.
*/
postProjectLoad?: boolean;
/**
* Called before a project is packaged
*
* @returns `false` to abort packaging.
*/
prePackage?(): boolean;
/**
* Called after a project is packaged
*
* @returns `false` to abort packaging.
*/
postPackage?(): boolean;
}