threejs-worldgen
    Preparing search index...

    Interface SkyTime

    Live view of the sky clock with setters, from useSkyTime.

    interface SkyTime {
        advance: (seconds: number) => void;
        clock: SkyClock;
        date: Date;
        paused: boolean;
        rate: number;
        setDate: (date: string | number | Date) => void;
        setDayLength: (seconds: number) => void;
        setPaused: (paused: boolean) => void;
        setTimeOfDay: (hours: number) => void;
        setTimeScale: (scale: number) => void;
        solarTime: number;
        time: number;
    }
    Index
    advance clock date paused rate setDate setDayLength setPaused setTimeOfDay setTimeScale solarTime time
    advance: (seconds: number) => void

    Moves time by seconds.

    clock: SkyClock

    The clock itself.

    date: Date

    Current simulation instant.

    paused: boolean

    Whether time is paused.

    rate: number

    Simulated seconds per real second right now.

    setDate: (date: string | number | Date) => void

    Jumps to a date.

    setDayLength: (seconds: number) => void

    Sets real seconds per solar day (0 = use the time scale).

    setPaused: (paused: boolean) => void

    Pauses or resumes.

    setTimeOfDay: (hours: number) => void

    Jumps to a local solar time, hours (inside <Sky> only; otherwise a no-op).

    setTimeScale: (scale: number) => void

    Sets the time scale (and clears dayLength).

    solarTime: number

    Local solar time at the observer, hours (inside <Sky>; otherwise NaN).

    time: number

    Simulation seconds since J2000.

    Settings
    Member Visibility

    On This Page
    Properties