Type Alias ParticleEmitterConfig

type ParticleEmitterConfig = {
    accelerationX?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    accelerationY?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    active?: boolean;
    advance?: number;
    alpha?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    angle?: EmitterOpOnEmitType;
    anim?: string | string[] | ParticleEmitterAnimConfig;
    blendMode?: BlendModes | string;
    bounce?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    bounds?: ParticleEmitterBounds | ParticleEmitterBoundsAlt;
    callbackScope?: any;
    collideBottom?: boolean;
    collideLeft?: boolean;
    collideRight?: boolean;
    collideTop?: boolean;
    color?: number[];
    colorEase?: string;
    deathCallback?: Function;
    deathCallbackScope?: any;
    deathZone?: DeathZoneObject | DeathZoneObject[];
    delay?: EmitterOpOnEmitType;
    duration?: number;
    emitCallback?: Function;
    emitCallbackScope?: any;
    emitting?: boolean;
    emitZone?: EmitZoneData | EmitZoneData[];
    follow?: Vector2Like;
    followOffset?: Vector2Like;
    frame?:
        | number
        | number[]
        | string
        | string[]
        | Frame
        | Frame[]
        | ParticleEmitterFrameConfig;
    frequency?: number;
    gravityX?: number;
    gravityY?: number;
    hold?: EmitterOpOnEmitType;
    lifespan?: EmitterOpOnEmitType;
    maxAliveParticles?: number;
    maxParticles?: number;
    maxVelocityX?: EmitterOpOnEmitType
    | EmitterOpOnUpdateType;
    maxVelocityY?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    moveToX?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    moveToY?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    name?: string;
    particleBringToTop?: boolean;
    particleClass?: Function;
    quantity?: EmitterOpOnEmitType;
    radial?: boolean;
    reserve?: number;
    rotate?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    scale?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    scaleX?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    scaleY?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    sortCallback?: ParticleSortCallback;
    sortOrderAsc?: boolean;
    sortProperty?: string;
    speed?: EmitterOpOnEmitType;
    speedX?: EmitterOpOnEmitType;
    speedY?: EmitterOpOnEmitType;
    stopAfter?: number;
    texture?: string | Textures.Texture;
    timeScale?: number;
    tint?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    tintFill?: boolean;
    trackVisible?: boolean;
    visible?: boolean;
    x?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
    y?: EmitterOpOnEmitType | EmitterOpOnUpdateType;
}

Properties

`Optional`accelerationX

accelerationX?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#accelerationX.

`Optional`accelerationY

accelerationY?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#accelerationY.

`Optional`active

active?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#active. Setting this to false will stop the emitter from running at all. If you just wish to stop particles from emitting, set emitting property instead.

`Optional`advance

advance?: number

If you wish to 'fast forward' the emitter in time, set this value to a number representing the amount of ms the emitter should advance. Doing so implicitly sets emitting to true.

`Optional`alpha

alpha?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleAlpha.

`Optional`angle

angle?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleAngle (emit only).

`Optional`anim

anim?: string | string[] | ParticleEmitterAnimConfig

Sets Phaser.GameObjects.Particles.ParticleEmitter#anims.

`Optional`blendMode

blendMode?: BlendModes | string

Sets Phaser.GameObjects.Particles.ParticleEmitter#blendMode.

`Optional`bounce

bounce?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#bounce.

`Optional`bounds

bounds?: ParticleEmitterBounds | ParticleEmitterBoundsAlt

As Phaser.GameObjects.Particles.ParticleEmitter#setBounds.

`Optional`callbackScope

callbackScope?: any

Sets Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope and Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope.

`Optional`collideBottom

collideBottom?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideBottom.

`Optional`collideLeft

collideLeft?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideLeft.

`Optional`collideRight

collideRight?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideRight.

`Optional`collideTop

collideTop?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#collideTop.

`Optional`color

color?: number[]

An array of color values that the Particles interpolate through during their life. If set, overrides any tint property.

`Optional`colorEase

colorEase?: string

The string-based name of the Easing function to use if you have enabled Particle color interpolation via the color property, otherwise has no effect.

`Optional`deathCallback

deathCallback?: Function

Sets Phaser.GameObjects.Particles.ParticleEmitter#deathCallback.

`Optional`deathCallbackScope

deathCallbackScope?: any

Sets Phaser.GameObjects.Particles.ParticleEmitter#deathCallbackScope.

`Optional`deathZone

deathZone?: DeathZoneObject | DeathZoneObject[]

As Phaser.GameObjects.Particles.ParticleEmitter#setDeathZone.

`Optional`delay

delay?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#delay (emit only).

`Optional`duration

duration?: number

