Skip to content

Volcano API

Volcano

Extends Effect.

Factory Function

typescript
createVolcano(config?: VolcanoConfig)

Methods

See Effect for the full method reference.


VolcanoConfig

typescript
interface VolcanoConfig {
    color?: string;
    embers?: number;
    intensity?: number;
    projectiles?: number;
    scale?: number;
    smokeColor?: string;
    speed?: number;
}
PropertyTypeDefaultDescription
colorstring'#ff4400'Base color of lava projectiles and embers.
embersnumber60Number of glowing ember particles.
intensitynumber1Eruption force multiplier.
projectilesnumber30Number of lava projectiles.
scalenumber1Scales all sizes proportionally.
smokeColorstring'#444444'Color of the rising smoke plume.
speednumber1Animation speed multiplier.

VolcanoProjectile

typescript
interface VolcanoProjectile {
    angle: number;
    glow: number;
    size: number;
    speed: number;
    x: number;
    y: number;
    vx: number;
    vy: number;
}