Tween
constTween:object
Defined in: Tween.ts:10
Static factory for creating tween Processes.
Type Declaration
Section titled “Type Declaration”custom()
Section titled “custom()”custom(
setter,from,to,duration,easing?):Process
Tween using a custom setter. duration is in seconds, finite and > 0; both endpoints must be finite.
Parameters
Section titled “Parameters”setter
Section titled “setter”(value) => void
number
number
duration
Section titled “duration”number
easing?
Section titled “easing?”EasingFunction = easeLinear
Returns
Section titled “Returns”stagger()
Section titled “stagger()”stagger<
T>(items,factory,stepSeconds):Process[]
Map a Process factory over an array, staggering each item’s START by
stepSeconds (item 0 starts immediately, item 1 after stepSeconds, and
so on). Returns one Process per item — enqueue them all on a process queue
(or useSplitText’s run) to play a staggered cascade across a split
text’s chars / words / lines. The factory runs when each item’s turn
begins, so a Tween.to built inside it reads its from value at start
time, not build time.
stepSeconds must be finite and >= 0. Zero is allowed and starts every
item at once.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”readonly T[]
factory
Section titled “factory”(item, index) => Process
stepSeconds
Section titled “stepSeconds”number
Returns
Section titled “Returns”Process[]
to(
target,property,to,duration,easing?):Process
Tween a numeric property on a target object. duration is in seconds, finite and > 0; both endpoints must be finite.
Parameters
Section titled “Parameters”target
Section titled “target”Record<string, number>
property
Section titled “property”string
number
duration
Section titled “duration”number
easing?
Section titled “easing?”EasingFunction = easeLinear
Returns
Section titled “Returns”vec2()
Section titled “vec2()”vec2(
setter,from,to,duration,easing?):Process
Tween a Vec2 value. duration is in seconds, finite and > 0; both endpoints must be finite.
Parameters
Section titled “Parameters”setter
Section titled “setter”(value) => void
duration
Section titled “duration”number
easing?
Section titled “easing?”EasingFunction = easeLinear
Returns
Section titled “Returns”Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/core.md.