Engine
Defined in: Engine.ts:50
The top-level entry point. Owns the plugin registry, game loop, scene manager, and DI container.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Engine(
config?):Engine
Defined in: Engine.ts:75
Parameters
Section titled “Parameters”config?
Section titled “config?”Returns
Section titled “Returns”Engine
Properties
Section titled “Properties”assets
Section titled “assets”
readonlyassets:AssetManager
Defined in: Engine.ts:68
The asset manager.
context
Section titled “context”
readonlycontext:EngineContext
Defined in: Engine.ts:52
The dependency injection container.
events
Section titled “events”
readonlyevents:EventBus<EngineEvents>
Defined in: Engine.ts:56
The event bus.
inspector
Section titled “inspector”
readonlyinspector:Inspector
Defined in: Engine.ts:62
The inspector (debug queries).
logger
Section titled “logger”
readonlylogger:Logger
Defined in: Engine.ts:60
The logger.
readonlyloop:GameLoop
Defined in: Engine.ts:58
The game loop.
scenes
Section titled “scenes”
readonlyscenes:SceneManager
Defined in: Engine.ts:54
The scene manager.
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: Engine.ts:187
Stop the engine. Destroys all scenes, plugins, and the game loop.
Returns
Section titled “Returns”void
start()
Section titled “start()”start():
Promise<void>
Defined in: Engine.ts:141
Start the engine. Installs plugins in topological order, starts the game loop.
Returns
Section titled “Returns”Promise<void>
use(
plugin):this
Defined in: Engine.ts:129
Register a plugin. Must be called before start().
Parameters
Section titled “Parameters”plugin
Section titled “plugin”Returns
Section titled “Returns”this