Class default

constructor

• new default(callbacks: EngineCallbacks, opts?: Partial<EngineOpts>): default

  initialises a new instance of the Engine.

  Parameters

  • callbacks: EngineCallbacks

    Lifecycle and update callbacks.

  • opts: Partial<EngineOpts> = {}

    Configuration options for the engine.

  Returns default

backgroundColour

callbacks

fps

frameTime

height

width

cursor

• set cursor(value: string): void

  Sets the CSS cursor style for the game canvas.

  Parameters

  • value: string

    The CSS cursor value (e.g., 'pointer', 'crosshair').

  Returns void

mouseX

• get mouseX(): number

  Current mouse x position in world space.

  Returns number

mouseY

• get mouseY(): number

  Current mouse y position in world space.

  Returns number

Staticcamera

• get camera(): default

  The global camera instance.

  Returns default

StaticcurrentScene

• get currentScene(): default | null

  Gets the currently active scene.

  Returns default | null

• set currentScene(scene: default | null): void

  Sets the active scene, resetting the camera and calling the scene's onLoad.

  Parameters

  • scene: default | null

  Returns void

Staticdebug

• get debug(): boolean

  Toggle for visual debug mode (hitboxes and stats).

  Returns boolean

• set debug(val: boolean): void

  Parameters

  • val: boolean

  Returns void

StaticdebugCollisions

• get debugCollisions(): { manifold: CollisionManifold; timestamp: number }[]

  Recent collisions for debug visualization.

  Returns { manifold: CollisionManifold; timestamp: number }[]

• set debugCollisions(
      val: { manifold: CollisionManifold; timestamp: number }[],
  ): void

  Parameters

  • val: { manifold: CollisionManifold; timestamp: number }[]

  Returns void

Staticobjects

• get objects(): ObjectSet

  Global set of game objects if no scene is active.

  Returns ObjectSet

Staticpaused

• get paused(): boolean

  Whether the game loop is currently paused.

  Returns boolean

• set paused(val: boolean): void

  Parameters

  • val: boolean

  Returns void

StaticrenderingSystem

• get renderingSystem(): default | undefined

  The global rendering system.

  Returns default | undefined

• set renderingSystem(val: default | undefined): void

  Parameters

  • val: default | undefined

  Returns void

StaticselectedObject

• get selectedObject(): default | null

  The currently selected object in debug mode.

  Returns default | null

• set selectedObject(val: default | null): void

  Parameters

  • val: default | null

  Returns void

StaticshowCollisionLines

• get showCollisionLines(): boolean

  Whether to show collision normals/contact points in debug mode.

  Returns boolean

• set showCollisionLines(val: boolean): void

  Parameters

  • val: boolean

  Returns void

StaticshowPhysicsVectors

• get showPhysicsVectors(): boolean

  Whether to show velocity/acceleration vectors in debug mode.

  Returns boolean

• set showPhysicsVectors(val: boolean): void

  Parameters

  • val: boolean

  Returns void

StaticsortedObjects

• get sortedObjects(): default[]

  The cached list of globally registered game objects, sorted by z-index.

  Returns default[]

• set sortedObjects(val: default[]): void

  Parameters

  • val: default[]

  Returns void

StatictotalTime

• get totalTime(): number

  Returns the total active time of the game (excluding pause time).

  Returns number

StaticzOrderDirty

• get zOrderDirty(): boolean

  Whether the global object list needs to be re-sorted by z-index.

  Returns boolean

• set zOrderDirty(val: boolean): void

  Parameters

  • val: boolean

  Returns void

countdown

• countdown(milliseconds: number, fn: () => void, onEnded: () => void): void

  Starts a countdown timer that runs a function every second and an ending function.

  Parameters

  • milliseconds: number

    The total duration of the countdown.

  • fn: () => void

    The function to run every second.

  • onEnded: () => void

    The function to run when the countdown is finished.

  Returns void

setTimeout

• setTimeout(callback: () => void, delay: number): number

  Schedules a function to run after a delay.

  Parameters

  • callback: () => void

    The function to run.

  • delay: number

    The delay in milliseconds.

  Returns number

  A timer ID.

terminate

• terminate(): void

  Completely stops the engine and cleans up all resources.

  Returns void

StaticcleanDebugCollisions

• cleanDebugCollisions(now?: number): void

  Cleans up expired debug collisions.

  Parameters

  • now: number = ...

    Current timestamp.

  Returns void

StaticdestroyAll

• destroyAll(): void

  Destroy all objects in the active scene or global engine.

  Returns void

StaticdestroyObject

• destroyObject(object: default): void

  Removes a game object from the active scene or global engine loop.

  Parameters

  • object: default

    The object to destroy.

  Returns void

Staticemit

• emit(type: string, detail?: unknown): void

  Emits a custom event on the global engine bus.

  Parameters

  • type: string

    The event type.

  • Optionaldetail: unknown

    Optional data to pass with the event.

  Returns void

Staticoff

• off(type: string, callback: (event: CustomEvent) => void): void

  Stops listening for an event on the global engine bus.

  Parameters

  • type: string

    The event type.

  • callback: (event: CustomEvent) => void

    The function to remove.

  Returns void

Staticon

• on(type: string, callback: (event: CustomEvent) => void): void

  Listens for an event on the global engine bus.

  Parameters

  • type: string

    The event type (e.g., 'paused', 'PLAYER_DIED').

  • callback: (event: CustomEvent) => void

    The function to run when the event occurs.

  Returns void

StaticregisterObject

• registerObject(object: default): void

  Registers a game object with the active scene or global engine loop.

  Parameters

  • object: default

    The object to register.

  Returns void

StaticresetState

• resetState(): void

  Resets the engine state to its initial values. Useful for testing to prevent state bleed between test cases.

  Returns void