From 9bcb7548367da72dbc3db176018eda463573d45e Mon Sep 17 00:00:00 2001
From: reaperrr <thereaperrr@aol.com>
Date: Mon, 17 Sep 2018 01:57:37 +0200
Subject: [PATCH] Add OnActorDispose plumbing to Activity

This allows activities to perform necessary cleanups on actor
death/disposal, for example by running OnLastRun directly,
which would otherwise be skipped when the actor dies or is disposed
through other means.
---
 OpenRA.Game/Activities/Activity.cs | 18 ++++++++++++++++++
 OpenRA.Game/Actor.cs               |  5 +++++
 2 files changed, 23 insertions(+)

diff --git a/OpenRA.Game/Activities/Activity.cs b/OpenRA.Game/Activities/Activity.cs
index 9dec312bde..efa4a5c7db 100644
--- a/OpenRA.Game/Activities/Activity.cs
+++ b/OpenRA.Game/Activities/Activity.cs
@@ -200,6 +200,24 @@ namespace OpenRA.Activities
 		/// </summary>
 		protected virtual void OnLastRun(Actor self) { }
 
+		/// <summary>
+		/// Runs once on Actor.Dispose() (through OnActorDisposeOuter) and can be used to perform activity clean-up on actor death/disposal,
+		/// for example by force-triggering OnLastRun (which would otherwise be skipped).
+		/// </summary>
+		protected virtual void OnActorDispose(Actor self) { }
+
+		/// <summary>
+		/// Runs once on Actor.Dispose().
+		/// Main purpose is to ensure ChildActivity.OnActorDispose runs as well (which isn't otherwise accessible due to protection level).
+		/// </summary>
+		internal void OnActorDisposeOuter(Actor self)
+		{
+			if (ChildActivity != null)
+				ChildActivity.OnActorDisposeOuter(self);
+
+			OnActorDispose(self);
+		}
+
 		public virtual bool Cancel(Actor self, bool keepQueue = false)
 		{
 			if (!IsInterruptible)
diff --git a/OpenRA.Game/Actor.cs b/OpenRA.Game/Actor.cs
index 7e9b402620..f5bfca8f6f 100644
--- a/OpenRA.Game/Actor.cs
+++ b/OpenRA.Game/Actor.cs
@@ -265,6 +265,11 @@ namespace OpenRA
 
 		public void Dispose()
 		{
+			// If CurrentActivity isn't null, run OnActorDisposeOuter in case some cleanups are needed.
+			// This should be done before the FrameEndTask to avoid dependency issues.
+			if (CurrentActivity != null)
+				CurrentActivity.RootActivity.OnActorDisposeOuter(this);
+
 			World.AddFrameEndTask(w =>
 			{
 				if (Disposed)