Do some extra sanity checking of droids' actions and orders before saving a game,

to help prevent corrupted savegames. Backported from qt branch. Closes ticket:2100

Author: perim

src/action.c

@@ -990,25 +990,9 @@ static void actionHomeBasePos(SDWORD player, SDWORD *px, SDWORD *py)
 
 #define	VTOL_ATTACK_AUDIO_DELAY		(3*GAME_TICKS_PER_SEC)
 
-// Update the action state for a droid
-void actionUpdateDroid(DROID *psDroid)
+void actionSanity(DROID *psDroid)
 {
-	BASE_OBJECT			*psTarget;
-	PROPULSION_STATS	*psPropStats;
-	BOOL				(*actionUpdateFunc)(DROID *psDroid) = NULL;
-	signed int i;
-	unsigned int j;
-	//this is a bit field
-	bool nonNullWeapon[DROID_MAXWEAPS] = { false };
-	BASE_OBJECT			*psTargets[DROID_MAXWEAPS];
-	bool hasVisibleTarget = false;
-	bool targetVisibile[DROID_MAXWEAPS] = { false };
-	bool bHasTarget;
-
-	CHECK_DROID(psDroid);
-
-	psPropStats = asPropulsionStats + psDroid->asBits[COMP_PROPULSION].nStat;
-	ASSERT_OR_RETURN(, psPropStats != NULL, "Invalid propulsion stats pointer");
+	int i;
 
 	// clear the target if it has died
 	for (i = 0; i < DROID_MAXWEAPS; i++)
@@ -1040,6 +1024,29 @@ void actionUpdateDroid(DROID *psDroid)
 			}
 		}
 	}
+}
+
+// Update the action state for a droid
+void actionUpdateDroid(DROID *psDroid)
+{
+	BASE_OBJECT			*psTarget;
+	PROPULSION_STATS	*psPropStats;
+	BOOL				(*actionUpdateFunc)(DROID *psDroid) = NULL;
+	signed int i;
+	unsigned int j;
+	//this is a bit field
+	bool nonNullWeapon[DROID_MAXWEAPS] = { false };
+	BASE_OBJECT			*psTargets[DROID_MAXWEAPS];
+	bool hasVisibleTarget = false;
+	bool targetVisibile[DROID_MAXWEAPS] = { false };
+	bool bHasTarget;
+
+	CHECK_DROID(psDroid);
+
+	psPropStats = asPropulsionStats + psDroid->asBits[COMP_PROPULSION].nStat;
+	ASSERT_OR_RETURN(, psPropStats != NULL, "Invalid propulsion stats pointer");
+
+	actionSanity(psDroid);
 
 	//if the droid has been attacked by an EMP weapon, it is temporarily disabled
 	if (psDroid->lastHitWeapon == WSC_EMP)

src/action.h

@@ -110,6 +110,9 @@ extern const char* getDroidActionName(DROID_ACTION action);
  */
 extern void actionUpdateDroid(DROID *psDroid);
 
+/** Do sanity update only. Called from actionUpdateDroid() normally. */
+void actionSanity(DROID *psDroid);
+
 /** Give a droid an action. */
 extern void actionDroid(DROID *psDroid, DROID_ACTION action);
 

src/game.c

@@ -2347,6 +2347,20 @@ BOOL loadMissionExtras(const char *pGameToLoad, SWORD levelType)
 	return true;
 }
 
+static void sanityUpdate(void)
+{
+	int player;
+	DROID *psDroid;
+
+	for (player = 0; player < game.maxPlayers; player++)
+	{
+		for (psDroid = apsDroidLists[player]; psDroid; psDroid = psDroid->psNext)
+		{
+			orderCheckList(psDroid);
+			actionSanity(psDroid);
+		}
+	}
+}
 
 // -----------------------------------------------------------------------------------------
 // UserSaveGame ... this is true when you are loading a players save game
@@ -3527,6 +3541,7 @@ BOOL saveGame(char *aFileName, SDWORD saveType)
 
 	fileExtension = strlen(CurrentFileName) - 3;
 	gameTimeStop();
+	sanityUpdate();
 
 	/* Write the data to the file */
 	if (!writeGameFile(CurrentFileName, saveType))

src/order.c

@@ -89,9 +89,6 @@ RUN_DATA	asRunData[MAX_PLAYERS];
 // deal with a droid receiving a primary order
 BOOL secondaryGotPrimaryOrder(DROID *psDroid, DROID_ORDER order);
 
-// check all the orders in the list for died objects
-void orderCheckList(DROID *psDroid);
-
 // clear all the orders from the list
 void orderClearDroidList(DROID *psDroid);
 

src/order.h

@@ -144,6 +144,9 @@ typedef enum _secondary_state
 //call this *AFTER* every mission so it gets reset
 extern void initRunData(void);
 
+/// Check all the orders in the list for died objects
+void orderCheckList(DROID *psDroid);
+
 /* Update a droids order state */
 extern void orderUpdateDroid(DROID *psDroid);