Log inGet started
Package

ArcticAtmosphere.component

Newest version

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

README.md

ArcticAtmosphere

Turns on the tundra's sky, northern lights, weather and sound in one component. Add ONE to any entity of a scene:

entity.spawn("ArcticAtmosphere").component.add("arcticKit.ArcticAtmosphere", { time = "night", aurora = "curtains", weather = "clear" })

Fields (all synced): time (morning, noon, dusk, night), aurora (curtains, storm, crown, quietArc, off), weather (clear, groundBlow, whiteout, diamondDust, iceFog, blizzard), soundVolume (0 to 2), holdTime (hold the clock at the chosen time), dayLengthMinutes (for a clock it creates). Methods: setTime, setAurora, setWeather, report.

It needs worldClockKit's WorldClock for the shared hour and weather. With none in the scene it creates one (temporary, synced, made by the session's host, skyMode = "off", 30 minute day); an existing clock is set to skyMode = "off" because arcticKit draws the polar sky itself (a ProceduralSky in the scene is left in place). For the aurora to reach every player put the entity in the scene or spawn it synced; it is also broadcast to every peer when it changes.