Log inGet started
Package

Atmos.module

This package holds more than this page lists. See all of its files in its world.

README.md

Atmos

The island's time of day and weather on worldClockKit's shared clock, and the look each machine draws from them. Started by the IslandAtmosphere component.

  • Atmos.setTime("morning" | "noon" | "sunset" | "night", { hold? }): set the shared clock for every player (hold = true pauses it there).
  • Atmos.setWeather("clear" | "shower" | any worldClockKit weather, { fade? }): set the shared weather for every player; "shower" rains until the weather is changed again.
  • Atmos.shower({ duration = 75, fade = 7, clearFade = 16 }): a passing tropical shower for every player: the sky darkens, it pours, then it clears back to sun. Whoever holds the clock ends it (the end time is kept in runtime_data.world), so it ends even if the caller left.
  • Atmos.current(): the blended look now (grade, haze, ocean, sky, ambience, shower, weights); Atmos.lookFor(weights, shower) is the same, pure.
  • Atmos.report(): what this machine shows: time, preset weights, shower amount, weather, clock hour, sky mode, the ocean it applied, ambience levels and calls, footstep counts per surface, footprints alive.
  • Atmos.PRESETS, Atmos.SHOWER, Atmos.SKY_LOOK ("tropical", defined with worldClockKit's Sky), the tropicalShower weather, Atmos.configure(opts), Atmos.start(opts, holder) / Atmos.stop(holder) / Atmos.tick(dt).

On each machine it writes three of the engine's post passes (colorGrade, color_correction tint, vignette), shapes the clock director's fog into sea haze, colours the scene's ProceduralSky (skyMode "engine") with a rain-cloud deck in a shower, overrides the Ocean's water colour, wind, choppiness and wave amplitude per time and weather (in steps, at most every 2 s, restored when it stops), and optionally drives the engine's volumetric lighting for sun shafts.