Class EmitterOp

This class is responsible for taking control over a single property in the Particle class and managing its emission and updating functions.

Particles properties such as x, y, scaleX, lifespan and others all use EmitterOp instances to manage them, as they can be given in a variety of formats: from simple values, to functions, to dynamic callbacks.

See the ParticleEmitter class for more details on emitter op configuration.

Hierarchy (View Summary)

EmitterOp
- EmitterColorOp

Constructors

constructor

new EmitterOp(
    key: string,
    defaultValue: EmitterOpOnEmitType | EmitterOpOnUpdateType,
    emitOnly?: boolean,
): EmitterOp
Parameters
- key: string
  The name of the property.
- defaultValue: EmitterOpOnEmitType | EmitterOpOnUpdateType
  The default value of the property.
- OptionalemitOnly: boolean
  Whether the property can only be modified when a Particle is emitted. Default false.
Returns EmitterOp
- Defined in types/phaser.d.ts:29139

Properties

active

active: boolean

Set to false to disable this EmitterOp.

counter

counter: number

The step counter for stepped easing, per emit.

current

current: number

The most recently calculated value. Updated every time an emission or update method is called. Treat as read-only.

defaultValue

defaultValue: EmitterOpOnEmitType | EmitterOpOnUpdateType

The default value of this property.

This can be a simple value, an array, a function or an onEmit configuration object.

direction

direction: number

The counter direction. 0 for up and 1 for down.

ease

ease: Function

The easing function to use for updating this property, if any.

emitOnly

emitOnly: boolean

Whether this property can only be modified when a Particle is emitted.

Set to true to allow only Phaser.GameObjects.Particles.EmitterOp#onEmit callbacks to be set and affect this property.

Set to false to allow both Phaser.GameObjects.Particles.EmitterOp#onEmit and Phaser.GameObjects.Particles.EmitterOp#onUpdate callbacks to be set and affect this property.

end

end: number

The end value for this property to ease between.

interpolation

interpolation: Function

The interpolation function to use for updating this property, if any.

method

method: number

The onEmit method type of this EmitterOp.

Set as part of setMethod and cached here to avoid re-setting when only the value changes.

onEmit

onEmit: EmitterOpOnEmitCallback

The callback to run for Particles when they are emitted from the Particle Emitter.

onUpdate

onUpdate: EmitterOpOnUpdateCallback

The callback to run for Particles when they are updated.

propertyKey

propertyKey: string

The name of this property.

propertyValue

propertyValue: EmitterOpOnEmitType | EmitterOpOnUpdateType

The current value of this property.

This can be a simple value, an array, a function or an onEmit configuration object.

start

start: number | number[]

The start value for this property to ease between.

If an interpolation this holds a reference to the number data array.

steps

steps: number

The number of steps for stepped easing between Phaser.GameObjects.Particles.EmitterOp#start and Phaser.GameObjects.Particles.EmitterOp#end values, per emit.

yoyo

yoyo: boolean

When the step counter reaches it's maximum, should it then yoyo back to the start again, or flip over to it?

Methods

defaultEmit

defaultEmit(): number
The returned value sets what the property will be at the START of the particles life, on emit.

Returns number
- Defined in types/phaser.d.ts:29306

defaultUpdate

defaultUpdate(particle: Particle, key: string, t: number, value: number): number
The returned value updates the property for the duration of the particles life.
Parameters
- particle: Particle
  The particle.
- key: string
  The name of the property.
- t: number
  The current normalized lifetime of the particle, between 0 (birth) and 1 (death).
- value: number
  The current value of the property.
Returns number
- Defined in types/phaser.d.ts:29315

destroy

destroy(): void
Destroys this EmitterOp instance and all of its references.

Called automatically when the ParticleEmitter that owns this EmitterOp is destroyed.

Returns void
- Defined in types/phaser.d.ts:29401

easedValueEmit

easedValueEmit(particle: Particle, key: string): number
An onEmit callback for an eased property.

It prepares the particle for easing by Phaser.GameObjects.Particles.EmitterOp#easeValueUpdate.
Parameters
- particle: Particle
  The particle.
- key: string
  The name of the property.
Returns number
- Defined in types/phaser.d.ts:29383

easeValueUpdate

easeValueUpdate(particle: Particle, key: string, t: number): number
An onUpdate callback that returns an eased value between the Phaser.GameObjects.Particles.EmitterOp#start and Phaser.GameObjects.Particles.EmitterOp#end range.
Parameters
- particle: Particle
  The particle.
- key: string
  The name of the property.
- t: number
  The current normalized lifetime of the particle, between 0 (birth) and 1 (death).
Returns number
- Defined in types/phaser.d.ts:29393

getMethod

getMethod(): number
Checks the type of EmitterOp.propertyValue to determine which method is required in order to return values from this op function.

Returns number
- Defined in types/phaser.d.ts:29270

has

has(object: object, key: string): boolean
Check whether an object has the given property.
Parameters
- object: object
  The object to check.
- key: string
  The key of the property to look for in the object.
Returns boolean
- Defined in types/phaser.d.ts:29285

hasBoth

