Upload

lua/stormfox2/lib/sh_weather_meta.lua

@@ -0,0 +1,287 @@
+--[[
+| This file was obtained through the combined efforts
+| of Madbluntz & Plymouth Antiquarian Society.
+|
+| Credits: lifestorm, Gregory Wayne Rossel JR.,
+| 	Maloy, DrPepper10 @ RIP, Atle!
+|
+| Visit for more: https://plymouth.thetwilightzone.ru/
+--]]
+
+
+StormFox2.Weather = {}
+local Weathers = {}
+-- Diffrent stamps on where the sun are. (Remember, SF2 goes after sunrise/set)
+---@class SF_SKY_STAMP : number
+	SF_SKY_DAY = 0
+	SF_SKY_SUNRISE = 1
+	SF_SKY_SUNSET = 2
+	SF_SKY_CEVIL = 3
+	SF_SKY_BLUE_HOUR = 4
+	SF_SKY_NAUTICAL = 5
+	SF_SKY_ASTRONOMICAL = 6
+	SF_SKY_NIGHT = 7
+
+---@class SF2_WeatherType
+local w_meta = {}
+w_meta.__index = w_meta
+w_meta.__tostring = function(self) return "SF_WeatherType[" .. (self.Name or "Unknwon") .. "]" end
+w_meta.MetaName = "SF-Weather"
+debug.getregistry()["SFWeather"] = w_meta
+
+-- function for the generator. Returns true to allow. Function will be called with (day_temperature, time_start, time_duration, percent) 
+---@deprecated
+---@param fFunc function
+---@shared
+function w_meta:SetRequire(fFunc)
+	self.Require = fFunc
+end
+
+---Runs said function when the weather is applied.
+---@param fFunc function
+---@shared
+function w_meta:SetInit(fFunc)
+	self.Init = fFunc
+end
+
+---Runs said function if the weather-amount change.
+---@param fFunc function
+---@deprecated
+---@shared
+function w_meta:SetOnChange(fFunc)
+	self.OnChange = fFunc
+end
+
+---Will always return true
+---@return boolean
+---@shared
+function w_meta:IsValid()
+	return true
+end
+
+---Creates and returns a new weather-type. Will not duplicate weather-types and instead return the one created before.
+---@param sName string
+---@param sInherit? string
+---@return SF2_WeatherType
+---@shared
+function StormFox2.Weather.Add( sName, sInherit )
+	if Weathers[sName] then return Weathers[sName] end
+	local t = {}
+	t.ID = table.Count(Weathers) + 1
+	t.Name = sName
+	setmetatable(t, w_meta)
+	if sName ~= "Clear" then -- Clear shouldn't inherit itself
+		t.Inherit = sInherit or "Clear"
+	end
+	Weathers[sName] = t
+	t.Function = {}
+	t.Static = {}
+	t.Dynamic = {}
+	t.SunStamp = {}
+	return t
+end
+
+---Returns a weather-type by name.
+---@param sName string
+---@return SF2_WeatherType
+---@shared
+function StormFox2.Weather.Get( sName )
+	return Weathers[sName]
+end
+
+---Returns a list of all weather-types name.
+---@return table
+---@shared
+function StormFox2.Weather.GetAll()
+	return table.GetKeys( Weathers )
+end
+
+---Returns all weathers that can be spawned.
+---@deprecated
+---@return table
+---@shared
+function StormFox2.Weather.GetAllSpawnable()
+	local t = {}
+	for w, v in pairs( Weathers ) do
+		if v.spawnable and w ~= "Clear" then -- clear is default
+			table.insert(t, w)
+		end
+	end
+	return t
+end
+
+local keys = {}
+local l_e,l_c, c_c = -1,0
+
+---Sets a key-value.
+---@param sKey string
+---@param zVariable any|function
+---@param bStatic boolean
+---@shared
+function w_meta:Set(sKey,zVariable, bStatic)
+	keys[sKey] = true
+	l_c = CurTime()
+	if type(zVariable) == "function" then
+		self.Function[sKey] = zVariable
+	elseif bStatic then
+		self.Static[sKey] = zVariable
+	else
+		self.Dynamic[sKey] = zVariable
+	end
+end
+
+local r_list = {"Terrain", "windRender", "windRenderRef", "windRender64", "windRenderRef64"}
+---Returns all keys a weather has.
+---@return table
+---@shared
+function StormFox2.Weather.GetKeys()
+	if l_c == l_e then
+		return c_c
+	end
+	for k,v in ipairs(r_list) do
+		keys[v] = nil
+	end
+	l_e = l_c
+	c_c = table.GetKeys(keys)
+	return c_c
+end
+
+--- This function inserts a variable into a table. Using the STAMP as key.
+---@param sKey string
+---@param zVariable any
+---@param stamp SF_SKY_STAMP
+---@shared
+function w_meta:SetSunStamp(sKey, zVariable, stamp)
+	keys[sKey] = true
+	l_c = CurTime()
+	if not self.SunStamp[sKey] then self.SunStamp[sKey] = {} end
+	self.SunStamp[sKey][stamp] = zVariable
+end
+
+--- Returns a copy of all variables with the given sunstamp, to another given sunstamp.
+---@param from_STAMP SF_SKY_STAMP
+---@param to_STAMP SF_SKY_STAMP
+---@shared
+function w_meta:CopySunStamp( from_STAMP, to_STAMP )
+	for sKey,v in pairs(self.SunStamp) do
+		if type(v) ~= "table" then continue end
+		if not v[from_STAMP] then continue end
+		self.SunStamp[sKey][to_STAMP] = v[from_STAMP] or nil
+	end
+end
+
+do
+	local in_list = {}
+
+	---Returns a variable. If the variable is a function, it will be called with the current stamp.
+	---Second argument will tell SF it is static and shouldn't be mixed
+	---@param sKey string
+	---@param SUNSTAMP SF_SKY_STAMP
+	---@return any
+	---@return boolean isStatic
+	---@shared
+	function w_meta:Get(sKey, SUNSTAMP )
+		-- Fallback to day-stamp, if Last Steamp is nil-
+		if not SUNSTAMP then
+			SUNSTAMP = StormFox2.Sky.GetLastStamp() or SF_SKY_DAY
+		end
+		if self.Function[sKey] then
+			return self.Function[sKey]( SUNSTAMP )
+		elseif self.SunStamp[sKey] then
+			if self.SunStamp[sKey][SUNSTAMP] ~= nil then
+				return self.SunStamp[sKey][SUNSTAMP]
+			end
+			-- This sunstamp isn't set, try and elevate stamp and check
+			if SUNSTAMP >= SF_SKY_CEVIL then
+				for i = SF_SKY_CEVIL + 1, SF_SKY_NIGHT do
+					if self.SunStamp[sKey][i] then
+						return self.SunStamp[sKey][i]
+					end
+				end
+			else
+				for i = SF_SKY_CEVIL - 1, SF_SKY_DAY, -1 do
+					if self.SunStamp[sKey][i] then
+						return self.SunStamp[sKey][i]
+					end
+				end
+			end
+		elseif self.Static[sKey] then
+			return self.Static[sKey], true
+		elseif self.Dynamic[sKey] then
+			return self.Dynamic[sKey]
+		end
+		if self.Name == "Clear" then return end
+		-- Check if we inherit
+		if not self.Inherit then return nil end
+		if not Weathers[self.Inherit] then return nil end -- Inherit is invalid
+		if in_list[self.Inherit] == true then -- Loop detected
+			StormFox2.Warning("WeatherData loop detected! multiple occurences of : " .. self.Inherit)
+			return
+		end
+		in_list[self.Name] = true
+		local a,b,c,d,e = Weathers[self.Inherit]:Get(sKey, SUNSTAMP)
+		in_list = {}
+		return a,b,c,d,e
+	end
+end
+
+---Sets the terrain for the weather. This can also be a function that returns a terrain object.
+---@param zTerrain SF2Terrain|function
+---@shared
+function w_meta:SetTerrain( zTerrain )
+	self:Set( "Terrain", zTerrain )
+end
+
+---A function that renders a window-texure
+---@param fFunc function
+---@shared
+function w_meta:RenderWindow( fFunc )
+	self._RenderWindow = fFunc
+end
+
+---A function that renders a window-texure
+---@param fFunc function
+---@shared
+function w_meta:RenderWindowRefract( fFunc )
+	self._RenderWindowRefract = fFunc
+end
+
+---A function that renders a window-texure
+---@param fFunc function
+---@shared
+function w_meta:RenderWindow64x64( fFunc )
+	self._RenderWindow64x64 = fFunc
+end
+
+---A function that renders a window-texure
+---@param fFunc function
+---@shared
+function w_meta:RenderWindowRefract64x64( fFunc )
+	self._RenderWindowRefract64x64 = fFunc
+end
+
+---Returns the "lightlevel" of the skybox in a range of 0-255.
+---@return number
+---@shared
+function StormFox2.Weather.GetLuminance()
+	local Col = StormFox2.Mixer.Get("bottomColor") or Color(255,255,255)
+	return 0.2126 * Col.r + 0.7152 * Col.g + 0.0722 * Col.b
+end
+
+-- Load the weathers once lib is done.
+hook.Add("stormfox2.postlib", "stormfox2.loadweathers", function()
+	StormFox2.Setting.AddSV("weather_damage",true,nil, "Weather")
+
+
+	StormFox2.Setting.AddSV("moonsize",20,nil,"Effects", 5, 500)
+
+	hook.Run("stormfox2.preloadweather", w_meta)
+	for _,fil in ipairs(file.Find("stormfox2/weathers/*.lua","LUA")) do
+		local succ = pcall(include,"stormfox2/weathers/" .. fil)
+		if SERVER and succ then
+			AddCSLuaFile("stormfox2/weathers/" .. fil)
+		end
+	end
+	StormFox2.Weather.Loaded = true
+	hook.Run("stormfox2.postloadweather")
+end)