typescript/ecs

About

Entity Component System engine (for games or other things).

Import

In deno:

import { Engine } from "https://js.thunderk.net/ecs/mod.ts";

In browser:

<script type="module">
import { Engine } from "https://js.thunderk.net/ecs/mod.js";
</script>

Use

Basic example

import { Component, Engine, System } from "./mod.ts";

// Create an engine
const engine = new Engine();

// Prepare some component state typing
type ComponentState = { x: number; y: number };

// Add a system to the engine
class ExampleSystem extends System {
  component: Component<ComponentState>;

  constructor(engine: Engine) {
    super(engine);

    // The system declares a component to be used
    // Parameter is the default state
    this.component = engine.createComponent({ x: 0, y: 0 });
  }
}
const system = engine.createSystem({ ExampleSystem });

// Create an entity
const entity = engine.createEntity();

// Attach the component to the entity
engine.attachComponent(entity, system.component);

// Read the component state
console.log(engine.readState(entity, system.component));
// => {x: 0, y: 0}

// Change the component state (partially)
engine.writeState(entity, system.component, { x: 1 });
console.log(engine.readState(entity, system.component));
// => {x: 1, y: 0}

// Remove the component
engine.detachComponent(entity, system.component);
console.log(engine.readState(entity, system.component));
// => undefined