Animation, Scenes, State, Tilemaps, and ECS Exact Reference

Use this page when the task is in gameplay helpers, authored scene flow, tilemaps, ECS, or deterministic runtime state transitions.

Table of Contents

1. Covers
2. Open These Handbook Pages First
3. Canonical Contracts
4. Namespace Coverage Summary
5. Namespaces

Covers

• aura.animation
• aura.anim2d
• aura.tween
• aura.particles
• aura.tilemap
• aura.timer
• aura.collision
• aura.debug
• aura.scene
• aura.ecs

Open These Handbook Pages First

• external/game-dev-api/05-animation-tween-particles-and-tilemaps.md
• external/game-dev-api/06-math-colors-vectors-timers-collision-and-ecs.md
• external/game-dev-api/07-scenes-state-debug-and-test-harness.md

Canonical Contracts

• api-contract.md

Namespace Coverage Summary

Namespaces

`aura.animation`

Additive deterministic timeline helper (create, play, pause, resume, seek, transition, onComplete, onEvent, setLoop, setSpeed, update, getState) plus constrained atlas/spritesheet helpers (registerAtlas, resolveAtlasFrame, createAtlasClip, stepAtlasClip, getAtlasClipState) with reason-coded invalid-operation responses.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 0
• Additional known method names: 18
• Contract source: api-contract.md

Known Contract Methods

