phaser - v4.0.0-rc.4
    Preparing search index...

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

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

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    active: boolean

    Set to false to disable this EmitterOp.

    b: number[]

    An array containing the blue color values.

    Populated during the setMethods method.

    counter: number

    The step counter for stepped easing, per emit.

    current: number

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

    The default value of this property.

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

    direction: number

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

    ease: Function

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

    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: number

    The end value for this property to ease between.

    g: number[]

    An array containing the green color values.

    Populated during the setMethods method.

    interpolation: Function

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

    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.

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

    The callback to run for Particles when they are updated.

    propertyKey: string

    The name of this property.

    The current value of this property.

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

    r: number[]

    An array containing the red color values.

    Populated during the setMethods method.

    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: number

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

    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

    • 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

    • Destroys this EmitterOp instance and all of its references.

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

      Returns void

    • Checks the type of EmitterOp.propertyValue to determine which method is required in order to return values from this op function.

      Returns number

    • 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

    • 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

    • 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

    • 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

    • Change the current value of the property and update its callback methods.

      Parameters

      • value: number

        The new numeric value of this property.

      Returns this

    • 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

    • 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

    • Sets the Ease function to use for Color interpolation.

      Parameters

      • ease: string

        The string-based name of the Ease function to use.

      Returns void