Reference

gamekit 0.1.0-rc1. The family pages below list every public class, interface, enum and function with its signature and documentation, generated from the gamekit source.

Import paths

Import from	Gives you
"gamekit"	The package root: core, ecs, app, save and audio, plus DebugTools, DebugScenario and DebugTrace from testing.
"gamekit/src/willow"	Presentation bindings and the willow input bridge.
"gamekit/src/ui"	SceneWindowLayer.
"gamekit/src/testing"	Clocks, schedulers and the debug tools.
"gamekit/src/save"	Everything in save, including FsByteStorage, which the root leaves out.

Families

Family	Contents
core	Entities, keys, events and pipelines, attributes and state machines, effects, definitions and prefabs, conditions, actions and interactions, assets, spatial types, Gauge, WeightedPick, errors.
ecs	World, stores, Query, Query2, PhaseSchedule, WorldTicker, createConventionalSchedule.
app	AppScene, SceneStack, SceneCoordinator, ScreenLayers, focus, and input actions, routing and replay.
save	Codecs, schemas, migrations, storage, slots, settings.
audio	MusicDirector, IMusicBackend.
willow	WillowPresentationAdapter, bindings and tickets, WillowInputBridge and its samples and viewport.
ui	SceneWindowLayer.
testing	SimulationClock, PresentationClock, ClockScheduler, DebugTools, DebugScenario, DebugTrace.

Errors

All gamekit errors extend GameKitError:

Error	Thrown when
StaleHandle	An asset handle is used after its scope was disposed.
DuplicateRegistration	Something is registered twice under one id.
MissingRegistration	A lookup names something that was never registered.
CyclicDefinition	Definition inheritance loops.
InvalidDefinition	A definition validator failed.
CyclicDependency	An asset plan's dependencies loop.
InvalidArgument	An argument is out of range, such as a gauge with zero capacity.

Requirements

gamekit needs a thicket compiler built from thicketscript main commit 9dde0bd0 or later (it uses export *, folder index imports and static const class members). Its manifest declares compiler: ">=0.1.13-9dde0bd0". Projects list the willow and bitmap systems; the save family's FsByteStorage also needs fs.