DML/modules/duel.lua

duel = {}
duel.version = "1.1.0"
duel.verbose = false 
duel.requiredLibs = {
	"dcsCommon",
	"cfxZones",
	"cfxMX",
} 
--[[--
	Version History 
	1.0.0 - Initial Version
	1.0.1 - verbosity bug with SSB removed
	1.0.2 - units are reserved for player when they disappear 
	1.1.0 - maxRed and maxBlue per zone to be able to create 
	        1v1, 2v2, XvY duel zones 
			
--]]--

--[[--
	ATTENTION!
	- REQUIRES that SSB is running on the host
	- REQUIRTES that SSB is confgured that '0' (zero) means slot is enabled (this is SSB default)
	- REQUIRES MULTIPLAYER (kind of obvious...)
	- This script must run at MISSION START and will enable SSB 
	
--]]--

duel.duelZones = {}
duel.activePlayers = {} -- by player name 
duel.allDuelists = {} -- all potential dualists as collected from zones
-- 
-- reading attributes
--
function duel.createDuelZone(theZone)
	theZone.duelists = {} -- all player units in this zone 
	-- iterate all players and find any unit that is placed in this zone
	for unitName, unitData in pairs(cfxMX.playerUnitByName) do 
		local p = {}
		p.x = unitData.x 
		p.z = unitData.y -- !!
		p.y = 0 
		
		if theZone:pointInZone(p) then 
			-- this is a player aircraft in this zone 
			local duelist = {}
			duelist.data = unitData
			duelist.name = unitName
			duelist.type = unitData.type
			local groupData = cfxMX.playerUnit2Group[unitName]
			duelist.groupName = groupData.name 
			duelist.coa = cfxMX.groupCoalitionByName[duelist.groupName] 
			if duel.verbose or theZone.verbose then 
				trigger.action.outText("Detected player unit <" .. duelist.name .. ">, type <" .. duelist.type .. "> of group <" .. duelist.groupName .. "> of coa <" .. duelist.coa .. "> in zone <" .. theZone.name .. "> as duelist", 30)
			end 
			
			duelist.active = false 
			duelist.arena = theZone.name
			duelist.zone = theZone 
			
			-- enter into global table 
			-- player can only be in at maximum one duelist zones
			if duel.allDuelists[unitName] then 
				trigger.action.outText("+++WARNING: overlapping duelists for zone <" .. theZone.name .. ">! Overwriting previous data", 30)
			end
			duel.allDuelists[unitName] = duelist
			theZone.duelists[unitName] = duelist
		end
	end
	
	theZone.duelTriggerMethod = theZone:getStringFromZoneProperty("duelTriggerMethod", "change")
	if theZone:hasProperty("on?") then 
		theZone.duelOnFlag = theZone:getStringFromZoneProperty("on?", "*none")
		theZone.lastDuelOn = theZone:getFlagValue(theZone.duelOnFlag)
	end
	if theZone:hasProperty("off?") then 
		theZone.duelOffFlag = theZone:getStringFromZoneProperty("off?", "*none")
		theZone.lastDuelOff = theZone:getFlagValue(theZone.duelOffFlag)
	end
	theZone.onStart = theZone:getBoolFromZoneProperty("onStart", true)
	theZone.active = true 
	if not theZone.onStart then 
		theZone.active = false 
	end
	
	theZone.maxRed = theZone:getNumberFromZoneProperty("maxRed", 1)
	theZone.maxBlue = theZone:getNumberFromZoneProperty("maxBlue", 1)
end

--
-- Event processing 
--
function duel.closeSlotsForZoneAndCoaExceptGroupNamed(theZone, coa, groupName)
	-- iterate this zone's duelist groups and tell SSB to close them now
	local allDuelists = theZone.duelists 
	for unitName, theDuelist in pairs(allDuelists) do 
		local dgName = theDuelist.groupName 
		if (theDuelist.coa == coa) and (dgName ~= groupName) then 
			if duel.verbose then 
				trigger.action.outText("+++duel: closing SSB slot for group <" .. dgName .. ">, coa <" .. theDuelist.coa .. ">", 30)
			end
			trigger.action.setUserFlag(dgName,100) -- anything but 0 means closed 
		end
	end
end

function duel.closeSlotsForZoneAndCoaExceptActive(theZone, coa)
	-- iterate this zone's duelist groups and tell SSB to close them now
	local allDuelists = theZone.duelists 
	for unitName, theDuelist in pairs(allDuelists) do 
		local theUnit = Unit.getByName(unitName)
		if theUnit and Unit.isExist(theUnit) then 
			-- is unit exists already, do not close down
			if theZone.verbose or duel.verbose then 
				trigger.action.outText("+++duel: leaving unit <" .. unitName .. "> in game", 30)
			end
		else 
			-- this unit is not live, close group down
			local dgName = theDuelist.groupName 
			if (theDuelist.coa == coa) and (dgName ~= groupName) then 
				if duel.verbose or theZone.verbose then 
					trigger.action.outText("+++duel: closing SSB slot for group <" .. dgName .. ">, coa <" .. theDuelist.coa .. ">", 30)
				end
				trigger.action.setUserFlag(dgName,100) -- anything but 0 means closed 
			end
		end
	end
