Merge pull request #151 from cortex-command-community/activity-scene-compatibility

Activity Scene Compatibility

Author: Causeless

CHANGELOG.md

@@ -50,6 +50,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `AEmitter` and `PEmitter` INI and Lua (R/W) property `PlayBurstSound` which denotes whether the BurstSound should play when appropriate. This should not be confused for a trigger - it's just a enable/disable toggle to avoid having to remove and add BurstSound altogether.
 
+- New `GAScripted` Lua script method `IsCompatibleScene(scene)` to allow Activities to generically decide which Scenes are eligible by returning a boolean value.
+	New `GAScripted` INI enumerating property `AddRequiredArea`, replacing Lua file scanning, to allow Activities to explicitly state which areas are strictly required.
+	As before, these work in tandem. Both the required areas, if defined, and script conditional method, if defined, must pass for the scene to qualify.
+
 - New `GameActivity` INI properties `TeamNTechSwitchEnabled` which determine whether activity team factions are configurable by the user. This is most useful for communicating what the player is not intended to change, or what inputs would be ignored otherwise.
 
 - Allow lua scripts to use LuaJIT's BitOp module (see https://bitop.luajit.org/api.html)
@@ -119,6 +123,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - The Signal Hunt activity no longer has a preview image, as it was not formatted correctly and spoiled the interior structure of the cave.
 
+- Removed `GAScripted` Lua script method `SceneTest()` as the new Lua function `IsCompatibleScene(scene)` is more capable.
+	Removed `GAScripted` C++ functionality that would scan the  Lua script file to determine which areas are required. `AddRequiredArea` in the INI should be used instead.
+	Removed `Scene` Lua function `GetOptionalArea` as it functioned identically to `GetArea` aside from triggering the aforementioned (and now removed) Lua script file scanning.
+
 - Removed `AHuman` property `MaxCrouchRotation`. `CrouchRotAngleTarget` is now used instead.
 
 - Deprecated `LimbPath` properties `SlowTravelSpeed`, `NormalTravelSpeed` and `FastTravelSpeed`. For the sake of backwards compatibility they will not crash the game and `NormalTravelSpeed` is a valid synonym for the new `TravelSpeed`.

Data/Base.rte/Activities.ini

@@ -57,6 +57,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 1
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = Red Brain
+	AddRequiredArea = Green Brain
 
 
 AddActivity = GAScripted
@@ -109,6 +111,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 1
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = LZ Attacker
+	AddRequiredArea = Main Bunker
 
 
 AddActivity = GAScripted
@@ -126,6 +130,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 1
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = LZ Team 1
+	AddRequiredArea = LZ All
 
 
 AddActivity = GAScripted
@@ -149,6 +155,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 0
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = LZ Team 1
+	AddRequiredArea = LZ All
 
 
 AddActivity = GAScripted
@@ -172,7 +180,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 0
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
-	
+	AddRequiredArea = LZ Team 1
+	AddRequiredArea = LZ All
 
 
 AddActivity = GAScripted
@@ -197,8 +206,9 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 0
 	FogOfWarSwitchEnabled = 0
 	DeployUnitsSwitchEnabled = 0
+	AddRequiredArea = OneManArmyZeroGCompatibilityArea
+	
 
-// Path to orbit guaranteed by currently being in orbit.
 AddActivity = GAScripted
 	PresetName = One-Man Army (Diggers, 0-G)
 	Description = Survive with only one unit and no backups in a Zero-G void! The enemy will only use diggers, but the harder the difficulty the less potent weaponry you start out with, and the longer you have to survive.
@@ -237,6 +247,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 1
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = LZ Team 1
+	AddRequiredArea = LZ All
 
 
 AddActivity = GAScripted
@@ -253,6 +265,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 1
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = LZ Team 1
+	AddRequiredArea = LZ All
 
 
 AddActivity = GAScripted
@@ -270,6 +284,8 @@ AddActivity = GAScripted
 	RequireClearPathToOrbitSwitchEnabled = 0
 	FogOfWarSwitchEnabled = 1
 	DeployUnitsSwitchEnabled = 1
+	AddRequiredArea = LZ Team 1
+	AddRequiredArea = LZ All
 
 
 ///////////////////////////////////////////////////////////////////////

Data/Base.rte/Activities/BunkerBreach.lua

@@ -84,7 +84,7 @@ function BunkerBreach:SetupDefenderBrains()
 		end
 
 		defenderBrain = self:CreateBrainBot(self.defenderTeam);
