Skip to content
ClassGame Objects & Sprites@public

FlxParticleEffect ​

A movable, ordered group of emitters created from a Particle Editor export. Add the effect itself to a state; its child emitters follow the document's layer order and offsets.

ts
export declare class FlxParticleEffect extends FlxGroup<FlxParticleEmitter>

Constructors ​

ts
constructor(document: unknown, resolveSource: FlxParticleEffectSourceResolver, x?: number, y?: number)

Constructs a new instance of the FlxParticleEffect class

ParameterTypeDescription
documentunknown-
resolveSourceFlxParticleEffectSourceResolver-
xnumber-
ynumber-

Properties ​

PropertyModifiersTypeDescription
diagnosticsreadonlyFlxParticleEffectDiagnosticsCombined runtime counters for enabled layers.
documentreadonlyParticleEffectDocumentV1Validated portable document used to construct this effect.
layersreadonlyreadonly FlxParticleEffectLayer[]Enabled runtime layers in document render order.
x-numberWorld-space effect origin on the horizontal axis.
y-numberWorld-space effect origin on the vertical axis.

Methods ​

static fromAssets() ​

ts
static fromAssets(document: unknown, options?: FlxParticleEffectAssetOptions): FlxParticleEffect

Create an effect using textures already loaded by link.

Parameters:

ParameterTypeDescription
documentunknown-
optionsFlxParticleEffectAssetOptions-

Returns: FlxParticleEffect

pause() ​

ts
pause(): void

Pause every enabled layer without clearing active particles.

Returns: void

reset() ​

ts
reset(): void

Reset the deterministic simulation and clear every enabled layer.

Returns: void

resume() ​

ts
resume(): void

Resume every enabled layer from its paused state.

Returns: void

setPosition() ​

ts
setPosition(x: number, y: number): void

Move the effect origin while preserving every layer's local offset.

Parameters:

ParameterTypeDescription
xnumber-
ynumber-

Returns: void

start() ​

ts
start(restart?: boolean): void

Start every enabled layer in document order.

Parameters:

ParameterTypeDescription
restartboolean-

Returns: void

stop() ​

ts
stop(clear?: boolean): void

Stop emission, optionally clearing all active particles.

Parameters:

ParameterTypeDescription
clearboolean-

Returns: void

update() ​

ts
update(): void

Returns: void

Released under the MIT License.