end

function duel.countActiveUnitsForCoaInZone(theZone, coa)
local allDuelists = theZone.duelists 
	local activeCount = 0
	for unitName, theDuelist in pairs(allDuelists) do 
		if theDuelist.coa == coa then 
			local theUnit = Unit.getByName(unitName)
			if theUnit and Unit.isExist(theUnit) then 
				activeCount = activeCount + 1
			end
		end
	end
	return activeCount
end

function duel.openSlotsForZoneAndCoa(theZone, coa)
	local allDuelists = theZone.duelists
	for unitName, theDuelist in pairs(allDuelists) do 
		if (theDuelist.coa == coa) then 
			if duel.verbose or theZone.verbose then 
				trigger.action.outText("+++duel: opening SSB slot for group <" .. theDuelist.groupName .. ">, coa <" .. theDuelist.coa .. ">", 30)
			end
			trigger.action.setUserFlag(theDuelist.groupName, 0) -- 0 means OPEN 
		end
	end	
end

function duel.checkReopenSlotsForZoneAndCoa(theZone, coa)
	-- test if one side can reopen all slots to enter the duel 
	-- 
	local maxForCoa = theZone.maxRed 
	if coa == 2 then maxForCoa = theZone.maxBlue end 
	local allDuelists = theZone.duelists
	local canReopen = true 
	local engageCount = 0 
	for unitName, theDuelist in pairs(allDuelists) do 
		if (theDuelist.coa == coa) then 
			local theUnit = Unit.getByName(unitName)
			if theUnit and Unit.isExist(theUnit) then 
				-- unit is still alive on this side 
				engageCount = engageCount + 1
			end
		end
	end
	if engageCount < maxForCoa then canReopen = true end 
	if canReopen then 
		if duel.verbose then 
			trigger.action.outText("+++duel: will open all slots for <" .. theZone:getName() .. ">, coa <" .. coa .. ">", 30)
		end
		duel.openSlotsForZoneAndCoa(theZone, coa)
	else 
		if duel.verbose then 
			trigger.action.outText("+++duel: unable to reopenslots for <" .. theZone:getName() .. ">, coa <" .. coa .. ">, " .. engageCount .. " units are still engaged", 30)
		end
	end
end

function duel.duelistEnteredArena(theUnit, theDuelist)
	-- we connect the player with duelist slot 
	theDuelist.playerName = theUnit:getPlayerName()
	theDuelist.active = true 
	
	local player = theUnit:getPlayerName()
	if not player then 
		trigger.action.outText("+++Duel: WARNING: no player name for unit <" .. theUnit:getName() .. "> upon enter arena", 30)
		return 
	end
	local unitName = theUnit:getName()
	local groupName = theDuelist.groupName
	local theZone = theDuelist.zone --duel.duelZones[theDuelist.arena]
	local coa = theDuelist.coa 
	
	if duel.verbose then 
		trigger.action.outText("Player <" .. player .. "> entered arena <" .. theZone:getName() .. "> in unit <" .. unitName .. "> of group <" .. groupName .. "> type <" .. theDuelist.type .. ">, belongs to coalition <" .. coa .. ">", 30)
	end
	
	-- remember this player should they go missing
	local playerData = {}
	playerData.playerName = player
	playerData.unitName = unitName
	playerData.lastSeen = timer.getTime()
	playerData.theZone = theZone 
	playerData.coa = coa 
	
	-- see if we are updating an existing player. 
	-- this will require a cleanup of the last time they 
	-- were here 
	if duel.activePlayers[player] then 
		-- we need to update slots and flags if player has chosen a 
		-- different unit 
		local lastData = duel.activePlayers[player] 
		if lastData.unitName ~= unitName then 
			if duel.verbose then 
				trigger.action.outText("Duel: player changed slots. Cleaning up", 30)
			end 
			duel.checkReopenSlotsForZoneAndCoa(lastData.theZone, lastData.coa)
		else 
			if duel.verbose then 
				trigger.action.outText("Duel: player re-slotted, no update required", 30)
			end 
		end
	end
	duel.activePlayers[player] = playerData

	-- close all slots for this zone and coalition if it is active
	-- and we have reched the maximum of players for that coalition
	local maxForCoa = theZone.maxRed 
	if coa == 2 then maxForCoa = theZone.maxBlue end 
	local activeInZone = duel.countActiveUnitsForCoaInZone(theZone, coa)
	if theZone.active then
		if(activeInZone >= maxForCoa) then 
			if theZone.verbose or duel.verbose then 
				trigger.action.outText("+++duel: zone <" .. theZone:getName() .. ">, closing coa <" .. coa .. "> slots except for player's <" .. player .. "> group <" .. groupName .. ">", 30)
			end
			--duel.closeSlotsForZoneAndCoaExceptGroupNamed(theZone, coa, groupName)
			duel.closeSlotsForZoneAndCoaExceptActive(theZone, coa)
		else 
			if duel.verbose or theZone.verbose then 
				trigger.action.outText("Zone <" .. theZone.name .. "> Coa <" .. coa .. "> remains open, have <" .. activeInZone .. "> participants, max is <" .. maxForCoa .. ">", 30)
			end
		end
	else 
		if theZone.verbose or duel.verbose then 
			trigger.action.outText("+++duel: zone <" .. theZone:getName() .. "> currently not active, not closing slots", 30)
		end
	end
	