-		defenderBrain.Pos = SceneMan.Scene:GetOptionalArea("Brain"):GetCenterPoint();
+		defenderBrain.Pos = SceneMan.Scene:GetArea("Brain"):GetCenterPoint();
 		MovableMan:AddActor(defenderBrain);
 	else
 		-- Pick the defender brain randomly from among those created by deployments, then delete the others and clean up most of their guards.
@@ -99,7 +99,7 @@ function BunkerBreach:SetupDefenderBrains()
 		table.remove(deploymentBrains, brainIndexToChoose);
 
 		if SceneMan.Scene:HasArea("Brain Chamber") then
-			self.brainChamber = SceneMan.Scene:GetOptionalArea("Brain Chamber");
+			self.brainChamber = SceneMan.Scene:GetArea("Brain Chamber");
 		end
 		for _, unchosenDeploymentBrain in pairs(deploymentBrains) do
 			unchosenDeploymentBrain.ToDelete = true;
@@ -167,7 +167,7 @@ function BunkerBreach:SetupDefenderActors()
 		for _, loadoutName in pairs({"Light", "Heavy", "Sniper", "Engineer", "Mecha", "Turret"}) do
 			if SceneMan.Scene:HasArea(loadoutName .. " Defenders") then
 				hasSpawnAreas = true;
-				local defenderArea = SceneMan.Scene:GetOptionalArea(loadoutName .. " Defenders");
+				local defenderArea = SceneMan.Scene:GetArea(loadoutName .. " Defenders");
 				if defenderArea ~= nil then
 					for defenderBox in defenderArea.Boxes do
 						local guard;
@@ -226,7 +226,7 @@ end
 
 function BunkerBreach:SetupDefenderInternalReinforcementAreas()
 	if self.AI.isDefenderTeam then
-		local internalReinforcementsArea = SceneMan.Scene:GetOptionalArea("Internal Reinforcements");
+		local internalReinforcementsArea = SceneMan.Scene:GetArea("Internal Reinforcements");
 		if internalReinforcementsArea ~= nil then
 			self.AI.internalReinforcementsDoorParticle = CreateMOSRotating("Background Door", "Base.rte");
 			self.AI.internalReinforcementPositions = {};
@@ -248,7 +248,7 @@ function BunkerBreach:StartActivity(isNewGame)
 	local attackerLZ = SceneMan.Scene:GetArea("LZ Attacker");
 	self:SetLZArea(self.attackerTeam, attackerLZ);
 	if SceneMan.Scene:HasArea("LZ Defender") then
-		self:SetLZArea(self.defenderTeam, SceneMan.Scene:GetOptionalArea("LZ Defender"));
+		self:SetLZArea(self.defenderTeam, SceneMan.Scene:GetArea("LZ Defender"));
 	end
 	self.mainBunkerArea = SceneMan.Scene:GetArea("Main Bunker");
 

Data/Base.rte/Activities/Siege.lua

@@ -65,7 +65,7 @@ function Siege:StartActivity()
 	--end
 
 	if SceneMan.Scene:HasArea("Brain") then
-		playerBrainsLocation = SceneMan.Scene:GetOptionalArea("Brain"):GetCenterPoint();
+		playerBrainsLocation = SceneMan.Scene:GetArea("Brain"):GetCenterPoint();
 	else
 		-- Look for a brain among actors created by the deployments
 		for actor in MovableMan.AddedActors do
@@ -98,7 +98,7 @@ function Siege:StartActivity()
 	end
 
 	if SceneMan.Scene:HasArea("Brain Chamber") then
-		self.BrainChamber = SceneMan.Scene:GetOptionalArea("Brain Chamber");
+		self.BrainChamber = SceneMan.Scene:GetArea("Brain Chamber");
 
 		-- Set all useless actors, i.e. those who should guard brain in the brain chamber but their brain is in another castle
 		-- to delete themselves, because otherwise they are most likely to stand there for the whole battle and waste MOs
@@ -112,7 +112,7 @@ function Siege:StartActivity()
 	end
 
 	if SceneMan.Scene:HasArea("Perimeter") then
-		self.Perimeter = SceneMan.Scene:GetOptionalArea("Perimeter");
+		self.Perimeter = SceneMan.Scene:GetArea("Perimeter");
 		--print ("Perimeter defined");
 	end
 

Data/Base.rte/Activities/Utility/DockingHandler.lua

