DML/modules/countDown.lua

countDown = {}
countDown.version = "2.0.0"
countDown.verbose = false 
countDown.ups = 1 
countDown.requiredLibs = {
	"dcsCommon", -- always
	"cfxZones", -- Zones, of course 
}

--[[--
	count down on flags to generate new signal on out 
	Copyright (c) 2022 - 2024 by Christian Franz and cf/x AG
	
	Version History
	2.0.0 - dmlZones, OOP upgrade 
	        counterOut! --> counterOut#
			output method defaults to "inc"
			better config parsing 
			cleanup 
--]]--

countDown.counters = {}
countDown.callbacks = {}

--
-- add/remove zones
--
function countDown.addCountDown(theZone)
	table.insert(countDown.counters, theZone)
end

function countDown.getCountDownZoneByName(aName) 
	for idx, aZone in pairs(countDown.counters) do 
		if aName == aZone.name then return aZone end 
	end
	if countDown.verbose then 
		trigger.action.outText("+++cntD: no count down with name <" .. aName ..">", 30)
	end 
	
	return nil 
end

--
-- callbacks 
--
function countDown.addCallback(theCallback)
	if not theCallback then return end 
	table.insert(countDown.callbacks, theCallback)
end

function countDown.invokeCallbacks(theZone, val, tminus, zero, belowZero, looping)
	if not val then val = 1 end 
	if not tminus then tminus = false end 
	if not zero then zero = false end 
	if not belowZero then belowZero = false end 
	
	-- invoke anyone who wants to know that a group 
	-- of people was rescued.
	for idx, cb in pairs(countDown.callbacks) do 
		cb(theZone, val, tminus, zero, belowZero, looping)
	end
end
--
-- read attributes
--
function countDown.createCountDownWithZone(theZone)
	-- start val - a range
	theZone.startMinVal, theZone.startMaxVal = theZone:getPositiveRangeFromZoneProperty("countDown", 1) -- we know this exists
	theZone.currVal = dcsCommon.randomBetween(theZone.startMinVal, theZone.startMaxVal)
	
	if countDown.verbose then 
		trigger.action.outText("+++cntD: initing count down <" .. theZone.name .. "> with " .. theZone.currVal, 30)
	end
	
	-- loop 
	theZone.loop = theZone:getBoolFromZoneProperty("loop", false)

	-- extend after zero
	theZone.belowZero = theZone:getBoolFromZoneProperty("belowZero", false)
	
	-- out method 
	theZone.ctdwnMethod = theZone:getStringFromZoneProperty("method", "inc")
	if theZone:hasProperty("ctdwnMethod") then 
		theZone.ctdwnMethod = theZone:getStringFromZoneProperty( "ctdwnMethod", "inc")
	end
	
	-- triggerMethod for inputs
	theZone.ctdwnTriggerMethod = theZone:getStringFromZoneProperty( "triggerMethod", "change")

	if theZone:hasProperty("ctdwnTriggerMethod") then 
		theZone.ctdwnTriggerMethod = theZone:getStringFromZoneProperty("ctdwnTriggerMethod", "change")
	end
	
	-- trigger flag "count" / "start?"
	if theZone:hasProperty("count?") then 
		theZone.triggerCountFlag = theZone:getStringFromZoneProperty("count?", "<none>")
	elseif theZone:hasProperty("clock?") then 
		theZone.triggerCountFlag = theZone:getStringFromZoneProperty("clock?", "<none>")
	-- can also use in? for counting. we always use triggerCountFlag 
	elseif theZone:hasProperty("in?") then 
		theZone.triggerCountFlag = theZone:getStringFromZoneProperty("in?", "<none>")
	end
	
	if theZone.triggerCountFlag then 
		theZone.lastCountTriggerValue = cfxZones.getFlagValue(theZone.triggerCountFlag, theZone) 
	end
	
	-- reset 
	if theZone:hasProperty("reset?") then 
		theZone.resetFlag = theZone:getStringFromZoneProperty("reset?", "<none>")
		theZone.resetFlagValue = cfxZones.getFlagValue(theZone.resetFlag, theZone)
	end
	
	-- zero! bang 
	if theZone:hasProperty("zero!") then 
		theZone.zeroFlag = theZone:getStringFromZoneProperty("zero!", "<none>")
	end
	
	if theZone:hasProperty("out!") then 
		theZone.zeroFlag = theZone:getStringFromZoneProperty("out!", "<none>")
	end
	
	-- TMinus! bang 
	if theZone:hasProperty("tMinus!") then 
		theZone.tMinusFlag = theZone:getStringFromZoneProperty("tMinus!", "<none>")
	end
	
	-- counterOut val 
	if theZone:hasProperty("counterOut#") then 
		theZone.counterOut = theZone:getStringFromZoneProperty( "counterOut#", "<none>")
	end
	
	-- disableFlag/enableFlag 
	theZone.counterDisabled = false 
	if theZone:hasProperty("disableCounter?") then 
		theZone.disableCounterFlag = theZone:getStringFromZoneProperty("disableCounter?", "<none>")
		theZone.disableCounterFlagVal = theZone:getFlagValue(theZone.disableCounterFlag)
	end
	
	if theZone:hasProperty("enableCounter?") then 
		theZone.enableCounterFlag = theZone:getStringFromZoneProperty("enableCounter?", "<none>")
		theZone.enableCounterFlagVal = theZone:getFlagValue(theZone.enableCounterFlag)
	end
	
end

