threejs-worldgen
    Preparing search index...

    Interface LightningProps

    Props of <Lightning>: every LightningInput setting plus the ones below.

    interface LightningProps {
        branches?: number;
        branchLength?: number;
        cloudHeight?: number;
        color?: string;
        detail?: number;
        duration?: number;
        flash?: Partial<{ color: string; intensity: number }>;
        ground?: ((x: number, z: number) => number) | null;
        intensity?: number;
        jaggedness?: number;
        maxBolts?: number;
        onStrike?: (strike: Strike) => void;
        radius?: number;
        ref?: Ref<Lightning | null>;
        width?: number;
    }

    Hierarchy (View Summary)

    Index
    branches? branchLength? cloudHeight? color? detail? duration? flash? ground? intensity? jaggedness? maxBolts? onStrike? radius? ref? width?
    branches?: number

    Side branches per bolt.

    branchLength?: number

    Branch length as a share of cloudHeight.

    cloudHeight?: number

    Height of the cloud base above the strike point, metres.

    color?: string

    Bolt colour (#rrggbb).

    detail?: number

    Midpoint-displacement levels of the main channel (2^detail segments).

    duration?: number

    How long a strike stays visible (with its return strokes), seconds.

    flash?: Partial<{ color: string; intensity: number }>

    Flash settings to change.

    ground?: ((x: number, z: number) => number) | null

    Ground height (frame coordinates). Default: the weather's world.

    intensity?: number

    Bolt brightness (unlit, additive; > 1 blooms).

    jaggedness?: number

    Sideways kinks as a share of segment length.

    maxBolts?: number

    Most bolts drawn at once.

    onStrike?: (strike: Strike) => void

    Called once per strike as time passes it.

    radius?: number

    Strikes within this distance of the camera are drawn, metres.

    ref?: Ref<Lightning | null>

    Receives the LightningImpl instance.

    width?: number

    Main channel width, metres.

    Settings
    Member Visibility

    On This Page
    Properties