Merge branch 'development' into emissionparticlecount

Author: Causeless

CHANGELOG.md

@@ -50,6 +50,27 @@ 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 `MOSprite` INI and Lua (R/W) integer property `ForcedHFlip` which forces a certain flippedness and disallows anything else from ever changing it without clearing the forced value first. 0 is forced not flipped, 1 forced flipped, and -1 is no force.
+
+- New hotkey bindings.
+	On Mouse+KB PC the defaults are: Weapon Primary Hotkey on V, Weapon Auxiliary Hotkey on H, Actor Primary Hotkey on X, Actor Auxiliary Hotkey on O.
+	Added new `Controller` states `WEAPON_PRIMARY_HOTKEYSTART`, `WEAPON_AUXILIARY_HOTKEYSTART`, `ACTOR_PRIMARY_HOTKEYSTART`, `ACTOR_AUXILIARY_HOTKEYSTART`, `WEAPON_PRIMARY_HOTKEY`, `WEAPON_AUXILIARY_HOTKEY`, `ACTOR_PRIMARY_HOTKEY`, `ACTOR_AUXILIARY_HOTKEY`
+
+- New hotkey system for `Actor` and `HeldDevice`.
+	Pressing a certain new hotkey will mark it as activated on `Actor` and `HeldDevice`, letting scripts make use of the new bindings easily.
+	`Enum` binding for `HeldDevice.HeldDeviceHotkeyType`: `PRIMARY = 0, AUXILIARY = 1, HELDDEVICEHOTKEYTYPECOUNT = 2`.  
+	`Enum` binding for `Actor.ActorHotkeyType`: `PRIMARY = 0, AUXILIARY = 1, ACTORHOTKEYTYPECOUNT = 2`. 
+	Both `Actor` and `HeldDevice` have the following functions:
+	`HotkeyActionIsActivated(hotkeyType)` returns whether a certain hotkey action is being activated or not.
+	`ActivateHotkeyAction(hotkeyType)` activates a certain hotkey action.
+	`DeactivateHotkeyAction(hotkeyType)` deactivates a certain hotkey action.
+
+- 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)
 
 - New `Emission` INI and Lua (R/W) property `ParticleCount` which sets how many particles the Emission spawns per emission. Defaults to 1.
@@ -65,7 +86,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Improved navigation, making running and fast walkpaths much more consistent.
 
 - Increased fog-of-war resolution in all vanilla activities, and conquest, from 20x20 to 4x4.
-	The Ronin Scrambler, the basic scanner, and `SceneMan:CastUnseenRay` have been changed to accomodate fog-of-war resolutions as fine as 1x1 and as course as 20x20.
+	The Ronin Scrambler, the basic scanner, and `SceneMan:CastUnseenRay` have been changed to accomodate fog-of-war resolutions as fine as 1x1 and as coarse as 20x20.
 	The fog-of-war revealing code is now multithreaded to increase performance.
 
 - All vanilla scenario activities have had their settings polished, respecting settings which make sense and disabling settings which don't.
@@ -87,6 +108,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - The `LimbPath` property `NormalTravelSpeed` has been renamed to just `TravelSpeed`.
 
+- `GameActivity` INI properties `TeamNTech` values switched to lazy eval, allowing them to be validated once all modules are loaded.
+	As well, the scenario menu activity configuration screen now respects defaults set in INI, where possible.
+
+- Internal GUI element `ComboBox` no longer displays dropdown combobutton when disabled, to communicate visually that it's setting is not modifiable.
+
 - Almost all ctrl+* special inputs functionality (i.e restarting activity, world dumps, showing performance stats) are now mapped to right alt, to not interfere with default crouching inputs. The only exception is ctrl+arrow keys for changing console size.
 
 - `Gib`s and detached `Attachable`s now inherit the parent's angular velocity by default.
@@ -111,6 +137,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Fixed an issue where an `Actor`'s MovementState wasn't correctly accessible from script.
 
+- Fixed mounted HeldDevices not respecting InheritedRotAngleOffset.
+
+- Fixed an issue where internal Lua functions OriginalDoFile, OriginalLoadFile, and OriginalRequire were polluting the global namespace. They have now been made inaccessible.
+
 </details>
 
 <details><summary><b>Removed</b></summary>
@@ -120,6 +150,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/DeliveryCreationHandler.lua

