add spice refinery smoke overlay when harvester docked

OpenRA.Game/Traits/TraitsInterfaces.cs

@@ -86,6 +86,7 @@ namespace OpenRA.Traits
 		bool IsValidTarget(Actor self, Actor saboteur);
 	}
 	public interface IStoreOre { int Capacity { get; } }
+	public interface INotifyDocking { void Docked(Actor self, Actor harvester); void Undocked(Actor self, Actor harvester); }
 	public interface IEffectiveOwner
 	{
 		bool Disguised { get; }

OpenRA.Mods.Cnc/Activities/HarvesterDockSequence.cs

@@ -52,7 +52,12 @@ namespace OpenRA.Mods.Cnc
 					state = State.Dock;
 					return Util.SequenceActivities(new Drag(startDock, endDock, 12), this);
 				case State.Dock:
-					ru.PlayCustomAnimation(self, "dock", () => { ru.PlayCustomAnimRepeating(self, "dock-loop"); state = State.Loop; });
+					ru.PlayCustomAnimation(self, "dock", () => {
+						ru.PlayCustomAnimRepeating(self, "dock-loop");
+						foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
+							nd.Docked(proc, self);
+						state = State.Loop;
+					});
 					state = State.Wait;
 					return this;
 				case State.Loop:
@@ -61,6 +66,8 @@ namespace OpenRA.Mods.Cnc
 					return this;
 				case State.Undock:
 					ru.PlayCustomAnimBackwards(self, "dock", () => state = State.DragOut);
+					foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
+						nd.Undocked(proc, self);
 					state = State.Wait;
 					return this;
 				case State.DragOut:

OpenRA.Mods.D2k/OpenRA.Mods.D2k.csproj

@@ -89,6 +89,7 @@
     <Compile Include="DamagedWithoutFoundation.cs" />
     <Compile Include="Render\WithBuildingPlacedOverlayInfo.cs" />
     <Compile Include="Render\WithProductionOverlay.cs" />
+    <Compile Include="Render\WithDockingOverlay.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <PropertyGroup>

OpenRA.Mods.D2k/Render/WithDockingOverlay.cs

@@ -0,0 +1,74 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2014 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation. For more information,
+ * see COPYING.
+ */
+#endregion
+
+using OpenRA.Effects;
+using OpenRA.FileFormats;
+using OpenRA.Graphics;
+using OpenRA.Traits;
+using OpenRA.Mods.RA.Buildings;
+
+namespace OpenRA.Mods.RA.Render
+{
+	public class WithDockingOverlayInfo : ITraitInfo, Requires<RenderSpritesInfo>, Requires<IBodyOrientationInfo>
+	{
+		[Desc("Sequence name to use")]
+		public readonly string Sequence = "docking-overlay";
+
+		[Desc("Position relative to body")]
+		public readonly WVec Offset = WVec.Zero;
+
+		public object Create(ActorInitializer init) { return new WithDockingOverlay(init.self, this); }
+	}
+
+	public class WithDockingOverlay : INotifyDocking, INotifyBuildComplete, INotifySold
+	{
+		WithDockingOverlayInfo info;
+		Animation overlay;
+		bool buildComplete, docked;
+
+		public WithDockingOverlay(Actor self, WithDockingOverlayInfo info)
+		{
+			this.info = info;
+
+			var rs = self.Trait<RenderSprites>();
+			var body = self.Trait<IBodyOrientation>();
+
+			buildComplete = !self.HasTrait<Building>(); // always render instantly for units
+
+			overlay = new Animation(rs.GetImage(self));
+			overlay.Play(info.Sequence);
+			rs.anims.Add("docking_overlay_{0}".F(info.Sequence),
+				new AnimationWithOffset(overlay,
+					() => body.LocalToWorld(info.Offset.Rotate(body.QuantizeOrientation(self, self.Orientation))),
+					() => !buildComplete));
+		}
+
+		void PlayDockingOverlay()
+		{
+			if (docked)
+				overlay.PlayThen(info.Sequence, PlayDockingOverlay);
+		}
+
+		public void BuildingComplete(Actor self)
+		{
+			self.World.AddFrameEndTask(w => w.Add(new DelayedAction(120, () =>
+					buildComplete = true)));
+		}
+
+		public void Sold(Actor self) { }
+		public void Selling(Actor self)
+		{
+			buildComplete = false;
+		}
+
+		public void Docked(Actor self, Actor harvester) { docked = true; PlayDockingOverlay(); }
+		public void Undocked(Actor self, Actor harvester) { docked = false; }
+	}
+}

OpenRA.Mods.RA/Activities/RAHarvesterDockSequence.cs

@@ -45,7 +45,12 @@ namespace OpenRA.Mods.RA
 					state = State.Dock;
 					return Util.SequenceActivities(new Turn(angle), this);
 				case State.Dock:
-					ru.PlayCustomAnimation(self, "dock", () => {ru.PlayCustomAnimRepeating(self, "dock-loop"); state = State.Loop;});
+					ru.PlayCustomAnimation(self, "dock", () => {
+						ru.PlayCustomAnimRepeating(self, "dock-loop");
+						foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
+							nd.Docked(proc, self);
+						state = State.Loop;
+					});
 					state = State.Wait;
 					return this;
 				case State.Loop:
@@ -59,8 +64,11 @@ namespace OpenRA.Mods.RA
 				case State.Complete:
 					harv.LastLinkedProc = harv.LinkedProc;
 					harv.LinkProc(self, null);
+					foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
+						nd.Undocked(proc, self);
 					return NextActivity;
 			}
+
 			throw new InvalidOperationException("Invalid harvester dock state");
 		}
 

OpenRA.Mods.RA/OreRefinery.cs

@@ -44,6 +44,7 @@ namespace OpenRA.Mods.RA
 		[Sync] bool preventDock = false;
 
 		public bool AllowDocking { get { return !preventDock; } }
+
 		public CVec DeliverOffset { get { return (CVec)Info.DockOffset; } }
 
 		public virtual Activity DockSequence(Actor harv, Actor self) { return new RAHarvesterDockSequence(harv, self, Info.DockAngle); }

mods/d2k/rules/structures.yaml

@@ -190,6 +190,8 @@ CONCRETEB:
 		Facing: 160
 	ProvidesCustomPrerequisite:
 		Prerequisite: Refinery
+	WithDockingOverlay@SMOKE:
+		Sequence: smoke
 
 ^SILO:
 	Inherits: ^Building

mods/d2k/sequences/structures.yaml

@@ -475,6 +475,12 @@ refa:
 	icon: DATA
 		Start: 4066
 		Offset: -30,-24
+	smoke: DATA
+		Start: 3885
+		Length: 14
+		Offset: 10,-16
+		Tick: 200
+		BlendMode: Additive
 
 siloa:
 	idle: DATA
@@ -966,6 +972,12 @@ refh:
 	icon: DATA
 		Start: 4067
 		Offset: -30,-24
+	smoke: DATA
+		Start: 3885
+		Length: 14
+		Offset: 10,-16
+		Tick: 200
+		BlendMode: Additive
 
 siloh:
 	idle: DATA
@@ -1367,6 +1379,12 @@ refo:
 	icon: DATA
 		Start: 4068
 		Offset: -30,-24
+	smoke: DATA
+		Start: 3885
+		Length: 14
+		Offset: 10,-16
+		Tick: 200
+		BlendMode: Additive
 
 siloo:
 	idle: DATA