mods/ENVIRONMENT/mcl_weather/weather_core.lua

   1 -- weather states, 'none' is default, other states depends from active mods
   2 mcl_weather.state = "none"
   3
   4 -- player list for saving player meta info
   5 mcl_weather.players = {}
   6
   7 -- default weather recalculation interval
   8 mcl_weather.check_interval = 300
   9
  10 -- weather min duration
  11 mcl_weather.min_duration = 600
  12
  13 -- weather max duration
  14 mcl_weather.max_duration = 9000
  15
  16 -- weather calculated end time
  17 mcl_weather.end_time = nil
  18
  19 -- registered weathers
  20 mcl_weather.reg_weathers = {}
  21
  22 -- global flag to disable/enable ABM logic.
  23 mcl_weather.allow_abm = true
  24
  25 mcl_weather.reg_weathers["none"] = {
  26   min_duration = mcl_weather.min_duration,
  27   max_duration = mcl_weather.max_duration,
  28   light_factor = nil,
  29   transitions = {
  30     [50] = "rain",
  31     [100] = "snow",
  32   },
  33   clear = function() end,
  34 }
  35
  36 local storage = minetest.get_mod_storage()
  37 -- Save weather into mod storage, so it can be loaded after restarting the server
  38 local save_weather = function()
  39         storage:set_string("mcl_weather_state", mcl_weather.state)
  40         storage:set_int("mcl_weather_end_time", mcl_weather.end_time)
  41         minetest.log("verbose", "[mcl_weather] Weather data saved: state="..mcl_weather.state.." end_time="..mcl_weather.end_time)
  42 end
  43 minetest.register_on_shutdown(save_weather)
  44
  45 mcl_weather.get_rand_end_time = function(min_duration, max_duration)
  46   local r
  47   if min_duration ~= nil and max_duration ~= nil then
  48     r = math.random(min_duration, max_duration);
  49   else
  50     r = math.random(mcl_weather.min_duration, mcl_weather.max_duration);
  51   end
  52   return minetest.get_gametime() + r
  53 end
  54
  55 mcl_weather.get_current_light_factor = function()
  56   if mcl_weather.state == "none" then
  57     return nil
  58   else
  59     return mcl_weather.reg_weathers[mcl_weather.state].light_factor
  60   end
  61 end
  62
  63 -- Returns true if pos is outdoor.
  64 -- Outdoor is defined as any node in the Overworld under open sky.
  65 -- FIXME: Nodes below glass also count as “outdoor”, this should not be the case.
  66 mcl_weather.is_outdoor = function(pos)
  67   local cpos = {x=pos.x, y=pos.y+1, z=pos.z}
  68   local dim = mcl_worlds.pos_to_dimension(cpos)
  69   if minetest.get_node_light(cpos, 0.5) == 15 and dim == "overworld" then
  70     return true
  71   end
  72   return false
  73 end
  74
  75 -- checks if player is undewater. This is needed in order to
  76 -- turn off weather particles generation.
  77 mcl_weather.is_underwater = function(player)
  78     local ppos = player:get_pos()
  79     local offset = player:get_eye_offset()
  80     local player_eye_pos = {x = ppos.x + offset.x,
  81                             y = ppos.y + offset.y + 1.5,
  82                             z = ppos.z + offset.z}
  83     local node_level = minetest.get_node_level(player_eye_pos)
  84     if node_level == 8 or node_level == 7 then
  85       return true
  86     end
  87     return false
  88 end
  89
  90 -- trying to locate position for particles by player look direction for performance reason.
  91 -- it is costly to generate many particles around player so goal is focus mainly on front view.
  92 mcl_weather.get_random_pos_by_player_look_dir = function(player)
  93   local look_dir = player:get_look_dir()
  94   local player_pos = player:get_pos()
  95
  96   local random_pos_x = 0
  97   local random_pos_y = 0
  98   local random_pos_z = 0
  99
 100   if look_dir.x > 0 then
 101     if look_dir.z > 0 then
 102       random_pos_x = math.random() + math.random(player_pos.x - 2.5, player_pos.x + 5)
 103       random_pos_z = math.random() + math.random(player_pos.z - 2.5, player_pos.z + 5)
 104     else
 105       random_pos_x = math.random() + math.random(player_pos.x - 2.5, player_pos.x + 5)
 106       random_pos_z = math.random() + math.random(player_pos.z - 5, player_pos.z + 2.5)
 107     end
 108   else
 109     if look_dir.z > 0 then
 110       random_pos_x = math.random() + math.random(player_pos.x - 5, player_pos.x + 2.5)
 111       random_pos_z = math.random() + math.random(player_pos.z - 2.5, player_pos.z + 5)
 112     else
 113       random_pos_x = math.random() + math.random(player_pos.x - 5, player_pos.x + 2.5)
 114       random_pos_z = math.random() + math.random(player_pos.z - 5, player_pos.z + 2.5)
 115     end
 116   end
 117
 118   random_pos_y = math.random() + math.random(player_pos.y + 1, player_pos.y + 3)
 119   return random_pos_x, random_pos_y, random_pos_z
 120 end
 121
 122 minetest.register_globalstep(function(dtime)
 123   if mcl_weather.end_time == nil then
 124     mcl_weather.end_time = mcl_weather.get_rand_end_time()
 125   end
 126   -- recalculate weather
 127   if mcl_weather.end_time <= minetest.get_gametime() then
 128     local changeWeather = minetest.settings:get_bool("mcl_doWeatherCycle")
 129     if changeWeather == nil then
 130         changeWeather = true
 131     end
 132     if changeWeather then
 133        mcl_weather.set_random_weather(mcl_weather.state, mcl_weather.reg_weathers[mcl_weather.state])
 134     else
 135        mcl_weather.end_time = mcl_weather.get_rand_end_time()
 136     end
 137   end
 138 end)
 139
 140 -- Sets random weather (which could be 'none' (no weather)).
 141 mcl_weather.set_random_weather = function(weather_name, weather_meta)
 142   if (weather_meta ~= nil) then
 143     local transitions = weather_meta.transitions
 144     local random_roll = math.random(0,100)
 145     local new_weather
 146     for v, weather in pairs(transitions) do
 147       if random_roll < v then
 148         new_weather = weather
 149         break
 150       end
 151     end
 152     if new_weather then
 153       mcl_weather.change_weather(new_weather)
 154     end
 155   end
 156 end
 157
 158 -- Change weather to new_weather.
 159 -- * explicit_end_time is OPTIONAL. If specified, explicitly set the
 160 --   gametime (minetest.get_gametime) in which the weather ends.
 161 mcl_weather.change_weather = function(new_weather, explicit_end_time)
 162   if (mcl_weather.reg_weathers ~= nil and mcl_weather.reg_weathers[new_weather] ~= nil) then
 163     if (mcl_weather.state ~= nil and mcl_weather.reg_weathers[mcl_weather.state] ~= nil) then
 164       mcl_weather.reg_weathers[mcl_weather.state].clear()
 165     end
 166     mcl_weather.state = new_weather
 167     local weather_meta = mcl_weather.reg_weathers[mcl_weather.state]
 168     if explicit_end_time then
 169         mcl_weather.end_time = explicit_end_time
 170     else
 171         mcl_weather.end_time = mcl_weather.get_rand_end_time(weather_meta.min_duration, weather_meta.max_duration)
 172     end
 173     mcl_weather.skycolor.update_sky_color()
 174     save_weather()
 175     return true
 176   end
 177   return false
 178 end
 179
 180 mcl_weather.get_weather = function()
 181   return mcl_weather.state
 182 end
 183
 184 minetest.register_privilege("weather_manager", {
 185   description = "Gives ability to control weather",
 186   give_to_singleplayer = false
 187 })
 188
 189 -- Weather command definition. Set
 190 minetest.register_chatcommand("weather", {
 191   params = "(clear | rain | snow | thunder) [<duration>]",
 192   description = "Changes the weather to the specified parameter.",
 193   privs = {weather_manager = true},
 194   func = function(name, param)
 195     if (param == "") then
 196       return false, "Error: No weather specified."
 197     end
 198     local new_weather, end_time
 199     local parse1, parse2 = string.match(param, "(%w+) ?(%d*)")
 200     if parse1 then
 201       if parse1 == "clear" then
 202           new_weather = "none"
 203       else
 204           new_weather = parse1
 205       end
 206     else
 207       return false, "Error: Invalid parameters."
 208     end
 209     if parse2 then
 210       if type(tonumber(parse2)) == "number" then
 211           local duration = tonumber(parse2)
 212           if duration < 1 then
 213               return false, "Error: Duration can't be less than 1 second."
 214           end
 215           end_time = minetest.get_gametime() + duration
 216       end
 217     end
 218
 219     local success = mcl_weather.change_weather(new_weather, end_time)
 220     if success then
 221       return true
 222     else
 223       return false, "Error: Invalid weather specified. Use “clear”, “rain”, “snow” or “thunder”."
 224     end
 225   end
 226 })
 227
 228 minetest.register_chatcommand("toggledownfall", {
 229   params = "",
 230   description = "Toggles between clear weather and weather with downfall (randomly rain, thunderstorm or snow)",
 231   privs = {weather_manager = true},
 232   func = function(name, param)
 233     -- Currently rain/thunder/snow: Set weather to clear
 234     if mcl_weather.state ~= "none" then
 235        return mcl_weather.change_weather("none")
 236
 237     -- Currently clear: Set weather randomly to rain/thunder/snow
 238     else
 239        local new = { "rain", "thunder", "snow" }
 240        local r = math.random(1, #new)
 241        return mcl_weather.change_weather(new[r])
 242     end
 243   end
 244 })
 245
 246 -- Configuration setting which allows user to disable ABM for weathers (if they use it).
 247 -- Weather mods expected to be use this flag before registering ABM.
 248 local weather_allow_abm = minetest.settings:get_bool("weather_allow_abm")
 249 if weather_allow_abm ~= nil and weather_allow_abm == false then
 250   mcl_weather.allow_abm = false
 251 end
 252
 253
 254 local load_weather = function()
 255         local weather = storage:get_string("mcl_weather_state")
 256         if weather and weather ~= "" then
 257                 mcl_weather.state = weather
 258                 mcl_weather.end_time = storage:get_int("mcl_weather_end_time")
 259                 mcl_weather.change_weather(weather, mcl_weather.end_time)
 260                 if type(mcl_weather.end_time) ~= "number" then
 261                         -- Fallback in case of corrupted end time
 262                         mcl_weather.end_time = mcl_weather.min_duration
 263                 end
 264                 minetest.log("action", "[mcl_weather] Weather restored.")
 265         else
 266                 minetest.log("action", "[mcl_weather] No weather data found. Starting with clear weather.")
 267         end
 268 end
 269
 270 load_weather()