Class ParticleSystemBaseBehaviourAbstract

Base class for custom particle behaviors. Extend this to create custom particle logic.

Override initialize() to set up per-particle state when particles spawn.
Override update() to modify particles each frame (position, velocity, color, size, etc.).
Override frameUpdate() for logic that runs once per frame (not per particle).

Example: Custom wind effect

class WindBehaviour extends ParticleSystemBaseBehaviour {
  windStrength = 2;
  windDirection = new Vector3(1, 0, 0);

  update(particle: Particle, delta: number) {
    particle.velocity.addScaledVector(this.windDirection, this.windStrength * delta);
  }
}

See

ParticleSystem.addBehaviour to register your custom behavior

Link

https://github.com/Alchemist0823/three.quarks

Implements

  • Behavior

Constructors

constructor

Properties

system type

Accessors

context

Methods

clone frameUpdate initialize reset toJSON update

Constructors

constructor

Properties

system

system: ParticleSystem

Reference to the particle system this behavior belongs to

type

type: string

Behavior type identifier used by three.quarks

Accessors

context

  • get context(): Context

    Access to the engine context for timing, input, etc.

    Returns Context

Methods

clone

  • clone(): Behavior

    Returns Behavior

frameUpdate

  • frameUpdate(_delta: number): void

    Called once per frame before particle updates. Use for shared calculations.

    Parameters

    • _delta: number

    Returns void

initialize

  • initialize(_particle: Particle): void

    Called once when a particle is spawned. Use to initialize per-particle state.

    Parameters

    • _particle: Particle

    Returns void

reset

  • reset(): void

    Called when the particle system is reset.

    Returns void

toJSON

  • toJSON(): void

    Returns void

update

  • update(_particle: Particle, _delta: number): void

    Called every frame for each active particle. Use to update particle properties.

    Parameters

    • _particle: Particle
    • _delta: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods