API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

classAnimationSystem

@codexo/exojs / animation / stable

Owns and advances the AnimatedSprites whose frame playback is currently running, driving them once per frame from Application.update - the SystemMethods.preFrame phase, at SystemOrder.CoreAnimation. Registration is automatic and requires no user wiring: an AnimatedSprite registers itself here as soon as it is both *playing* and *attached* to a scene tree owned by an Application, and deregisters on `stop()`/`pause()`, on clip completion, on detach from the tree, and on `destroy()`. A sprite that is never attached to a tree (e.g. one drawn immediate-mode via `context.render(sprite)`) is never registered, and must be ticked by hand with AnimatedSprite.update - which stays public exactly for that case. Update iteration uses a snapshot so `onFrame`/`onComplete` handlers may freely play, stop, add or destroy sprites during the same frame without corrupting the loop.

props

methods

events

Import

import { AnimationSystem } from '@codexo/exojs'

Owns and advances the AnimatedSprites whose frame playback is currently running, driving them once per frame from Application.update - the SystemMethods.preFrame phase, at SystemOrder.CoreAnimation.

Registration is automatic and requires no user wiring: an AnimatedSprite registers itself here as soon as it is both *playing* and *attached* to a scene tree owned by an Application, and deregisters on `stop()`/`pause()`, on clip completion, on detach from the tree, and on `destroy()`. A sprite that is never attached to a tree (e.g. one drawn immediate-mode via `context.render(sprite)`) is never registered, and must be ticked by hand with AnimatedSprite.update - which stays public exactly for that case.

Update iteration uses a snapshot so `onFrame`/`onComplete` handlers may freely play, stop, add or destroy sprites during the same frame without corrupting the loop.

Constructors1

new(): AnimationSystem

Methods6

add(sprite: AnimatedSpriteA Sprite that advances through a sequence of texture-frame Rectangles over time to produce frame-based animation. Multiple named clips can be registered via ad…): this

Register sprite so it is advanced once per frame. Idempotent, and a no-op for a destroyed sprite or a destroyed system. Called automatically by AnimatedSprite; there is no need to call it by hand.

clear(): this

Deregister every sprite immediately. Playback state is left as-is - the sprites are simply no longer advanced by this system.

destroy(): void

Tear down the system. Deregisters every sprite and makes subsequent updates no-ops.

has(sprite: AnimatedSpriteA Sprite that advances through a sequence of texture-frame Rectangles over time to produce frame-based animation. Multiple named clips can be registered via ad…): boolean

Whether sprite is currently registered for per-frame advancement.

preFrame(delta: SecondsA length of time in seconds. The unit every duration in the public API is expressed in - frame deltas, the fixed step, elapsed totals, timer limits. It is a `n…): void

Advance every registered sprite by the frame delta, converted to seconds at this single point of use. Sprites destroyed since the last frame are evicted rather than ticked, so a destroyed node can never be driven after teardown. Iterates a snapshot so playback callbacks that register or deregister sprites do not corrupt the loop.

remove(sprite: AnimatedSpriteA Sprite that advances through a sequence of texture-frame Rectangles over time to produce frame-based animation. Multiple named clips can be registered via ad…): this

Remove sprite from the system. Called automatically on stop/pause/complete/detach/destroy.

Properties1

size: number

Number of sprites currently registered for per-frame advancement.

Source

src/animation/AnimationSystem.ts