moodKitBridges.package
README.md
moodKitBridges — plug moodKit into the kits your world has
moodKit gives each level its own time of day, weather and lighting mood, per player, and names no other kit, so it installs on its own and runs on the engine's sky, sun, fog and grade. These bridges hand each mood to the kits a world already has, so a mood also moves worldClockKit's hour and weather, alpineKit's grade and haze and the toon ramp of a styleKit stack — on this machine only.
| component | kit | what a mood does through it |
|---|---|---|
ClockBridge | worldClockKit | this machine's hour (Clock.setLocal), weather — falling rain, snow, storm with lightning, fog (Weather.setLocal) — and sky look (Sky.setLocal); while a WorldClock runs, its director paints the sun, sky and fog |
AlpineBridge | alpineKit | colour grade, valley haze, painted sky gradient and snow deck (Atmos.setMood) while an AlpineAtmosphere runs |
StyleBridge | styleKit (toonBlocks, inkBlocks) | keeps the stack LevelMoods' data names on the scene, and lays each mood's toon ramp, ink and paper on it per machine (StyleKit.setLocal) |
PlatformerBridge | platformer3dKit | tells LevelMoods which level the local player is running |
CampaignBridge | campaignKit | keeps a level's mood through its send-off, results and finale |
Put the ones you need on the same entity as moodKit.LevelMoods (or anywhere in the scene):
local e = entity.spawn("LevelMood")
e.component.add("moodKit.LevelMoods", { set = asset.resolve("myGame.levelMoods", "data") })
e.component.add("moodKitBridges.ClockBridge", {})
e.component.add("moodKitBridges.StyleBridge", {})
e.component.add("moodKitBridges.PlatformerBridge", {})
Install only the bridges whose kits you have: each component installs on its own with the kit it
names. The per-machine setters (Clock/Weather/Sky.setLocal, Atmos.setMood, StyleKit.setLocal)
arrived in worldClockKit 1.4.8, alpineKit 1.0.12 and styleKit 1.4.9; on an older kit the bridge
says so once and the shared clock and look stay as they are.