updates

docs/dev.md

@@ -127,7 +127,7 @@ Present if `weather.is_loaded` is set to `true`.
 - `weather.players_weather` A table of player weather data, index with player name.
 - `weather.weathers` All registered weather definitions.
 - `weather.default_on_change(player, name, players_weather)` Default `on_change` call back, called between every change to try to clean up.
-- `weather.register_weather(def)` Regsiter a `Weather Definition`. Note: If a on_change sets a sound it must store the handle for it in `players_weather.sound_handle` before returning. Also this function should NOT modify things that are not restored in `weather.default_on_change` (See source code.)
+- `weather.register_weather(def)` Regsiter a `Weather Definition`. Note: If a on_change sets a sound it must store the handle for it in `players_weather.sound_handle` before returning. This should not modify sky paramiters other than using: `player:set_sun()`, `player:set_clouds()`, `player:set_sky()` and `player:set_lighting()`. For more info see `on_change` usage down further.
 - `weather.get_weather_at_pos(pos)` Return the index to weather in `weather.weathers` that matches the current global weather and local weather.
 - `weather.weather_hight` Hight of spawning for weather particles.
 
@@ -143,6 +143,7 @@ Present if `weather.is_loaded` is set to `true`.
         },
         on_change = function(player, players_weather) end, -- Code can only modify things that will be restored in weather.default_on_change or sounds.
         on_step = function(player), -- Code that is run once per weather step (1 second)
+        on_end = function(player, name, players_weather), -- Code run at end defaults to weather.default_on_change if not used, otherwise you must undo ALL changes made in on_change
         particlespawner = 
         {
             amount = 500,
@@ -181,6 +182,15 @@ Present if `weather.is_loaded` is set to `true`.
 ```
 
 
+### `on_change(player, name, players_weather)`
+
+This call back is called once per weather change after the defaults are reset. This function can set sounds but the sounds must be stored in `players_weather.sound_handle`. Anything changed here, excluding sounds, must be reverted with `on_end(player, name, players_weather)` or if not present the defaults of `weather.default_on_change`. 
+
+### `the_weather.on_end(player, name, players_weather)`
+
+If `the_weather.on_end(player, name, players_weather)` is defined then all things changed in `on_change` MUST be reverted, this does not include the sound set with `players_weather.sound_handle` but all other things, as the default handler will not be run.
+
+
 
 
 # Development

mods/1042_weather/init.lua

@@ -33,7 +33,12 @@ core.register_globalstep(function(dtime)
             -- Only run if player changed weathers
             if players_weather.weather ~= the_weather then
                 -- Reset weather defaults
-                weather.default_on_change(player, name, players_weather)
+                if the_weather.on_end then
+                    the_weather.on_end(player, name, players_weather)
+                else
+                    weather.default_on_change(player, name, players_weather)
+                end
+
 
                 if players_weather.sound_handle then
                     core.sound_fade(players_weather.sound_handle, 0.25, 0)

mods/1042_weather/weathers_api.lua

@@ -22,6 +22,7 @@ end)
 
 
 
+-- Add default sky, clouds, lighting, sun AND add moon definitions so they can be re-used by mods. #fixme