API reference

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

C

classTween

@codexo/exojs / animation / stable

Animates numeric properties of `target` from their current value to a configured end value over a duration in seconds. Supports easing, delay, repeat (with optional yoyo), chaining, and lifecycle callbacks (Tween.onStart, Tween.onUpdate, Tween.onComplete, Tween.onRepeat). Tweens are typically created via TweenManager.create, which attaches them to the manager so they advance once per frame. Stand-alone usage is supported by calling Tween.update manually with a frame delta. Start values are captured lazily on the first update after Tween.start, so target properties may be mutated between configuration and start without affecting the captured baseline. Only number-typed properties on `target` are interpolated; non-number properties listed in Tween.to emit a console warning and are skipped.

3
props
15
methods
0
events
Import
import { Tween } from '@codexo/exojs'

Animates numeric properties of `target` from their current value to a configured end value over a duration in seconds. Supports easing, delay, repeat (with optional yoyo), chaining, and lifecycle callbacks (Tween.onStart, Tween.onUpdate, Tween.onComplete, Tween.onRepeat).

Tweens are typically created via TweenManager.create, which attaches them to the manager so they advance once per frame. Stand-alone usage is supported by calling Tween.update manually with a frame delta.

Start values are captured lazily on the first update after Tween.start, so target properties may be mutated between configuration and start without affecting the captured baseline.

Only number-typed properties on `target` are interpolated; non-number properties listed in Tween.to emit a console warning and are skipped.

Constructors 1
new(target: T): Tween<T>
Methods 15
chain(next: Tween): Tween
delay(seconds: number): this
easing(easingFunction: EasingFunction): this
onComplete(callback: TweenLifecycleCallback): this
onRepeat(callback: TweenLifecycleCallback): this
onStart(callback: TweenLifecycleCallback): this
onUpdate(callback: TweenUpdateCallback): this
pause(): this
repeat(count: number): this
resume(): this
start(): this
stop(): this
to(properties: Partial<Record<NumericKeys<T>, number>>, duration: number): this
update(deltaSeconds: number): void
yoyo(enabled: boolean): this
Properties 3
progress: number
state: TweenState
target: T
Source