@@ -1026,6 +1026,23 @@ function DeliveryCreationHandler:CreateEliteSquad(team, squadCountOrTypeTable, s
 
 end
 
+function DeliveryCreationHandler:CreateCraft(team, forceRocketUsage)
+
+	local craftGroup = "Craft - Dropships";
+	if forceRocketUsage then
+		craftGroup = "Craft - Rockets";
+	end
+	presetName, createFunc, techName = self:SelectPresetByGroupPair(team, craftGroup, craftGroup, craftGroup, craftGroup);
+	
+	local craft = _G[createFunc](presetName, techName);
+	craft.Team = team;
+	--print(craft)
+	
+	local goldCost = ToSceneObject(craft):GetTotalValue(self.teamTechIDTable[team], 1);
+	
+	return craft, goldCost
+end
+
 function DeliveryCreationHandler:CreateSquadWithCraft(team, forceRocketUsage, squadCountOrTypeTable, squadType)
 
 	local craftGroup = "Craft - Dropships";

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
@@ -232,8 +232,9 @@ function DockingHandler:SpawnUndersideDockingCraft(craft, specificDock)
 			SceneMan:ForceBounds(pos);				
 			craft:AddAISceneWaypoint(pos);
 			craft:AddAISceneWaypoint(dockTable.dockPosition);
-			local direction = dockToDockAt % 2 == 0 and 1 or -1;	
-			craft:AddAISceneWaypoint(dockTable.dockPosition + Vector(275 * direction, 0))
+			local direction = dockToDockAt % 2 == 0 and 1 or -1;
+			print("direction: " .. direction);
+			craft:AddAISceneWaypoint(dockTable.dockPosition + Vector(-275 * direction, 0))
 
 			dockTable.activeCraft = craft;
 			dockTable.dockingStage = 1;
@@ -341,7 +342,7 @@ function DockingHandler:UpdateUndersideDockingCraft()
 							craft:AddAISceneWaypoint(pos);
 							craft:AddAISceneWaypoint(dockTable.dockPosition);
 							local direction = i % 2 == 0 and 1 or -1;	
-							craft:AddAISceneWaypoint(dockTable.dockPosition + Vector(275 * direction, 0))
+							craft:AddAISceneWaypoint(dockTable.dockPosition + Vector(-275 * direction, 0))
 
 							dockTable.activeCraft = craft;
 							dockTable.dockingStage = 1;
@@ -443,7 +444,7 @@ function DockingHandler:UpdateUndersideDockingCraft()
 
 					--print(SceneMan:ShortestDistance(craft.Pos, dockTable.dockPosition + Vector(200 * direction, 0), true))
 
-					local distFromDockArea = SceneMan:ShortestDistance(craft.Pos, dockTable.dockPosition + Vector(275 * direction, 0), true).Magnitude
+					local distFromDockArea = SceneMan:ShortestDistance(craft.Pos, dockTable.dockPosition + Vector(-275 * direction, 0), true).Magnitude
 					--print(distFromDockArea)
 					if distFromDockArea < 20 then
 						craft:OpenHatch();

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

@@ -66,7 +66,7 @@ function SaveLoadHandler:SerializeTable(val, name, skipnewlines, depth)
 		if type(name) == "number" then
 			tmp = tmp .. "[" .. name .. "]" .. " = "
 		else
-			tmp = tmp .. name .. " = "
+			tmp = tmp .. "['" .. name .. "']" .. " = "
 		end
 	end
 
@@ -92,6 +92,8 @@ function SaveLoadHandler:SerializeTable(val, name, skipnewlines, depth)
 		print("ERROR: SaveLoadHandler tried to save a function. This cannot currently be done and the table will not be as expected when loaded.");
 	elseif val.Magnitude then -- ghetto vector check
 		tmp = tmp .. string.format("%q", "Vector(" .. val.X .. "," .. val.Y .. ")")
+	elseif val.Area then -- ghetto box check
+		tmp = tmp .. string.format("%q", "Box(" .. val.Corner.X .. "," .. val.Corner.Y .. "," .. val.Corner.X + val.Width .. "," .. val.Corner.Y + val.Height .. ")")
 	elseif val.PresetName and IsMOSRotating(val) then -- IsMOSRotating freaks out if we give it something that isn't a preset at all... ghetto here too
 		val:SetNumberValue("saveLoadHandlerUniqueID", val.UniqueID);
 		tmp = tmp .. string.format("%q", "SAVELOADHANDLERUNIQUEID_" .. tostring(val.UniqueID))
@@ -243,11 +245,23 @@ function SaveLoadHandler:ParseTableForVectors(tab)
 
 end
 
+function SaveLoadHandler:ParseTableForBoxes(tab)
+	for k, v in pairs(tab) do
+		if type(v) == "string" and string.find(v, "Box%(") then
+			local vector = loadstring("return " .. v)();
+			tab[k] = vector;	
+		elseif type(v) == "table" then
+			self:ParseTableForBoxes(v);
+		end
+	end
+		
+end
+
 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);
@@ -289,6 +303,10 @@ function SaveLoadHandler:DeserializeTable(serializedTable, name)
 		print("INFO: SaveLoadHandler is parsing this table for Vectors: " .. name);
 	end
 	self:ParseTableForVectors(tab);
+	if name and SaveLoadHandler.verboseLogging then
+		print("INFO: SaveLoadHandler is parsing this table for Boxes: " .. name);
+	end
+	self:ParseTableForBoxes(tab);
 	if name and SaveLoadHandler.verboseLogging then
 		print("INFO: SaveLoadHandler is parsing this table for Areas: " .. name);
 	end

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);