dacha API reference
A data-driven TypeScript game engine for the browser.
Documentation · Get started · GitHub
This reference lists every class, function and type that the dacha package exports.
It is the companion to the documentation. The documentation explains how the engine works and how to build a game with it. This reference answers the narrower questions: what a method takes, what a property holds, what a type contains.
Import paths
The package has four import paths. This reference shows all of them in one tree.
| Import path | What it contains |
|---|---|
dacha |
The engine, actors, systems, components, assets and math |
dacha/events |
Event names and event types |
dacha/renderer |
Types for the renderer: shaders, filter effects, sorting |
dacha/physics |
Types for physics: system options, layers and query params |
dacha/renderer and dacha/physics contain types only. Import them with import type.
Sections
The sidebar groups the API the same way the documentation does. Each section below links to the documentation page that explains it.
| Section | Documentation |
|---|---|
| Engine | Configuration, Game loop |
| Actors & Components | ECS, Actors |
| Scenes & World | Scenes and world |
| Events | Events |
| Systems | Systems |
| Math | — |
| Assets | Configuration |
| Behaviors | Behaviors |
| Rendering | Rendering |
| Physics | Physics |
| Character Controller | Character controller |
| Interpolation | Interpolation |
| Animation | Animation |
| Audio | Audio |
| Input | Input |
| Camera | Camera |
| Game UI | Game UI |
| Game Stats | Performance |
A section for a built-in system holds everything that belongs to it. That is the system, its API, its components, their config types and the events it sends.