aura.animation.create(...)
aura.animation.createAtlasClip(...)
aura.animation.crossfade(...)
aura.animation.getAtlasClipState(...)
aura.animation.getState(...)
aura.animation.onComplete(...)
aura.animation.onEvent(...)
aura.animation.pause(...)
aura.animation.play(...)
aura.animation.registerAtlas(...)
aura.animation.resolveAtlasFrame(...)
aura.animation.resume(...)
aura.animation.seek(...)
aura.animation.setLoop(...)
aura.animation.setSpeed(...)
aura.animation.stepAtlasClip(...)
aura.animation.transition(...)
aura.animation.update(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.anim2d`

Additive 2D animation state-machine helper (clip registration, deterministic transitions, completion callbacks).

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 0
• Additional known method names: 7
• Contract source: api-contract.md

Known Contract Methods

aura.anim2d.createMachine(...)
aura.anim2d.defineState(...)
aura.anim2d.getState(...)
aura.anim2d.onComplete(...)
aura.anim2d.play(...)
aura.anim2d.registerClip(...)
aura.anim2d.update(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.tween`

Additive deterministic tween/easing helper (create, pause, resume, cancel, onUpdate, onComplete, update, getState) with reason-coded invalid-operation responses.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 0
• Additional known method names: 8
• Contract source: api-contract.md

Known Contract Methods

aura.tween.cancel(...)
aura.tween.create(...)
aura.tween.getState(...)
aura.tween.onComplete(...)
aura.tween.onUpdate(...)
aura.tween.pause(...)
aura.tween.resume(...)
aura.tween.update(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.particles`

Additive deterministic particles-lite helper (emit, update, draw, stop, getState) with deterministic emitter IDs, constrained pool behavior, and reason-coded invalid-operation responses.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 0
• Additional known method names: 10
• Contract source: api-contract.md

Known Contract Methods

aura.particles.burst(...)
aura.particles.draw(...)
aura.particles.emit(...)
aura.particles.getState(...)
aura.particles.kill(...)
aura.particles.setBlend(...)
aura.particles.setGravity(...)
aura.particles.setLayer(...)
aura.particles.stop(...)
aura.particles.update(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.tilemap`

Additive tilemap helper for constrained Tiled JSON import plus deterministic layer draw/culling in draw2d.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 10
• Additional known method names: 11
• Contract source: api-contract.md

Exact Signatures

aura.tilemap.queryAABB(modelOrMapId, {x, y, w, h})
aura.tilemap.queryObjects(mapId, options?)
aura.tilemap.queryObjectsAtPoint(mapId, point, options?)
aura.tilemap.queryObjectsInAABB(mapId, aabb, options?)
aura.tilemap.queryPoint(modelOrMapId, {x, y})
aura.tilemap.queryRay(modelOrMapId, {x, y, dx, dy, maxDistance?})
aura.tilemap.queryRaycast(...)
aura.tilemap.setRegion(...)
aura.tilemap.setTile(...)
aura.tilemap.setTileCollision(...)

Additional Known Method Names

aura.tilemap.create(...)
aura.tilemap.draw(...)
aura.tilemap.drawLayer(...)
aura.tilemap.getInfo(...)
aura.tilemap.import(...)
aura.tilemap.removeRegion(...)
aura.tilemap.replaceRegion(...)
aura.tilemap.setLayerCollision(...)
aura.tilemap.setLayerFlags(...)
aura.tilemap.setLayerVisibility(...)
aura.tilemap.unload(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.timer`

Schedule deferred and repeating callbacks; query elapsed time.

• Native support: supported
• Web support: supported
• Exact signatures in generated schema: 5
• Additional known method names: 0
• Contract source: api-contract.md

Exact Signatures

aura.timer.after(seconds: number, callback: function): number
aura.timer.cancel(handle: number): void
aura.timer.every(seconds: number, callback: function): number
aura.timer.getDelta(): number
aura.timer.getTime(): number

`aura.collision`

Axis-aligned 2D collision detection (rect-rect, circle-circle, mixed).

• Native support: supported
• Web support: supported
• Exact signatures in generated schema: 5
• Additional known method names: 5
• Contract source: api-contract.md

Exact Signatures

aura.collision.circleCircle(a: Circle, b: Circle): boolean
aura.collision.circlePoint(circle: Circle, point: Point): boolean
aura.collision.circleRect(circle: Circle, rect: Rect): boolean
aura.collision.rectPoint(rect: Rect, point: Point): boolean
aura.collision.rectRect(a: Rect, b: Rect): boolean

Additional Known Method Names

aura.collision.circleCircleBatch(...)
aura.collision.circlePointBatch(...)
aura.collision.circleRectBatch(...)
aura.collision.rectPointBatch(...)
aura.collision.rectRectBatch(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.debug`

Dev-only terminal/overlay helpers (log, drawRect, drawCircle, drawText) plus runtime inspector controls (enableInspector, inspectorStats). Explicit no-op in release mode.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 1
• Additional known method names: 9
• Contract source: api-contract.md

Exact Signatures

aura.debug.inspectorStats()

Additional Known Method Names

aura.debug.cacheStats(...)
aura.debug.drawCircle(...)
aura.debug.drawRect(...)
aura.debug.drawText(...)
aura.debug.enableInspector(...)
aura.debug.log(...)
aura.debug.resetCaches(...)
aura.debug.showPhysics3dColliders(...)
aura.debug.showScene3dWireframe(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.scene`

Additive scene lifecycle/state helper for deterministic create/start/pause/resume/update transitions and reason-coded status payloads.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 0
• Additional known method names: 11
• Contract source: api-contract.md

Known Contract Methods

aura.scene.cancelEvent(...)
aura.scene.define(...)
aura.scene.getEventState(...)
aura.scene.getState(...)
aura.scene.pauseEvent(...)
aura.scene.register(...)
aura.scene.resumeEvent(...)
aura.scene.schedule(...)
aura.scene.start(...)
aura.scene.switchTo(...)
aura.scene.update(...)

Exact signature extraction is still incomplete for the methods above. Use the canonical contract source if argument or return-value detail matters.

`aura.ecs`

No generated description is available yet for this namespace.

• Native support: supported
• Web support: see_web_build_contract_v1
• Exact signatures in generated schema: 6
• Additional known method names: 0
• Contract source: api-contract.md

Exact Signatures

aura.ecs.addComponent(entityId: number, componentName: string, value: unknown): boolean
aura.ecs.createEntity(): number
aura.ecs.getComponent(entityId: number, componentName: string): unknown | undefined
aura.ecs.removeEntity(entityId: number): boolean
aura.ecs.run(dt: number): void
aura.ecs.system(name: string, fn: (dt: number) => void, order?: number): boolean