Merge #466 (long-war-2:preserve-proxy-data)

Author: robojumper

CHANGELOG.md

@@ -255,6 +255,10 @@ All notable changes to Vanilla 'War Of The Chosen' Behaviour will be documented
 - Additional Photobooth particle system enums for mods (#359)
 - Tweaks to "Resistance Archives" random Legacy Operations UI. Restarts show the correct locked difficulty, and a crash condition on backing out of a restart fixed. (#307)
 - Added CovertAction as its own EventSource on Event 'CovertActionCompleted' (#383)
+- Allow mods to check whether VIP units left a mission successfully via the `bRemovedFromPlay`
+  flag on `XComGameState_Unit`. This behavior is gated behind the new `CHHelpers.PreserveProxyUnitData`
+  config variable. (#465)
+
 
 ### Fixes
 - Fix Chosen Assassin receiving weaknesses that are exclusive to the

X2WOTCCommunityHighlander/Config/XComGame.ini

@@ -23,4 +23,6 @@ bEnableVersionDisplay=true
 ;AmmoSlotBypassUniqueRule=false ; Set to true to make ammo slot ignore unique items rule.
 
 ;bDontUnequipWhenWounded=true ; Set to true to make soldier keep their gear when wounded
-;bDontUnequipCovertOps=true ; Uncomment to make soldiers on covert ops keep their gear even if ambush risk is 0
+;bDontUnequipCovertOps=true ; Uncomment to make soldiers on covert ops keep their gear even if ambush risk is 0
+
+;PreserveProxyUnitData=true ; Set to true to make sure important info on proxy VIP units is copied to the original units

X2WOTCCommunityHighlander/Src/XComGame/Classes/CHHelpers.uc

@@ -110,6 +110,10 @@ var config(Content) array<name> EyeMaterial;
 var config(Content) array<name> FlagMaterial;
 // End Issue #356
 
+// Start Issue #465
+var config bool PreserveProxyUnitData;
+// End Issue #465
+
 // Start Issue #123
 simulated static function RebuildPerkContentCache() {
 	local XComContentManager		Content;

X2WOTCCommunityHighlander/Src/XComGame/Classes/XComGameStateContext_StrategyGameRule.uc

@@ -1293,6 +1293,13 @@ static function CleanupProxyVips()
 			OriginalUnit.SetCurrentStat(eStat_HP, ProxyUnit.GetCurrentStat(eStat_HP));
 		}
 
+		// Start Issue #465
+		if (class'CHHelpers'.default.PreserveProxyUnitData && ProxyUnit.bRemovedFromPlay)
+		{
+			OriginalUnit.RemoveStateFromPlay();
+		}
+		// End Issue #465
+		
 		// remove the proxy from the game. We don't need it anymore
 		NewGameState.RemoveStateObject(ProxyUnit.ObjectID);
 	}