AlphaBehavior | @pixi/particle-emitter

An Alpha behavior that applies an interpolated or stepped list of values to the particle's opacity.

Example config:

{
    type: 'alpha',
    config: {
        alpha: {
             list: [{value: 0, time: 0}, {value: 1, time: 0.25}, {value: 0, time: 1}]
        },
    }
}

Hierarchy

AlphaBehavior

Implements

IEmitterBehavior

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlphaBehavior(config: { alpha: ValueList<number> }): AlphaBehavior

- Defined in src/behaviors/Alpha.ts:29
Parameters
- config: { alpha: ValueList<number> }
  - alpha: ValueList<number>
    
    Transparency of the particles from 0 (transparent) to 1 (opaque)
Returns AlphaBehavior

Properties

Private list

list: PropertyList<number>

order

order: BehaviorOrder = BehaviorOrder.Normal

Order in which the behavior will be handled. Lower numbers are handled earlier, with an order of 0 getting special treatment before the Emitter's transformation is applied.

Static editorConfig

editorConfig: BehaviorEditorConfig = null

Static type

type: string = 'alpha'

Methods

initParticles

initParticles(first: Particle): void

Implementation of IEmitterBehavior.initParticles
- Defined in src/behaviors/Alpha.ts:40
Called to initialize a wave of particles, with a reference to the first particle in the linked list.

Parameters
- first: Particle
Returns void

updateParticle

updateParticle(particle: Particle): void

Implementation of IEmitterBehavior.updateParticle
- Defined in src/behaviors/Alpha.ts:51
Updates a single particle for a given period of time elapsed. Return true to recycle the particle.

Parameters
- particle: Particle
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: { alpha: ValueList<number> }

alpha: ValueList<number>

Returns AlphaBehavior

Properties

Private list

order

Static editorConfig

Static type

Methods

initParticles

Parameters

first: Particle

Returns void

updateParticle

Parameters

particle: Particle

Returns void