Plugin
Defined in: types.ts:21
Plugin interface for extending the engine.
Properties
Section titled “Properties”dependencies?
Section titled “dependencies?”
readonlyoptionaldependencies?: readonlystring[]
Defined in: types.ts:27
Names of plugins this plugin depends on.
readonlyname:string
Defined in: types.ts:23
Unique plugin name.
version
Section titled “version”
readonlyversion:string
Defined in: types.ts:25
Semantic version string.
Methods
Section titled “Methods”install()?
Section titled “install()?”
optionalinstall(context):void|Promise<void>
Defined in: types.ts:29
Install services into the engine context. Called in topological order.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”void | Promise<void>
onDestroy()?
Section titled “onDestroy()?”
optionalonDestroy():void
Defined in: types.ts:35
Called when the engine is destroyed.
Returns
Section titled “Returns”void
onStart()?
Section titled “onStart()?”
optionalonStart():void|Promise<void>
Defined in: types.ts:33
Called after all plugins are installed and the engine has started.
Returns
Section titled “Returns”void | Promise<void>
registerSystems()?
Section titled “registerSystems()?”
optionalregisterSystems(scheduler):void
Defined in: types.ts:31
Register systems with the scheduler. Called after install.
Parameters
Section titled “Parameters”scheduler
Section titled “scheduler”Returns
Section titled “Returns”void