ClassGame Objects & Sprites@public

FlxParticleEmitter

Renders a validated particle preset through Flixel-Pixi's existing emitter and camera pipeline while delegating simulation to the deterministic runtime.

export declare class FlxParticleEmitter extends FlxEmitter

Constructors

constructor(preset: unknown, source: FlxParticleEmitterSource, x?: number, y?: number)

Constructs a new instance of the FlxParticleEmitter class

Parameter	Type	Description
preset	unknown	-
source	FlxParticleEmitterSource	-
x	number	-
y	number	-

Properties

Property	Modifiers	Type	Description
diagnostics	readonly	ParticleEmitterDiagnostics	-
preset	readonly	ParticlePresetV1	-

Methods

destroy()

destroy(): void

Returns: void

static fromAssets()

static fromAssets(preset: unknown, options?: FlxParticleEmitterAssetOptions): FlxParticleEmitter

Create an emitter from an asset that has already been loaded by link. Named frame presets may provide a frame collection.

Parameters:

Parameter	Type	Description
preset	unknown	-
options	FlxParticleEmitterAssetOptions	-

Returns: FlxParticleEmitter

kill()

kill(): void

Returns: void

pause()

pause(): void

Returns: void

resetPreset()

resetPreset(): void

Returns: void

resume()

resume(): void

Returns: void

start()

start(restart?: boolean, _lifespan?: number, _frequency?: number, _quantity?: number): void

Start the preset. Passing false continues without resetting its pool.

Parameters:

Parameter	Type	Description
restart	boolean	-
_lifespan	number	-
_frequency	number	-
_quantity	number	-

Returns: void

stop()

stop(clear?: boolean): void

Parameters:

Parameter	Type	Description
clear	boolean	-

Returns: void

update()

update(): void

Returns: void