effect-motion
API Referenceeffect-motionNamespacesMotionFunctions

wait

function wait(duration): Wait;

Function: wait()

function wait(duration): Wait;

Defined in: packages/motion/src/Motion.ts:1003

Hold for duration of scene time — the chainable sibling of Scene.sleep.

Parameters

ParameterTypeDescription
durationInputHow long to hold, in scene time.

Returns

Wait

Remarks

This is frame time, not wall time: Effect.sleep would block on a real clock and make the scene non-deterministic, so wait advances whole frames at the runner's frame rate instead. The same hold produces the same frame count on every run and on every machine.

Its value over Scene.sleep is placement — because it doubles as a pipe step, a beat can sit inside an animator chain without breaking it apart into separate statements.

As a pipe step it wraps the PRECEDING step and passes its value through, so it sits anywhere in a chain — including first, where the step it wraps is the bare instance handle.

Examples

A hold between two animations, mid-chain — card flows through to the fade.

yield* card.pipe(
	Motion.moveTo({ y: 100 }, "500 millis"),
	Motion.wait("1 second"),
	Motion.fadeTo(0, "300 millis"),
);

Or yielded on its own, as a plain pause in the scene body.

yield* Motion.wait("2 seconds");

On this page