SingleTextureBehavior | @pixi/particle-emitter

A Textuure behavior that assigns a single texture to each particle. String values will be converted to textures with ParticleUtils.GetTextureFromString.

Example config:

{
    type: 'textureSingle',
    config: {
        texture: Texture.from('myTexId'),
    }
}

Hierarchy

SingleTextureBehavior

Implements

IEmitterBehavior

Index

Constructors

constructor

Properties

Methods

initParticles

Constructors

constructor

new SingleTextureBehavior(config: { texture: string | Texture<Resource> }): SingleTextureBehavior

- Defined in src/behaviors/SingleTexture.ts:28
Parameters
- config: { texture: string | Texture<Resource> }
  - texture: string | Texture<Resource>
    
    Image to use for each particle.
Returns SingleTextureBehavior

Properties

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.

Private texture

texture: Texture<Resource>

Static editorConfig

editorConfig: BehaviorEditorConfig = null

Static type

type: string = 'textureSingle'

Methods

initParticles

initParticles(first: Particle): void

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

Parameters
- first: Particle
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: { texture: string | Texture<Resource> }

texture: string | Texture<Resource>

Returns SingleTextureBehavior

Properties

order

Private texture

Static editorConfig

Static type

Methods

initParticles

Parameters

first: Particle

Returns void