particlesEscapeInstantiate
function particlesEscapeInstantiate(runner, state): Effect<Instance<
Function: particlesEscapeInstantiate()
function particlesEscapeInstantiate(runner, state): Effect<Instance<
| "Audio"
| "Line"
| "Path"
| "Rect"
| "Circle"
| "Ellipse"
| "Text"
| "Group"
| "Hud"
| "Image"
| "Camera">, never, Runner>;Defined in: packages/motion/src/Runner.ts:860
instantiate a non-union entity. Particles only.
Parameters
| Parameter | Type | Description |
|---|---|---|
runner | { anchorAudio: (id, until?) => void; appendChild: (parent, child) => Error | null; awaitedCount: () => number; backgrounds: Set<BranchEntry>; camera: Instance<"Camera">; cameraOf: (compId) => Instance<"Camera">; clearMask: (target) => void; comp: CompConfig; countAwaited: (n) => void; destroy: (instance) => void; failureCause: () => Cause<unknown> | undefined; forks: Set<BranchEntry>; getDataUnsafe: <Tag>(instance) => | EntityByTag<Tag> | null; instantiate: <Tag>(...args) => Effect<Instance<Tag>, never, Runner>; instantiateEscape: (...args) => Effect<Instance< | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera">, never, never>; phaser: { arriveAndAwaitAdvance: Effect<void, never, never>; awaitAdvance: Effect<number, never, never>; deregister: (n) => void; register: (n) => void; snapshotUnsafe: () => { arrived: number; parties: number; phase: number; state: "idle" | "pending" | "running"; }; }; recordFailure: (cause) => void; registerComp: (id, config) => void; removeChild: (parent, child) => void; root: GroupInstance; setCamera: (instance, compId) => void; setDataUnsafe: <Tag>(instance, state) => void; setMask: (target, source, mode) => Error | null; settings: { frameRate: number; maxFrames: number; seed: Seed; }; state: Effect<{ backgroundColor: Color; camera: CameraView & PointOfInterest; comps: { [k: string]: CompFrame; }; frameRate: number; height: number; instances: Record<string, { data: | { audio: { id: string; }; gain: number; loop: boolean; playing: boolean; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; time: number; } | { end: { x: number; y: number; z: number; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; start: { x: number; y: number; z: number; }; strokeColor: Color; strokeWidth: number; visible: boolean; } | { commands: readonly [ | { } | { x: number; y: number; z?: ... | ...; } | { x: number; y: number; z?: ... | ...; }, | { } | { x: number; y: number; z?: ... | ...; } | { x: number; y: number; z?: ... | ...; }]; fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; height: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; width: number; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radius: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radiusX: number; radiusY: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { baseline?: "middle" | "auto" | "hanging"; fillColor: Color; fontFamily: { id: string; }; fontSize: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; text: string; textAnchor?: "start" | "end" | "middle"; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { height?: number; image: { id: string; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; width?: number; } | { aperture: number; focalLength: number; focusDistance: number; poi: | { x: number; y: number; z: number; } | null; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; }; }>; masks: { [k: string]: MaskAttachment; }; root: string; width: number; }, never, never>; } | - |
runner.anchorAudio | (id, until?) => void | - |
runner.appendChild | (parent, child) => Error | null | - |
runner.awaitedCount | () => number | - |
runner.backgrounds | Set<BranchEntry> | - |
runner.camera | Instance<"Camera"> | - |
runner.cameraOf | (compId) => Instance<"Camera"> | - |
runner.clearMask | (target) => void | - |
runner.comp | CompConfig | - |
runner.countAwaited | (n) => void | - |
runner.destroy | (instance) => void | - |
runner.failureCause | () => Cause<unknown> | undefined | - |
runner.forks | Set<BranchEntry> | - |
runner.getDataUnsafe | <Tag>(instance) => | EntityByTag<Tag> | null | - |
runner.instantiate | <Tag>(...args) => Effect<Instance<Tag>, never, Runner> | - |
runner.instantiateEscape | (...args) => Effect<Instance< | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera">, never, never> | ponytail: create a tree node for an entity that is NOT in the union — the particle system only (design D10). Mounts under the ambient parent like any instance. Delete with the particles rewrite; see particlesEscapeInstantiate. |
runner.phaser | { arriveAndAwaitAdvance: Effect<void, never, never>; awaitAdvance: Effect<number, never, never>; deregister: (n) => void; register: (n) => void; snapshotUnsafe: () => { arrived: number; parties: number; phase: number; state: "idle" | "pending" | "running"; }; } | - |
runner.phaser.arriveAndAwaitAdvance | Effect<void, never, never> | - |
runner.phaser.awaitAdvance | Effect<number, never, never> | - |
runner.phaser.deregister | (n) => void | - |
runner.phaser.register | (n) => void | - |
runner.phaser.snapshotUnsafe | () => { arrived: number; parties: number; phase: number; state: "idle" | "pending" | "running"; } | debug/test view of the internal counters |
runner.recordFailure | (cause) => void | - |
runner.registerComp | (id, config) => void | - |
runner.removeChild | (parent, child) => void | - |
runner.root | GroupInstance | - |
runner.setCamera | (instance, compId) => void | - |
runner.setDataUnsafe | <Tag>(instance, state) => void | - |
runner.setMask | (target, source, mode) => Error | null | - |
runner.settings | { frameRate: number; maxFrames: number; seed: Seed; } | - |
runner.settings.frameRate | number | - |
runner.settings.maxFrames | number | - |
runner.settings.seed | Seed | - |
runner.state | Effect<{ backgroundColor: Color; camera: CameraView & PointOfInterest; comps: { [k: string]: CompFrame; }; frameRate: number; height: number; instances: Record<string, { data: | { audio: { id: string; }; gain: number; loop: boolean; playing: boolean; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; time: number; } | { end: { x: number; y: number; z: number; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; start: { x: number; y: number; z: number; }; strokeColor: Color; strokeWidth: number; visible: boolean; } | { commands: readonly [ | { } | { x: number; y: number; z?: ... | ...; } | { x: number; y: number; z?: ... | ...; }, | { } | { x: number; y: number; z?: ... | ...; } | { x: number; y: number; z?: ... | ...; }]; fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; height: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; width: number; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radius: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radiusX: number; radiusY: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { baseline?: "middle" | "auto" | "hanging"; fillColor: Color; fontFamily: { id: string; }; fontSize: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; text: string; textAnchor?: "start" | "end" | "middle"; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { height?: number; image: { id: string; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; width?: number; } | { aperture: number; focalLength: number; focusDistance: number; poi: | { x: number; y: number; z: number; } | null; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; }; }>; masks: { [k: string]: MaskAttachment; }; root: string; width: number; }, never, never> | - |
state | ParticlesState | - |
Returns
Effect<Instance<
| "Audio"
| "Line"
| "Path"
| "Rect"
| "Circle"
| "Ellipse"
| "Text"
| "Group"
| "Hud"
| "Image"
| "Camera">, never, Runner>