Skip to content

Tornado API

Tornado

Extends Effect.

Factory Function

typescript
createTornado(config?: TornadoConfig)

Methods

See Effect for the full method reference.


TornadoConfig

typescript
interface TornadoConfig {
    color?: string;
    debris?: number;
    intensity?: number;
    scale?: number;
    speed?: number;
    width?: number;
}
PropertyTypeDefaultDescription
colorstring'#8B7355'Base color of the funnel and debris particles.
debrisnumber150Number of debris particles spiraling around the vortex.
intensitynumber1Vortex strength multiplier.
scalenumber1Scales all sizes proportionally.
speednumber1Animation speed multiplier.
widthnumber0.3Relative width of the funnel base (0–1).

TornadoParticle

typescript
interface TornadoParticle {
    angle: number;
    distance: number;
    height: number;
    opacity: number;
    size: number;
    speed: number;
}

TornadoDebris

typescript
interface TornadoDebris {
    angle: number;
    distance: number;
    height: number;
    rotation: number;
    size: number;
    speed: number;
    type: number;
}