effect-motion
API Referenceeffect-motionNamespacesMotionInterfaces

Wait

you can drop into a `pipe` chain.

Interface: Wait()

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

The dual nature of wait: an Effect you can yield, and a function you can drop into a pipe chain.

Remarks

Being callable is what lets a hold sit BETWEEN two animators in the same chain — it wraps the preceding step, waits after it completes, and passes that step's value (the instance) through untouched, so the chain keeps flowing.

Extends

Wait<Self>(self): Self extends Instance<
  | "Audio"
  | "Line"
  | "Path"
  | "Rect"
  | "Circle"
  | "Ellipse"
  | "Text"
  | "Group"
  | "Hud"
  | "Image"
  | "Camera"> ? Effect<Self, never, Runner> : Self extends Effect<A, E, R> ? Effect<A, E, Runner | R> : never;

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

The dual nature of wait: an Effect you can yield, and a function you can drop into a pipe chain.

Type Parameters

Type Parameter
Self extends | Effect<any, any, any> | Instance< | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera">

Parameters

ParameterType
selfSelf

Returns

Self extends Instance< | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera"> ? Effect<Self, never, Runner> : Self extends Effect<A, E, R> ? Effect<A, E, Runner | R> : never

Remarks

Being callable is what lets a hold sit BETWEEN two animators in the same chain — it wraps the preceding step, waits after it completes, and passes that step's value (the instance) through untouched, so the chain keeps flowing.

On this page