--
-- Update 
--
function countDown.reset(theZone)
	local val = dcsCommon.randomBetween(theZone.startMinVal, theZone.startMaxVal)
	if countDown.verbose or theZone.verbose then 
		trigger.action.outText("+++cntD: resetting <" .. theZone.name .. "> to (" .. val .. ")", 30)
	end
	
	theZone.currVal = val 
	if theZone.counterOut then 
		cfxZones.setFlagValue(theZone.counterOut, val, theZone)
	end
	-- read and ignore any pulling of the clock flag 
	local ignore = theZone:testZoneFlag(theZone.triggerCountFlag, theZone.ctdwnTriggerMethod, "lastCountTriggerValue")
	-- simply updates lastTriggerValue to current clock value 
end

function countDown.isTriggered(theZone)
	-- this module has triggered 
	local val = theZone.currVal - 1 -- decrease counter 
	if countDown.verbose or theZone.verbose then 
		trigger.action.outText("+++cntD: enter triggered: val now: " .. val, 30)
	end
	local tMinus = false 
	local zero = false 
	local belowZero = false 
	local looping = false 
	
	if theZone.counterOut then 
		theZone:setFlagValue(theZone.counterOut, val)
	end
	
	if val > 0 then 
		tMinus = true 
		-- see if we need to bang Tminus 
		if theZone.tMinusFlag then 
			if countDown.verbose or theZone.verbose then 
				trigger.action.outText("+++cntD: <" .. theZone.name .. "> TMINUTS on flag <" .. theZone.tMinusFlag .. ">", 30)
			end
			theZone:pollFlag(theZone.tMinusFlag, theZone.ctdwnMethod)
		end
		
	elseif val == 0 then 
		-- reached zero 
		zero = true 
		if theZone.zeroFlag then 
			if countDown.verbose or theZone.verbose then 
				trigger.action.outText("+++cntD: ZERO <" .. theZone.name .. "> on flag <" .. theZone.zeroFlag .. ">", 30)
			end
			theZone:pollFlag(theZone.zeroFlag, theZone.ctdwnMethod)
		end
		
		if theZone.loop then 
			-- restart time
			looping = true 
			val = dcsCommon.randomBetween(theZone.startMinVal, theZone.startMaxVal)
			if countDown.verbose or theZone.verbose then 
				trigger.action.outText("+++cntD: Looping <" .. theZone.name .. ">, start val is (" .. val .. ")", 30)
			end
		end 
		
	else 
		-- below zero
		belowZero = true 
		if theZone.belowZero and theZone.zeroFlag then
			if countDown.verbose or theZone.verbose then 
				trigger.action.outText("+++cntD: Below Zero", 30)
			end
			theZone:pollFlag(theZone.zeroFlag, theZone.ctdwnMethod)
		end 
		
	end
	
	-- callbacks 
	countDown.invokeCallbacks(theZone, val, tMinus, zero, belowZero, looping)
	
	-- update & return 
	theZone.currVal = val 
end

function countDown.update()
	-- call me in a second/ups to poll triggers
	timer.scheduleFunction(countDown.update, {}, timer.getTime() + 1/countDown.ups)
		
	for idx, aZone in pairs(countDown.counters) do
		if aZone.resetFlag then 
			if aZone:testZoneFlag(aZone.resetFlag, aZone.ctdwnTriggerMethod, "resetFlagValue") then 
				-- reset pulled, reset the timer to start condition
				countDown.reset(aZone)
			end
		end
		
		-- make sure to re-start before reading time limit
		-- if reset, lastTriggerValue is updated and will not trigger
		if (not aZone.counterDisabled) and 
		   aZone:testZoneFlag(aZone.triggerCountFlag, aZone.ctdwnTriggerMethod, "lastCountTriggerValue") 
		then
			if countDown.verbose then 
				trigger.action.outText("+++cntD: triggered on in?", 30)
			end
			countDown.isTriggered(aZone)
		end
		
		if aZone:testZoneFlag(aZone.disableCounterFlag, aZone.ctdwnTriggerMethod, "disableCounterFlagVal") then
			if countDown.verbose then 
				trigger.action.outText("+++cntD: disabling counter " .. aZone.name, 30)
			end
			aZone.counterDisabled = true 
		end
		
		if aZone:testZoneFlag(aZone.enableCounterFlag, aZone.ctdwnTriggerMethod, "enableCounterFlagVal") then
			if countDown.verbose then 
				trigger.action.outText("+++cntD: ENabling counter " .. aZone.name, 30)
			end
			aZone.counterDisabled = false 
		end
	end
end

--
-- Config & Start
--
function countDown.readConfigZone()
	local theZone = cfxZones.getZoneByName("countDownConfig") 
	if not theZone then 
		theZone = cfxZones.createSimpleZone("countDownConfig")
	end 
	
	countDown.ups = theZone:getNumberFromZoneProperty("ups", 1)
	if countDown.ups < 0.001 then countDown.ups = 0.001 end 
	
	countDown.verbose = theZone.verbose 
	
	if countDown.verbose then 
		trigger.action.outText("+++cntD: read config", 30)
	end 
end

function countDown.start()
	-- lib check
	if not dcsCommon.libCheck then 
		trigger.action.outText("cfx Count Down requires dcsCommon", 30)
		return false 
	end 
	if not dcsCommon.libCheck("cfx Count Down", countDown.requiredLibs) then
		return false 
	end
	
	-- read config 
	countDown.readConfigZone()
	
	-- process cloner Zones 
	local attrZones = cfxZones.getZonesWithAttributeNamed("countDown")
	for k, aZone in pairs(attrZones) do 
		countDown.createCountDownWithZone(aZone) -- process attributes
		countDown.addCountDown(aZone) -- add to list
	end
	
	-- start update 
	countDown.update()
	
	trigger.action.outText("cfx Count Down v" .. countDown.version .. " started.", 30)
	return true 
end

-- let's go!
if not countDown.start() then 
	trigger.action.outText("cfx Count Down aborted: missing libraries", 30)
	countDown = nil 
end

-- additions: range for start value to randomize