hasBoth(object: object, key1: string, key2: string): boolean
Check whether an object has both of the given properties.
Parameters
- object: object
  The object to check.
- key1: string
  The key of the first property to check the object for.
- key2: string
  The key of the second property to check the object for.
Returns boolean
- Defined in types/phaser.d.ts:29293

hasEither

hasEither(object: object, key1: string, key2: string): boolean
Check whether an object has at least one of the given properties.
Parameters
- object: object
  The object to check.
- key1: string
  The key of the first property to check the object for.
- key2: string
  The key of the second property to check the object for.
Returns boolean
- Defined in types/phaser.d.ts:29301

loadConfig

loadConfig(config?: ParticleEmitterConfig, newKey?: string): void
Load the property from a Particle Emitter configuration object.

Optionally accepts a new property key to use, replacing the current one.
Parameters
- Optionalconfig: ParticleEmitterConfig
  Settings for the Particle Emitter that owns this property.
- OptionalnewKey: string
  The new key to use for this property, if any.
Returns void
- Defined in types/phaser.d.ts:29253

onChange

onChange(value: number): this
Change the current value of the property and update its callback methods.
Parameters
- value: number
  The new numeric value of this property.
Returns this
- Defined in types/phaser.d.ts:29264

proxyEmit

proxyEmit(particle: Particle, key: string, value?: number): number
The returned value sets what the property will be at the START of the particles life, on emit.

This method is only used when you have provided a custom emit callback.
Parameters
- particle: Particle
  The particle.
- key: string
  The name of the property.
- Optionalvalue: number
  The current value of the property.
Returns number
- Defined in types/phaser.d.ts:29325

proxyUpdate

proxyUpdate(particle: Particle, key: string, t: number, value: number): number
The returned value updates the property for the duration of the particles life.

This method is only used when you have provided a custom update callback.
Parameters
- particle: Particle
  The particle.
- key: string
  The name of the property.
- t: number
  The current normalized lifetime of the particle, between 0 (birth) and 1 (death).
- value: number
  The current value of the property.
Returns number
- Defined in types/phaser.d.ts:29336

randomRangedIntEmit

randomRangedIntEmit(particle: Particle, key: string): number
An onEmit callback that returns a value between the Phaser.GameObjects.Particles.EmitterOp#start and Phaser.GameObjects.Particles.EmitterOp#end range.
Parameters
- particle: Particle
  The particle.
- key: string
  The key of the property.
Returns number
- Defined in types/phaser.d.ts:29367

randomRangedValueEmit

randomRangedValueEmit(particle: Particle, key: string): number
An onEmit callback that returns a value between the Phaser.GameObjects.Particles.EmitterOp#start and Phaser.GameObjects.Particles.EmitterOp#end range.
Parameters
- particle: Particle
  The particle.
- key: string
  The key of the property.
Returns number
- Defined in types/phaser.d.ts:29359

randomStaticValueEmit

randomStaticValueEmit(): number
An onEmit callback that returns a random value from the current value array.

Returns number
- Defined in types/phaser.d.ts:29351

setMethods

setMethods(): this
Update the Phaser.GameObjects.Particles.EmitterOp#onEmit and Phaser.GameObjects.Particles.EmitterOp#onUpdate callbacks based on the method returned from getMethod. The method is stored in the EmitterOp.method property and is a number between 0 and 9 inclusively.

Returns this
- Defined in types/phaser.d.ts:29278

staticValueEmit

staticValueEmit(): number
An onEmit callback that returns the current value of the property.

Returns number
- Defined in types/phaser.d.ts:29341

staticValueUpdate

staticValueUpdate(): number
An onUpdate callback that returns the current value of the property.

Returns number
- Defined in types/phaser.d.ts:29346

steppedEmit

steppedEmit(): number
An onEmit callback that returns a stepped value between the Phaser.GameObjects.Particles.EmitterOp#start and Phaser.GameObjects.Particles.EmitterOp#end range.

Returns number
- Defined in types/phaser.d.ts:29374

toJSON

toJSON(): object
Build a JSON representation of this Particle Emitter property.

Returns object
- Defined in types/phaser.d.ts:29258

Class EmitterOp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EmitterOp

Properties

active

counter

current

defaultValue

direction

ease

emitOnly

end

interpolation

method

onEmit

onUpdate

propertyKey

propertyValue

start

steps

yoyo

Methods

defaultEmit

Returns number

defaultUpdate

Parameters

Returns number

destroy

Returns void

easedValueEmit

Parameters

Returns number

easeValueUpdate

Parameters

Returns number

getMethod

Returns number

has

Parameters

Returns boolean

hasBoth

Parameters

Returns boolean

hasEither

Parameters

Returns boolean

loadConfig

Parameters

Returns void

onChange

Parameters

Returns this

proxyEmit

Parameters

Returns number

proxyUpdate

Parameters

Returns number

randomRangedIntEmit

Parameters

Returns number

randomRangedValueEmit

Parameters

Returns number

randomStaticValueEmit

Returns number

setMethods

Returns this

staticValueEmit

Returns number

staticValueUpdate

Returns number

steppedEmit