@@ -93,14 +93,14 @@ function DockingHandler:Initialize(activity, newGame, autoAssignUnknownDropships
 
 		local i = 1;
 
-		while SceneMan.Scene:GetOptionalArea("Dropship Dock " .. i) do	
+		while SceneMan.Scene:GetArea("Dropship Dock " .. i) do	
 			self.mainTable.activeDSDockTable[i] = {["dockPosition"] = SceneMan.Scene:GetArea("Dropship Dock " .. i).Center,
 			["activeCraft"] =  nil,
 			["dockingStage"] =  nil};			
 			i = i + 1;
 			-- Jump two if needed, the player may want to avoid overlap as per above instructions
-			if SceneMan.Scene:GetOptionalArea("Dropship Dock " .. i) then
-			elseif SceneMan.Scene:GetOptionalArea("Dropship Dock " .. i + 1) then
+			if SceneMan.Scene:GetArea("Dropship Dock " .. i) then
+			elseif SceneMan.Scene:GetArea("Dropship Dock " .. i + 1) then
 				i = i + 1;
 			end
 
@@ -111,13 +111,13 @@ function DockingHandler:Initialize(activity, newGame, autoAssignUnknownDropships
 
 		i = 1;
 
-		while SceneMan.Scene:GetOptionalArea("Rocket Dock " .. i) do	
+		while SceneMan.Scene:GetArea("Rocket Dock " .. i) do	
 			self.mainTable.activeRocketDockTable[i] = {["dockPosition"] = SceneMan.Scene:GetArea("Rocket Dock " .. i).Center,
 			["activeCraft"] =  nil,
 			["dockingStage"] =  nil};
 			i = i + 1;
-			if SceneMan.Scene:GetOptionalArea("Rocket Dock " .. i) then
-			elseif SceneMan.Scene:GetOptionalArea("Rocket Dock " .. i + 1) then
+			if SceneMan.Scene:GetArea("Rocket Dock " .. i) then
+			elseif SceneMan.Scene:GetArea("Rocket Dock " .. i + 1) then
 				i = i + 1;
 			end
 		end

Data/Base.rte/Activities/Utility/SaveLoadHandler.lua

@@ -247,7 +247,7 @@ function SaveLoadHandler:ParseTableForAreas(tab)
 	for k, v in pairs(tab) do
 		if type(v) == "string" and string.find(v, "SAVELOADHANDLERAREA_") then
 			local areaName = string.sub(v, 21, -1);
-			local area = SceneMan.Scene:GetOptionalArea(areaName);
+			local area = SceneMan.Scene:GetArea(areaName);
 			tab[k] = area;	
 		elseif type(v) == "table" then
 			self:ParseTableForAreas(v);

Data/Base.rte/Activities/WaveDefense.lua

@@ -274,7 +274,7 @@ function WaveDefense:UpdateActivity()
 				end
 
 				-- Reveal the main bunker area for the defender.
-				local mainBunkerArea = SceneMan.Scene:GetOptionalArea("Main Bunker");
+				local mainBunkerArea = SceneMan.Scene:GetArea("Main Bunker");
 				if mainBunkerArea ~= nil then
 					for mainBunkerBox in mainBunkerArea.Boxes do
 						SceneMan:RevealUnseenBox(mainBunkerBox.Corner.X, mainBunkerBox.Corner.Y, mainBunkerBox.Width, mainBunkerBox.Height, self.playerTeam);

Data/Browncoats.rte/Activities/RefineryAssault.lua

@@ -231,37 +231,37 @@ function RefineryAssault:StartActivity(newGame)
 		self.saveTable.buyDoorTables = {};
 		self.saveTable.buyDoorTables.All = {};
 
-		local area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_LC1");
+		local area = SceneMan.Scene:GetArea("BuyDoorArea_LC1");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_LC2");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_LC2");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S3_1");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S3_1");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S3_2");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S3_2");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S3_3");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S3_3");
 		self:SetupBuyDoorAreaTable(self, area);	
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S4_1");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S4_1");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S4_2");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S4_2");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S4_3");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S4_3");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S4_4");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S4_4");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S4_5");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S4_5");
 		self:SetupBuyDoorAreaTable(self, area);
 
-		area = SceneMan.Scene:GetOptionalArea("BuyDoorArea_S4_6");
+		area = SceneMan.Scene:GetArea("BuyDoorArea_S4_6");
 		self:SetupBuyDoorAreaTable(self, area);
 
 		self.buyDoorHandler:ReplaceBuyDoorTable(self.saveTable.buyDoorTables.All);