Limit the emitter to emit particles for a maximum of duration ms. Default to zero, meaning 'forever'.

`Optional`emitCallback

emitCallback?: Function

Sets Phaser.GameObjects.Particles.ParticleEmitter#emitCallback.

`Optional`emitCallbackScope

emitCallbackScope?: any

Sets Phaser.GameObjects.Particles.ParticleEmitter#emitCallbackScope.

`Optional`emitting

emitting?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#emitting.

`Optional`emitZone

emitZone?: EmitZoneData | EmitZoneData[]

As Phaser.GameObjects.Particles.ParticleEmitter#setEmitZone.

`Optional`follow

follow?: Vector2Like

Sets Phaser.GameObjects.Particles.ParticleEmitter#follow.

`Optional`followOffset

followOffset?: Vector2Like

Offset coordinates that assigns to Phaser.GameObjects.Particles.ParticleEmitter#followOffset.

`Optional`frame

frame?:
    | number
    | number[]
    | string
    | string[]
    | Frame
    | Frame[]
    | ParticleEmitterFrameConfig

Sets Phaser.GameObjects.Particles.ParticleEmitter#frames.

`Optional`frequency

frequency?: number

Sets Phaser.GameObjects.Particles.ParticleEmitter#frequency.

`Optional`gravityX

gravityX?: number

Sets Phaser.GameObjects.Particles.ParticleEmitter#gravityX.

`Optional`gravityY

gravityY?: number

Sets Phaser.GameObjects.Particles.ParticleEmitter#gravityY.

`Optional`hold

hold?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#hold (emit only).

`Optional`lifespan

lifespan?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#lifespan (emit only).

`Optional`maxAliveParticles

maxAliveParticles?: number

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxAliveParticles.

`Optional`maxParticles

maxParticles?: number

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxParticles.

`Optional`maxVelocityX

maxVelocityX?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityX.

`Optional`maxVelocityY

maxVelocityY?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#maxVelocityY.

`Optional`moveToX

moveToX?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#moveToX. If set, overrides angle and speed properties.

`Optional`moveToY

moveToY?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#moveToY. If set, overrides angle and speed properties.

`Optional`name

name?: string

Sets Phaser.GameObjects.Particles.ParticleEmitter#name.

`Optional`particleBringToTop

particleBringToTop?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleBringToTop.

`Optional`particleClass

particleClass?: Function

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleClass.

`Optional`quantity

quantity?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#quantity (emit only).

`Optional`radial

radial?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#radial.

`Optional`reserve

reserve?: number

Creates specified number of inactive particles and adds them to this emitter's pool. Phaser.GameObjects.Particles.ParticleEmitter#reserve

`Optional`rotate

rotate?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleRotate.

`Optional`scale

scale?: EmitterOpOnEmitType | EmitterOpOnUpdateType

As Phaser.GameObjects.Particles.ParticleEmitter#setScale.

`Optional`scaleX

scaleX?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleScaleX.

`Optional`scaleY

scaleY?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleScaleY.

`Optional`sortCallback

sortCallback?: ParticleSortCallback

A custom callback that sorts particles prior to rendering. Sets Phaser.GameObjects.Particles.ParticleEmitter#sortCallback.

`Optional`sortOrderAsc

sortOrderAsc?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#sortOrderAsc.

`Optional`sortProperty

sortProperty?: string

Sets Phaser.GameObjects.Particles.ParticleEmitter#sortProperty.

`Optional`speed

speed?: EmitterOpOnEmitType

As Phaser.GameObjects.Particles.ParticleEmitter#setSpeed (emit only).

`Optional`speedX

speedX?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#speedX (emit only).

`Optional`speedY

speedY?: EmitterOpOnEmitType

Sets Phaser.GameObjects.Particles.ParticleEmitter#speedY (emit only).

`Optional`stopAfter

stopAfter?: number

Limit the emitter to emit this exact number of particles and then stop. Default to zero, meaning no limit.

`Optional`texture

texture?: string | Textures.Texture

Sets Phaser.GameObjects.Particles.ParticleEmitter#texture. Overrides any texture already set on the Emitter.

`Optional`timeScale

timeScale?: number

Sets Phaser.GameObjects.Particles.ParticleEmitter#timeScale.

`Optional`tint

tint?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleTint.

`Optional`tintFill

tintFill?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#tintFill.

`Optional`trackVisible

trackVisible?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#trackVisible.

`Optional`visible

visible?: boolean

Sets Phaser.GameObjects.Particles.ParticleEmitter#visible.

`Optional`x

x?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleX.

`Optional`y

y?: EmitterOpOnEmitType | EmitterOpOnUpdateType

Sets Phaser.GameObjects.Particles.ParticleEmitter#particleY.