Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface FlickerBehaviorOptions

    Configuration options for the FlickerBehavior.

    interface FlickerBehaviorOptions {
        frequency?: number;
        maxFlickerTime?: number;
        maxStableTime?: number;
        minFlickerTime?: number;
        minMultiplier?: number;
        minStableTime?: number;
        noiseOffset?: number;
        onUpdate: (multiplier: number, targetObj: Object3D) => void;
        smoothness?: number;
    }
    Index
    frequency? maxFlickerTime? maxStableTime? minFlickerTime? minMultiplier? minStableTime? noiseOffset? onUpdate smoothness?
    frequency?: number

    Speed/frequency factor of the continuous noise flicker. Defaults to 15.0.

    maxFlickerTime?: number

    Maximum duration of the flickering phase in seconds. Defaults to 1.5.

    maxStableTime?: number

    Maximum duration of the stable phase in seconds. Defaults to 6.0.

    minFlickerTime?: number

    Minimum duration of the flickering phase in seconds. Defaults to 0.2.

    minMultiplier?: number

    The lowest the multiplier can drop during flickering. Defaults to 0.0.

    minStableTime?: number

    Minimum duration of the stable (fully on) phase in seconds. Defaults to 2.0.

    noiseOffset?: number

    Spatial/noise seed offset ensuring multiple flicker behaviors don't pulse synchronously.

    onUpdate: (multiplier: number, targetObj: Object3D) => void

    The callback that applies the flicker multiplier (0.0 to 1.0).

    smoothness?: number

    How smooth the transitions are. 0 = instant cuts (like broken electronics), 1 = smooth sine-like organic transitions. Defaults to 0.0.

    Settings
    Member Visibility

    On This Page
    Properties