TypeScript API

BornEngine applications start with one Game instance. The Game owns the native runtime and exposes services for rendering, input, audio, scenes, UI, mobile controls, and networking. Stateful resources receive that Game in their constructor and keep native identity private.

import { Colors, Game } from '@bornengine/engine';

class FieldTest extends Game {
  constructor() {
    super({ window: { title: 'Field test', width: 1280, height: 720 } });
  }

  protected override loop(deltaTime: number): void {
    this.scenes.update(deltaTime);
  }

  protected override render(): void {
    this.renderer.clear(Colors.SKYBLUE);
    super.render();
  }
}

new FieldTest().run();

Import from the root or a subpath

The package root is convenient for game code. Import from a subpath when you want the module boundary to be visible in a library or feature package:

import { Game } from '@bornengine/engine/core';
import { PhysicsWorld, SphereCollider } from '@bornengine/engine/physics';

const game = new Game();
const physics = new PhysicsWorld(game);
const ballShape = new SphereCollider(physics, 0.5);

Both paths expose the same supported classes and types. Internal FFI functions and numeric resource handles are not package exports.

Module map

Lifetime and failures

The current native runtime is process-global, so one Game may be active at a time. Check game.isReady and game.error after construction. Check isLoaded and error on resources that can fail to load. Call dispose() when an individual resource leaves gameplay; game.dispose() releases resources still owned by that game.