end 

function duel:onEvent(event)
	if not event then return end 
	if duel.verbose then 
		--trigger.action.outText("Event: " .. event.id .. " (" .. dcsCommon.event2text(event.id)  .. ")", 30)
	end
	local theUnit = event.initiator
	if not theUnit then return end 
	
	if event.id == 15 then -- birth 
		local unitName = theUnit:getName()
		-- see if this is a duelist that has spawned
		if not duel.allDuelists[unitName] then 
			return -- not a duelist, not my problem
		end
		
		-- unit that entered is player controlled, and duelist
		duel.duelistEnteredArena(theUnit, duel.allDuelists[unitName])
	end
	
	if event.id == 21 then 
		if duel.verbose then 
			trigger.action.outText("DUEL: player left unit <" .. theUnit:getName() .. ">", 30)
		end 
	end
end

--
-- update 
--

function duel.update()
	-- call me in a second to poll triggers
	timer.scheduleFunction(duel.update, {}, timer.getTime() + 1/duel.ups)
	
	--  check active players and their units 
	local now = timer.getTime()
	local filtered = {}
	for playerName, playerData in pairs(duel.activePlayers) do 
		local unitName = playerData.unitName
		local theUnit = Unit.getByName(unitName)
		if theUnit and Unit.isExist(theUnit) then
			-- all is well, nothing to do except update time stamp 
			playerData.lastSeen = now
			filtered[playerName] = playerData
		else 
			-- unit has disappeared. let's see how long 
			local delta = math.floor(now - playerData.lastSeen)
			if duel.verbose then 
				trigger.action.outText("player <" .. playerName .. ">'s unit is gone for <" .. delta .. "> seconds now.", 30)
			end 
			-- if gone long enough, open all slots and delete player entry 
			if delta < (duel.keepSlot + 1) then
				filtered[playerName] = playerData -- remember me
			else
				if duel.verbose then 
					trigger.action.outText("Time's up, all slots reopen now, player lost tabs on <" .. unitName .. ">", 30)
				end 
				-- update duelist data (if required)
				
				-- open all slots in that zone for player's coa 
				duel.checkReopenSlotsForZoneAndCoa(playerData.theZone, playerData.coa)
				
				-- not remembered 
			end
		end
	end
	duel.activePlayers = filtered 
	
	-- now handle FSM for each zone separately 
	for zoneName, theZone in pairs(duel.duelZones) do 
		-- first, check if they have been turned on or off 
		if theZone:testZoneFlag(theZone.duelOnFlag, theZone.duelTriggerMethod, "lastDuelOn") then
			theZone.active = true 
		end

		if theZone:testZoneFlag(theZone.duelOffFlag, theZone.duelTriggerMethod, "lastDuelOff") then
			theZone.active = false 
			duel.openSlotsForZoneAndCoa(theZone, 1)
			duel.openSlotsForZoneAndCoa(theZone, 2)
		end
	end
end


--
-- Config & start 
--
function duel.readConfigZone()
	local theZone = cfxZones.getZoneByName("duelConfig") 
	if not theZone then 
		theZone = cfxZones.createSimpleZone("duelConfig")
	end 
	
	duel.verbose = theZone.verbose
	duel.ups = theZone:getNumberFromZoneProperty("ups", 1)
	
	duel.keepSlot = theZone:getNumberFromZoneProperty("keepSlot", 30) -- grace period (in seconds) after unit vanishes in which they can re-slot via Briefing screen
	
	duel.inside = theZone:getBoolFromZoneProperty("inside", true)
	duel.gracePeriod = theZone:getNumberFromZoneProperty("gracePeriod", 30)
	duel.keepScore = theZone:getBoolFromZoneProperty("score", true)
	
	if duel.verbose then 
		trigger.action.outText("+++duel: read config", 30)
	end 
end

function duel.start()
	if not dcsCommon.libCheck then 
		trigger.action.outText("cfx duel requires dcsCommon", 30)
		return false 
	end 
	if not dcsCommon.libCheck("cfx Duel", duel.requiredLibs) then
		return false 
	end
	
	-- turn on SSB
	trigger.action.setUserFlag("SSB",100)
	
	-- read config 
	duel.readConfigZone()
	
	-- process cloner Zones 
	local attrZones = cfxZones.getZonesWithAttributeNamed("duel")
	for k, aZone in pairs(attrZones) do 
		duel.createDuelZone(aZone) -- process attributes
		duel.duelZones[aZone.name] = aZone -- add to list
	end
	
	-- connect event handler 
	world.addEventHandler(duel)
	
	-- start update 
	duel.update()
	
	trigger.action.outText("cfx Duel v" .. duel.version .. " started.", 30)
	return true 

end

if not duel.start() then 
	trigger.action.outText("cfx Duel aborted: missing libraries", 30)
	duel = nil
end