`MotionStageApi`

interface

The scene's motes: found, spawned and destroyed, and their physics.

Name	`MotionStageApi`
Kind	interface
Script reaches it as	`stage`, or `import { stage } from "motion"` · `Mote.stage` · `Stage.stage` · `motion.stage`
Since	0.3

Syntax

interface MotionStageApi { … }declare const stage: MotionStageApi;

Name	Type	Description
`time`property	`readonly number`	The scene's time, seconds.
`motes`property	`readonly Mote[]`	Every mote.
`gravity`property	`readonly Vector3`	The 2D world's gravity, pixels a second a second (y down).

Signature	Description
`spawn<M extends Mote>(cls: string \| () => M, options?: { location?: Place; rotation?: number \| number[] \| Rotator; scale?: number \| Place; name?: string; properties?: Record<string, unknown>; tags?: string[] }): M`method	Makes a mote of a class.
`destroy(mote: Mote): void`method	Takes a mote out of the scene.
`find<M extends Mote>(cls: string \| () => M): M \| null`method	The first mote of a class.
`findAll<M extends Mote>(cls: string \| () => M): M[]`method	Every mote of a class (its subclasses' too).
`withTag(tag: string): Mote[]`method	Every mote with a tag.
`byId(id: string): Mote \| null`method	A mote by its id.
`byName(name: string): Mote \| null`method	A mote by its name.
`randomPointInView(): Vector3`method	A random point on the scene, its pixels.
`castRay(from: Place, to: Place, options?: { world?: "2d" \| "3d" }): Promise<MotionRayHit \| null>`method	The first mote's body a ray from one point to another meets, next turn.
`setGravity(v: Place, world?: "2d" \| "3d"): void`method	Sets a world's gravity.
`join(a: string \| Mote, b: string \| Mote, joint?: MotionJointSpec): number`method	Joins two motes' bodies.
`unjoin(id: number): void`method	Lets a joint go.