Merge branch 'development' into bug/500-fix-meson-builds-on-macos

Author: garethyr

CHANGELOG.md

@@ -101,6 +101,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `Settings.ini` property `DisableFactionBuyMenuThemes = 0/1` which will cause custom faction theme definitions in all modules to be ignored and the default theme to be used instead.
 
+- New `Settings.ini` property `DisableFactionBuyMenuThemeCursors = 0/1` which will cause custom faction theme cursor definitions in all modules to be ignored and the default cursors to be used instead.
+
 - New `Settings.ini` and `SceneMan` Lua (R/W) property `ScrapCompactingHeight` which determines the maximum height of a column of scrap terrain to collapse when the bottom pixel is knocked loose. 0 means no columns of terrain are ever collapsed, much like in old builds of CC.
 
 - New `DataModule` INI and Lua (R/O) property `IsMerchant` which determines whether a module is an independent merchant. Defaults to false (0). ([Issue #401](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/issues/401))  
@@ -392,6 +394,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	A new `GlobalScript` has been added that will automatically save the game every three minutes. To turn it on, enable the Autosaving `GlobalScript` in the main menu mod manager's Global Scripts section.  
 	To load games saved by this script, open the console and enter the command `ActivityMan:LoadGame("Autosave")`, or use the `Ctrl + F9` shortcut.
 
+- New hardcoded `MovableObject` function `OnGameSave(self)` that gets run for each `MovableObject` with it when the game is saved. This can be used in tandem with custom values (for `MOSRotatings` and child classes) to store data, which can be read during `Create` when the game is loaded.
+	
 - New Lua `AEmitter` properties:  
 	**TotalParticlesPerMinute** (R/O) - The rate at which all of the `Emission`s of this `AEmitter` combined, emit their particles.  
 	**TotalBurstSize** (R/O) - The number of particles that will be emitted by all the `Emission`s of this `AEmitter` combined, in one shot when a burst is triggered.  
@@ -474,7 +478,7 @@ This can be accessed via the new Lua (R/W) `SettingsMan` property `AIUpdateInter
 	Shift-clicking an item (or Shift + Fire in keyboard-only) in the cart will now empty the entire cart.  
 	Items in the cart will be indented to signify what actor's inventory they belong to.  
 	Middle-clicking (or pressing the Pickup key) on an item will duplicate it. This also duplicates an actor's inventory.  
-	You can now reorganize the cart by click-dragging, or by holding the item selection key and inputting up/down.
+	You can now reorganize the cart by click-dragging. For kbd-only you can do this by holding the sharp aim key and pressing up/down.
 
 - Added to Lua enum `ControlState` the state `RELEASE_FACEBUTTON`.
 

Entities/MOSRotating.cpp

@@ -2042,6 +2042,18 @@ void MOSRotating::CorrectAttachableAndWoundPositionsAndRotations() const {
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+void MOSRotating::OnGameSave() {
+	MovableObject::OnGameSave();
+	for (AEmitter *wound : m_Wounds) {
+		wound->OnGameSave();
+	}
+	for (Attachable *attachable : m_Attachables) {
+		attachable->OnGameSave();
+	}
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
 bool MOSRotating::TransferForcesFromAttachable(Attachable *attachable) {
     bool intact = false;
     Vector forces;

Entities/MOSRotating.h

@@ -937,6 +937,11 @@ ClassInfoGetters;
 	/// </summary>
 	virtual void CorrectAttachableAndWoundPositionsAndRotations() const;
 
+	/// <summary>
+	/// Method to be run when the game is saved via ActivityMan::SaveCurrentGame. Not currently used in metagame or editor saving.
+	/// </summary>
+	void OnGameSave() override;
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Protected member variable and method declarations

Entities/MovableObject.h

@@ -63,7 +63,7 @@ friend struct EntityLuaBindings;
 
 public:
 
-	ScriptFunctionNames("Create", "Destroy", "Update", "OnScriptDisable", "OnScriptEnable", "OnCollideWithTerrain", "OnCollideWithMO", "WhilePieMenuOpen");
+	ScriptFunctionNames("Create", "Destroy", "Update", "OnScriptDisable", "OnScriptEnable", "OnCollideWithTerrain", "OnCollideWithMO", "WhilePieMenuOpen", "OnGameSave");
 	SerializableOverrideMethods;
 	ClassInfoGetters;
 
@@ -1805,6 +1805,11 @@ enum MOType
 	/// <returns>Whether the object was successfully drawn to the terrain.</returns>
 	bool DrawToTerrain(SLTerrain *terrain);
 
+	/// <summary>
+	/// Method to be run when the game is saved via ActivityMan::SaveCurrentGame. Not currently used in metagame or editor saving.
+	/// </summary>
+	virtual void OnGameSave() { RunScriptedFunctionInAppropriateScripts("OnGameSave"); }
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // Protected member variable and method declarations
 

Entities/Scene.cpp

@@ -452,13 +452,9 @@ void Scene::Clear()
     m_AutoDesigned = true;
     m_TotalInvestment = 0;
     m_pTerrain = 0;
-	m_NoTeamPathFinder.reset();
-    for (std::unique_ptr<PathFinder> &pathFinder : m_PathFinders) {
+    for (std::unique_ptr<PathFinder> &pathFinder : m_pPathFinders) {
         pathFinder.reset();
     }
-	for (std::unique_ptr<PathFinder> &defaultDigStrengthPathFinder : m_DefaultDigStrengthPathfinders) {
-		defaultDigStrengthPathFinder.reset();
-	}
     m_PathfindingUpdated = false;
     m_PartialPathUpdateTimer.Reset();
 
@@ -937,12 +933,8 @@ int Scene::LoadData(bool placeObjects, bool initPathfinding, bool placeUnits)
 		//unsigned int numberOfBlocksToAllocate = std::min(128000, sceneArea / (pathFinderGridNodeSize * pathFinderGridNodeSize));
 		unsigned int numberOfBlocksToAllocate = 4000;
 
-		m_NoTeamPathFinder = std::make_unique<PathFinder>(pathFinderGridNodeSize, numberOfBlocksToAllocate);
-		for (int i = 0; i < m_PathFinders.size(); ++i) {
-			m_PathFinders[i] = std::make_unique<PathFinder>(pathFinderGridNodeSize, numberOfBlocksToAllocate);
-		}
-		for (int i = 0; i < m_DefaultDigStrengthPathfinders.size(); ++i) {
-			m_DefaultDigStrengthPathfinders[i] = std::make_unique<PathFinder>(pathFinderGridNodeSize, numberOfBlocksToAllocate);
+        for (int i = 0; i < m_pPathFinders.size(); ++i) {
+            m_pPathFinders[i] = std::make_unique<PathFinder>(pathFinderGridNodeSize, numberOfBlocksToAllocate);
         }
         ResetPathFinding();
     }
@@ -2986,7 +2978,6 @@ void Scene::ResetPathFinding() {
 	for (int team = Activity::Teams::TeamOne; team < Activity::Teams::MaxTeamCount; ++team) {
 		g_MovableMan.OverrideMaterialDoors(true, team);
 		GetPathFinder(static_cast<Activity::Teams>(team))->RecalculateAllCosts();
-		GetPathFinder(static_cast<Activity::Teams>(team), c_PathFindingDefaultDigStrength)->RecalculateAllCosts();
 		g_MovableMan.OverrideMaterialDoors(false, team);
 	}
 }
@@ -3022,7 +3013,6 @@ void Scene::UpdatePathFinding()
             g_MovableMan.OverrideMaterialDoors(true, team);
 
             GetPathFinder(static_cast<Activity::Teams>(team))->UpdateNodeList(updatedNodes);
-            GetPathFinder(static_cast<Activity::Teams>(team), c_PathFindingDefaultDigStrength)->UpdateNodeList(updatedNodes);
 
             // Place back the material representation of all doors of this team so they are as we found them.
             g_MovableMan.OverrideMaterialDoors(false, team);
@@ -3043,7 +3033,7 @@ void Scene::UpdatePathFinding()
 float Scene::CalculatePath(const Vector &start, const Vector &end, std::list<Vector> &pathResult, float digStrength, Activity::Teams team) {
     float totalCostResult = -1;
 
-    if (const std::unique_ptr<PathFinder> &pathFinder = GetPathFinder(team, digStrength)) {
+    if (const std::unique_ptr<PathFinder> &pathFinder = GetPathFinder(team)) {
         int result = pathFinder->CalculatePath(start, end, pathResult, totalCostResult, digStrength);
 
         // It's ok if start and end nodes happen to be the same, the exact pixel locations are added at the front and end of the result regardless
@@ -3126,14 +3116,9 @@ void Scene::Update()
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-std::unique_ptr<PathFinder>& Scene::GetPathFinder(Activity::Teams team, float digStrength) {
-	if (team == Activity::Teams::NoTeam) {
-		return m_NoTeamPathFinder;
-	} else if (std::abs(digStrength - c_PathFindingDefaultDigStrength) < 1.0F) {
-		return m_DefaultDigStrengthPathfinders[team];
-	} else {
-		return m_PathFinders[static_cast<int>(team)];
-	}
+std::unique_ptr<PathFinder>& Scene::GetPathFinder(Activity::Teams team) {
+	// Note - we use + 1 when getting pathfinders by index, because our shared NoTeam pathfinder occupies index 0, and the rest come after that.
+	return m_pPathFinders[static_cast<int>(team) + 1];
 }
 
 } // namespace RTE

Entities/Scene.h

@@ -1338,9 +1338,8 @@ const SceneObject * PickPlacedActorInRange(int whichSet, Vector &scenePoint, int
     SLTerrain *m_pTerrain;
 
     // Pathfinding graph and logic. Owned by this
-	std::unique_ptr<PathFinder> m_NoTeamPathFinder; //!< The shared pathfinder for when no team is specified.
-	std::array<std::unique_ptr<PathFinder>, Activity::Teams::MaxTeamCount> m_PathFinders; //!< The array of pathfinders for each team.
-	std::array<std::unique_ptr<PathFinder>, Activity::Teams::MaxTeamCount> m_DefaultDigStrengthPathfinders; //!< The array of pathfinders for each team to be used for default dig strength.
+    // The array of PathFinders for each team. Because we also have a shared pathfinder using index 0, we need to use MaxTeamCount + 1 to handle all the Teams' PathFinders.
+    std::array<std::unique_ptr<PathFinder>, Activity::Teams::MaxTeamCount + 1> m_pPathFinders;
     // Is set to true on any frame the pathfinding data has been updated
     bool m_PathfindingUpdated;
     // Timer for when to do an update of the pathfinding data
@@ -1395,9 +1394,8 @@ const SceneObject * PickPlacedActorInRange(int whichSet, Vector &scenePoint, int
 	/// Gets the pathfinder for a given team.
 	/// </summary>
 	/// <param name="team">The team to get the pathfinder for. NoTeam is valid, and will give a shared pathfinder.</param>
-	/// <param name="digStrength">The dig strength to get the pathfinder for. A different pathfinder will be used if it's the default dig strength. Defaults to -1 so the normal pathfinder will be used if no argument is passed in.</param>
 	/// <returns>A pointer to the pathfinder for the given team.</returns>
-	std::unique_ptr<PathFinder> & GetPathFinder(Activity::Teams team, float digStrength = -1);
+	std::unique_ptr<PathFinder> & GetPathFinder(Activity::Teams team);
 
 	/// <summary>
 	/// Serializes the SceneObject via the Writer. Necessary because full serialization doesn't know how to deal with duplicate properties.

Managers/ActivityMan.cpp

@@ -110,6 +110,11 @@ namespace RTE {
 		// Pull all stuff from MovableMan into the Scene for saving, so existing Actors/ADoors are saved, without transferring ownership, so the game can continue.
 		// This is done after the activity is saved, in case the activity wants to add anything to the scene while saving.
 		modifiableScene->RetrieveSceneObjects(false);
+		for (SceneObject *objectToSave : *modifiableScene->GetPlacedObjects(Scene::PlacedObjectSets::PLACEONLOAD)) {
+			if (MovableObject *objectToSaveAsMovableObject = dynamic_cast<MovableObject *>(objectToSave)) {
+				objectToSaveAsMovableObject->OnGameSave();
+			}
+		}
 
 		writer->NewPropertyWithValue("OriginalScenePresetName", scene->GetPresetName());
 		writer->NewPropertyWithValue("PlaceObjectsIfSceneIsRestarted", g_SceneMan.GetPlaceObjectsOnLoad());

Managers/MovableMan.cpp

@@ -201,6 +201,9 @@ MOID MovableMan::GetMOIDPixel(int pixelX, int pixelY, const std::vector<int> &mo
 
         const MovableObject *mo = GetMOFromID(moid);
         RTEAssert(mo, "Null MO found in MOID list!");
+		if (mo && mo->GetScale() == 0) {
+			return g_NoMOID;
+		}
         if (mo && HitTestMOAtPixel(*mo, pixelX, pixelY)) {
             return moid;
         }

Managers/SettingsMan.cpp

@@ -48,6 +48,7 @@ namespace RTE {
 		m_SimplifiedCollisionDetection = false;
 		m_SceneBackgroundAutoScaleMode = 1;
 		m_DisableFactionBuyMenuThemes = false;
+		m_DisableFactionBuyMenuThemeCursors = false;
 		m_PathFinderGridNodeSize = c_PPM;
 		m_AIUpdateInterval = 2;
 
@@ -195,6 +196,8 @@ namespace RTE {
 			SetSceneBackgroundAutoScaleMode(std::stoi(reader.ReadPropValue()));
 		} else if (propName == "DisableFactionBuyMenuThemes") {
 			reader >> m_DisableFactionBuyMenuThemes;
+		} else if (propName == "DisableFactionBuyMenuThemeCursors") {
+			reader >> m_DisableFactionBuyMenuThemeCursors;
 		} else if (propName == "PathFinderGridNodeSize") {
 			reader >> m_PathFinderGridNodeSize;
 		} else if (propName == "AIUpdateInterval") {
@@ -388,6 +391,7 @@ namespace RTE {
 		writer.NewPropertyWithValue("SimplifiedCollisionDetection", m_SimplifiedCollisionDetection);
 		writer.NewPropertyWithValue("SceneBackgroundAutoScaleMode", m_SceneBackgroundAutoScaleMode);
 		writer.NewPropertyWithValue("DisableFactionBuyMenuThemes", m_DisableFactionBuyMenuThemes);
+		writer.NewPropertyWithValue("DisableFactionBuyMenuThemeCursors", m_DisableFactionBuyMenuThemeCursors);
 		writer.NewPropertyWithValue("PathFinderGridNodeSize", m_PathFinderGridNodeSize);
 		writer.NewPropertyWithValue("AIUpdateInterval", m_AIUpdateInterval);
 		writer.NewPropertyWithValue("EnableParticleSettling", g_MovableMan.m_SettlingEnabled);

Managers/SettingsMan.h

@@ -93,6 +93,18 @@ namespace RTE {
 		/// <param name="disable">Whether faction BuyMenu theme support is disabled or not.</param>
 		void SetFactionBuyMenuThemesDisabled(bool disable) { m_DisableFactionBuyMenuThemes = disable; }
 
+		/// <summary>
+		/// Gets whether custom cursor support in faction BuyMenu themes is disabled.
+		/// </summary>
+		/// <returns>Whether faction BuyMenu theme support is disabled.</returns>
+		bool FactionBuyMenuThemeCursorsDisabled() const { return m_DisableFactionBuyMenuThemeCursors; }
+
+		/// <summary>
+		/// Sets whether custom cursor support in faction BuyMenu themes is disabled.
+		/// </summary>
+		/// <param name="disable">Whether custom cursor support in faction BuyMenu themes is disabled or not.</param>
+		void SetFactionBuyMenuThemeCursorsDisabled(bool disable) { m_DisableFactionBuyMenuThemeCursors = disable; }
+
 		/// <summary>
 		/// Gets the PathFinder grid node size.
 		/// </summary>
@@ -521,6 +533,7 @@ namespace RTE {
 		bool m_SimplifiedCollisionDetection; //!< Whether simplified collision detection (reduced MOID layer sampling) is enabled.
 		int m_SceneBackgroundAutoScaleMode; //!< Scene background layer auto-scaling mode. 0 for off, 1 for fit screen dimensions and 2 for always upscaled to x2.
 		bool m_DisableFactionBuyMenuThemes; //!< Whether faction BuyMenu theme support is disabled.
+		bool m_DisableFactionBuyMenuThemeCursors; //!< Whether custom cursor support in faction BuyMenu themes is disabled.
 		int m_PathFinderGridNodeSize; //!< The grid size used by the PathFinder, in pixels.
 		int m_AIUpdateInterval; //!< How often actor's AI should be updated, i.e. every n simulation updates.