`ParticleComponent`

class

A particle layer of a mote.

Name	`ParticleComponent`
Kind	class
Script reaches it as	`import { ParticleComponent } from "motion"`
Since	0.3

Syntax

class ParticleComponent extends Component { … }

Name	Type	Description
`name`property	`readonly string`	Its name on its mote.
`layer`property	`readonly string`	Its layer's id.
`visible`property	`boolean`	Whether its layer shows.
`opacity`property	`number`	Its layer's opacity, 0 to 1.
`alive`property	`readonly number`	How many particles are alive, as its last step counted.
`paused`property	`readonly boolean`	Whether its spawning is paused.

Signature	Description
`new ParticleComponent(name?: string, layer?: string): ParticleComponent`constructor	Binds a layer to a mote by hand. A mote's components are made with it, from the layers it's given in Studio, so you rarely need this.
`set(key: string, value: SettingValue): void`method	Changes one of its layer's settings.
`animate(key: string, value: string \| number, seconds: number, options?: MotionAnimateOptions): Promise<boolean>`method	Moves one of its layer's settings.
`stopAnimating(key?: string): void`method	Stops its layer's moves.
`get(key: string): SettingValue \| undefined`method	One of its layer's settings, as scene.get.
`read(key: string): SettingValue \| undefined`method	One of its layer's settings as last drawn, as scene.read.
`show(visible?: boolean): void`method	Shows (or hides) its layer.
`hide(): void`method	Hides its layer.
`burst(count?: number, at?: [number, number] \| { x: number; y: number }, emitter?: string \| number): void`method	Fires a burst of particles.
`setRate(perSecond: number, emitter?: string \| number): void`method	Sets how many particles an emitter makes a second, in place of its own rate.
`resetRate(emitter?: string \| number): void`method	Gives an emitter (or every one) its own rate back.
`pause(): void`method	Stops the system making particles; those alive live out their lives.
`resume(): void`method	Lets it make particles again.
`clear(): void`method	Takes every particle away at once, and the bursts waiting.