Skip to content
ClassGame Objects & Sprites@public

FlxEmitter

Deterministic burst/stream emitter backed by FlxGroup recycling.

ts
export declare class FlxEmitter extends FlxGroup<FlxParticle>

Constructors

ts
constructor(x?: number, y?: number, size?: number)

Constructs a new instance of the FlxEmitter class

ParameterTypeDescription
xnumber-
ynumber-
sizenumber-

Properties

PropertyModifiersTypeDescription
bounce-number-
frequency-number-
gravity-number-
height-number-
lifespan-number-
maxParticleSpeed-FlxPoint-
maxRotation-number-
minParticleSpeed-FlxPoint-
minRotation-number-
on-boolean-
particleClass-FlxParticleConstructor | null-
particleDrag-FlxPoint-
width-number-
x-number-
y-number-

Methods

at()

ts
at(object: FlxObject): void

Parameters:

ParameterTypeDescription
objectFlxObject-

Returns: void

createRenderHandle()

ts
createRenderHandle(options?: FlxEmitterRenderOptions): FlxEmitterRenderHandle

Parameters:

ParameterTypeDescription
optionsFlxEmitterRenderOptions-

Returns: FlxEmitterRenderHandle

destroy()

ts
destroy(): void

Returns: void

emitParticle()

ts
emitParticle(): void

Returns: void

kill()

ts
kill(): void

Returns: void

makeParticles()

ts
makeParticles(source: FlxGraphic | Texture, quantity?: number, bakedRotations?: number, multiple?: boolean, collide?: number): this

Parameters:

ParameterTypeDescription
sourceFlxGraphic | Texture-
quantitynumber-
bakedRotationsnumber-
multipleboolean-
collidenumber-

Returns: this

setRotation()

ts
setRotation(min?: number, max?: number): void

Parameters:

ParameterTypeDescription
minnumber-
maxnumber-

Returns: void

setSize()

ts
setSize(width: number, height: number): void

Parameters:

ParameterTypeDescription
widthnumber-
heightnumber-

Returns: void

setXSpeed()

ts
setXSpeed(min?: number, max?: number): void

Parameters:

ParameterTypeDescription
minnumber-
maxnumber-

Returns: void

setYSpeed()

ts
setYSpeed(min?: number, max?: number): void

Parameters:

ParameterTypeDescription
minnumber-
maxnumber-

Returns: void

start()

ts
start(explode?: boolean, lifespan?: number, frequency?: number, quantity?: number): void

Parameters:

ParameterTypeDescription
explodeboolean-
lifespannumber-
frequencynumber-
quantitynumber-

Returns: void

update()

ts
update(): void

Returns: void

Released under the MIT License.