TrailAPI
Defined in: trail/TrailAPI.ts:15
Per-app motion-trail API. Wraps the C++ registry-scoped trail system so two App instances (e.g. editor tabs) drive independent trails without cross-talk.
Consumed as a resource: declare Res(Trail) as a system param, or grab it with
app.getResource(Trail) outside ECS code.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TrailAPI(
module,registry):TrailAPI
Defined in: trail/TrailAPI.ts:20
Parameters
Section titled “Parameters”module
Section titled “module”NonNullable<EngineApi>
whichever engine core is present (see ecs/engineApi.ts).
registry
Section titled “registry”Returns
Section titled “Returns”TrailAPI
Methods
Section titled “Methods”clear()
Section titled “clear()”clear(
entity):void
Defined in: trail/TrailAPI.ts:31
Drop an entity’s recorded history (the streak vanishes instantly).
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
dt):void
Defined in: trail/TrailAPI.ts:26
Advance every trail: record points for moving emitters, age out old ones.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void