Class Tween<T>

A generic tweening class that animates numeric properties of an object over time using PixiJS's Ticker.

Type Parameters

T

Index

Constructors

Accessors

delay duration isComplete target transition

Methods

animate onComplete play setDelay setDuration setTarget setTransition stop

Constructors

constructor

new Tween<T>(config?: Partial<TweenConfig<T>>): Tween<T>
Creates a new Tween instance with optional configuration.
Type Parameters
- T
Parameters
- Optionalconfig: Partial<TweenConfig<T>>
  The tween's configuration.
Returns Tween<T>
- Defined in src/animation/Tween.ts:104

Accessors

delay

get delay(): number
Gets the delay before the tween starts.

Returns number
- Defined in src/animation/Tween.ts:81

duration

get duration(): number
Gets the duration of the tween.

Returns number
- Defined in src/animation/Tween.ts:74

isComplete

get isComplete(): boolean
Indicates whether the tween has finished playing.

Returns boolean
- Defined in src/animation/Tween.ts:95

target

get target(): T
Gets the object being animated by the tween.

Returns T
- Defined in src/animation/Tween.ts:67

transition

get transition(): Transition
Gets the easing/transtion function of the tween.

Returns Transition
- Defined in src/animation/Tween.ts:88

Methods

animate

animate<K extends string | number | symbol>(property: K, endValue: number): this
Adds an animation for a specific numeric property of the target.
Type Parameters
- K extends string | number | symbol
Parameters
- property: K
  The property key to animate.
- endValue: number
  The final value for the property.
Returns this
- Defined in src/animation/Tween.ts:181

onComplete

onComplete(onComplete: () => void): this
Sets a callback of the tween.
Parameters
- onComplete: () => void
  A function to call when the tween finishes
Returns this
The current Tween instance for chaining.
- Defined in src/animation/Tween.ts:170

play

play<K extends string | number | symbol>(): void
Starts the tween animation.
Type Parameters
- K extends string | number | symbol
Returns void
- Defined in src/animation/Tween.ts:200

setDelay

setDelay(delay: number): this
Sets the delay before the tween starts.
Parameters
- delay: number
  Delay in milliseconds.
Returns this
The current Tween instance for chaining.
- Defined in src/animation/Tween.ts:148

setDuration

setDuration(duration: number): this
Sets the total duration of the tween.
Parameters
- duration: number
  Duration in milliseconds.
Returns this
The current Tween instance for chaining.
- Defined in src/animation/Tween.ts:137

setTarget

setTarget(target: T): this
Sets the target object to be animated by the tween.
Parameters
- target: T
  The object to animate.
Returns this
The current Tween instance for chaining.
- Defined in src/animation/Tween.ts:126

setTransition

setTransition(transition: Transition): this
Sets the easing/transition function of the tween.
Parameters
- transition: Transition
  The easing/transition function.
Returns this
The current Tween instance for chaining.
- Defined in src/animation/Tween.ts:159

stop

stop<K extends string | number | symbol>(): void
Stops the tween immediately, sets target properties to end values, and calls the completion callback.
Type Parameters
- K extends string | number | symbol
Returns void
- Defined in src/animation/Tween.ts:215