Add SpriteHarvesterDockSequence and VoxelHarvesterDockSequence

Pass drag-related info from Refinery to HarvesterDockSequence

OpenRA.Mods.Cnc/Activities/TDHarvesterDockSequence.cs

@@ -1,93 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 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 System;
-using System.Collections.Generic;
-using OpenRA.Activities;
-using OpenRA.Mods.Common.Activities;
-using OpenRA.Mods.Common.Traits;
-using OpenRA.Mods.RA.Traits;
-using OpenRA.Traits;
-
-namespace OpenRA.Mods.Cnc.Activities
-{
-	public class TDHarvesterDockSequence : Activity
-	{
-		enum State { Wait, Turn, DragIn, Dock, Loop, Undock, DragOut }
-		static readonly WVec DockOffset = new WVec(-640, 341, 0);
-
-		readonly Actor proc;
-		readonly Harvester harv;
-		readonly RenderUnit ru;
-		State state;
-
-		WPos startDock, endDock;
-		public TDHarvesterDockSequence(Actor self, Actor proc)
-		{
-			this.proc = proc;
-			state = State.Turn;
-			harv = self.Trait<Harvester>();
-			ru = self.Trait<RenderUnit>();
-			startDock = self.CenterPosition;
-			endDock = proc.CenterPosition + DockOffset;
-		}
-
-		public override Activity Tick(Actor self)
-		{
-			switch (state)
-			{
-				case State.Wait:
-					return this;
-				case State.Turn:
-					state = State.DragIn;
-					return Util.SequenceActivities(new Turn(self, 112), this);
-				case State.DragIn:
-					state = State.Dock;
-					return Util.SequenceActivities(new Drag(self, startDock, endDock, 12), this);
-				case State.Dock:
-					ru.PlayCustomAnimation(self, "dock", () =>
-					{
-						ru.PlayCustomAnimRepeating(self, "dock-loop");
-						if (proc.IsInWorld && !proc.IsDead)
-							foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
-								nd.Docked(proc, self);
-						state = State.Loop;
-					});
-					state = State.Wait;
-					return this;
-				case State.Loop:
-					if (!proc.IsInWorld || proc.IsDead || harv.TickUnload(self, proc))
-						state = State.Undock;
-					return this;
-				case State.Undock:
-					ru.PlayCustomAnimBackwards(self, "dock", () => state = State.DragOut);
-					if (proc.IsInWorld && !proc.IsDead)
-						foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
-							nd.Undocked(proc, self);
-					state = State.Wait;
-					return this;
-				case State.DragOut:
-					return Util.SequenceActivities(new Drag(self, endDock, startDock, 12), NextActivity);
-			}
-
-			throw new InvalidOperationException("Invalid harvester dock state");
-		}
-
-		public override void Cancel(Actor self)
-		{
-			state = State.Undock;
-		}
-
-		public override IEnumerable<Target> GetTargets(Actor self)
-		{
-			yield return Target.FromActor(proc);
-		}
-	}
-}

OpenRA.Mods.Cnc/OpenRA.Mods.Cnc.csproj

@@ -67,12 +67,10 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="Activities\TDHarvesterDockSequence.cs" />
     <Compile Include="CncLoadScreen.cs" />
     <Compile Include="Effects\IonCannon.cs" />
     <Compile Include="Traits\AttackPopupTurreted.cs" />
     <Compile Include="Traits\Buildings\ProductionAirdrop.cs" />
-    <Compile Include="Traits\Buildings\TiberianDawnRefinery.cs" />
     <Compile Include="Traits\PoisonedByTiberium.cs" />
     <Compile Include="Traits\Render\RenderGunboat.cs" />
     <Compile Include="Traits\Render\WithCargo.cs" />

OpenRA.Mods.Cnc/Traits/Buildings/TiberianDawnRefinery.cs

@@ -1,31 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2015 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.Activities;
-using OpenRA.Mods.Cnc.Activities;
-using OpenRA.Mods.RA.Traits;
-
-namespace OpenRA.Mods.Cnc.Traits
-{
-	public class TiberianDawnRefineryInfo : RefineryInfo
-	{
-		public override object Create(ActorInitializer init) { return new TiberianDawnRefinery(init.Self, this); }
-	}
-
-	public class TiberianDawnRefinery : Refinery
-	{
-		public TiberianDawnRefinery(Actor self, RefineryInfo info) : base(self, info) { }
-
-		public override Activity DockSequence(Actor harv, Actor self)
-		{
-			return new TDHarvesterDockSequence(harv, self);
-		}
-	}
-}

OpenRA.Mods.RA/Activities/HarvesterDockSequence.cs

@@ -12,65 +12,69 @@ using System;
 using System.Collections.Generic;
 using OpenRA.Activities;
 using OpenRA.Mods.Common.Activities;
-using OpenRA.Mods.Common.Traits;
 using OpenRA.Mods.RA.Traits;
 using OpenRA.Traits;
 
-namespace OpenRA.Mods.RA
+namespace OpenRA.Mods.RA.Activities
 {
 	public class HarvesterDockSequence : Activity
 	{
-		enum State { Wait, Turn, Dock, Loop, Undock, Complete }
+		protected enum State { Wait, Turn, Dock, Loop, Undock, Complete }
 
-		readonly Actor proc;
+		protected readonly Actor Refinery;
-		readonly int angle;
+		protected readonly Harvester Harv;
-		readonly Harvester harv;
+		protected readonly int DockAngle;
-		readonly RenderUnit ru;
+		protected readonly bool IsDragRequired;
-		State state;
+		protected readonly WVec DragOffset;
+		protected readonly int DragLength;
+		protected readonly WPos StartDrag;
+		protected readonly WPos EndDrag;
+		
+		protected State dockingState;
 
-		public HarvesterDockSequence(Actor self, Actor proc, int angle)
+		public HarvesterDockSequence(Actor self, Actor refinery, int dockAngle, bool isDragRequired, WVec dragOffset, int dragLength)
 		{
-			this.proc = proc;
+			dockingState = State.Turn;
-			this.angle = angle;
+			Refinery = refinery;
-			state = State.Turn;
+			DockAngle = dockAngle;
-			harv = self.Trait<Harvester>();
+			IsDragRequired = isDragRequired;
-			ru = self.Trait<RenderUnit>();
+			DragOffset = dragOffset;
+			DragLength = dragLength;
+			Harv = self.Trait<Harvester>();
+			StartDrag = self.CenterPosition;
+			EndDrag = refinery.CenterPosition + DragOffset;
 		}
 
 		public override Activity Tick(Actor self)
 		{
-			switch (state)
+			switch (dockingState)
 			{
 				case State.Wait:
 					return this;
 				case State.Turn:
-					state = State.Dock;
+					dockingState = State.Dock;
-					return Util.SequenceActivities(new Turn(self, angle), this);
+					if (IsDragRequired)
+						return Util.SequenceActivities(new Turn(self, DockAngle), new Drag(self, StartDrag, EndDrag, DragLength), this);
+					return Util.SequenceActivities(new Turn(self, DockAngle), this);
 				case State.Dock:
-					ru.PlayCustomAnimation(self, "dock", () =>
+					if (Refinery.IsInWorld && !Refinery.IsDead)
-					{
+						foreach (var nd in Refinery.TraitsImplementing<INotifyDocking>())
-						ru.PlayCustomAnimRepeating(self, "dock-loop");
+							nd.Docked(Refinery, self);
-						if (proc.IsInWorld && !proc.IsDead)
+					return OnStateDock(self);
-							foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
-								nd.Docked(proc, self);
-						state = State.Loop;
-					});
-					state = State.Wait;
-					return this;
 				case State.Loop:
-					if (!proc.IsInWorld || proc.IsDead || harv.TickUnload(self, proc))
+					if (!Refinery.IsInWorld || Refinery.IsDead || Harv.TickUnload(self, Refinery))
-						state = State.Undock;
+						dockingState = State.Undock;
 					return this;
 				case State.Undock:
-					ru.PlayCustomAnimBackwards(self, "dock", () => state = State.Complete);
+					return OnStateUndock(self);
-					state = State.Wait;
-					return this;
 				case State.Complete:
-					harv.LastLinkedProc = harv.LinkedProc;
+					if (Refinery.IsInWorld && !Refinery.IsDead)
-					harv.LinkProc(self, null);
+						foreach (var nd in Refinery.TraitsImplementing<INotifyDocking>())
-					if (proc.IsInWorld && !proc.IsDead)
+							nd.Undocked(Refinery, self);
-						foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
+					Harv.LastLinkedProc = Harv.LinkedProc;
-							nd.Undocked(proc, self);
+					Harv.LinkProc(self, null);
+					if (IsDragRequired)
+						return Util.SequenceActivities(new Drag(self, EndDrag, StartDrag, DragLength), NextActivity);
 					return NextActivity;
 			}
 
@@ -79,13 +83,23 @@ namespace OpenRA.Mods.RA
 
 		public override void Cancel(Actor self)
 		{
-			state = State.Undock;
+			dockingState = State.Undock;
 			base.Cancel(self);
 		}
 
 		public override IEnumerable<Target> GetTargets(Actor self)
 		{
-			yield return Target.FromActor(proc);
+			yield return Target.FromActor(Refinery);
+		}
+
+		public virtual Activity OnStateDock(Actor self)
+		{
+			throw new NotImplementedException("Base class HarvesterDockSequence does not implement method OnStateDock!");
+		}
+
+		public virtual Activity OnStateUndock(Actor self)
+		{
+			throw new NotImplementedException("Base class HarvesterDockSequence does not implement method OnStateUndock!");
 		}
 	}
 }

OpenRA.Mods.RA/Activities/SpriteHarvesterDockSequence.cs

@@ -0,0 +1,40 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2015 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.Activities;
+using OpenRA.Mods.Common.Traits;
+
+namespace OpenRA.Mods.RA.Activities
+{
+	public class SpriteHarvesterDockSequence : HarvesterDockSequence
+	{
+		readonly RenderUnit ru;
+
+		public SpriteHarvesterDockSequence(Actor self, Actor refinery, int dockAngle, bool isDragRequired, WVec dragOffset, int dragLength)
+			: base(self, refinery, dockAngle, isDragRequired, dragOffset, dragLength)
+		{
+			ru = self.Trait<RenderUnit>();
+		}
+
+		public override Activity OnStateDock(Actor self)
+		{
+			ru.PlayCustomAnimation(self, "dock", () => ru.PlayCustomAnimRepeating(self, "dock-loop"));
+			dockingState = State.Loop;
+			return this;
+		}
+
+		public override Activity OnStateUndock(Actor self)
+		{
+			ru.PlayCustomAnimBackwards(self, "dock", () => dockingState = State.Complete);
+			dockingState = State.Wait;
+			return this;
+		}
+	}
+}

OpenRA.Mods.RA/OpenRA.Mods.RA.csproj

@@ -70,6 +70,7 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Activities\SpriteHarvesterDockSequence.cs" />
     <Compile Include="AI\AttackOrFleeFuzzy.cs" />
     <Compile Include="AI\BaseBuilder.cs" />
     <Compile Include="AI\HackyAI.cs" />

OpenRA.Mods.RA/Traits/Buildings/Refinery.cs

@@ -20,15 +20,25 @@ namespace OpenRA.Mods.RA.Traits
 {
 	public class RefineryInfo : ITraitInfo
 	{
+		[Desc("Actual harvester facing when docking, 0-255 counter-clock-wise.")]
+		public readonly int DockAngle = 0;
+
 		[Desc("Docking cell relative to top-left cell.")]
-		public readonly CVec DockOffset = new CVec(1, 2);
+		public readonly CVec DockOffset = CVec.Zero;
+
+		[Desc("Does the refinery require the harvester to be dragged in?")]
+		public readonly bool IsDragRequired = false;
+
+		[Desc("Vector by which the harvester will be dragged when docking.")]
+		public readonly WVec DragOffset = WVec.Zero;
+
+		[Desc("In how many steps to perform the dragging?")]
+		public readonly int DragLength = 0;
 
 		public readonly bool ShowTicks = true;
 		public readonly int TickLifetime = 30;
 		public readonly int TickVelocity = 2;
 		public readonly int TickRate = 10;
-		[Desc("Actual harvester facing when docking, 0-255 counter-clock-wise.")]
-		public readonly int DockAngle = 64;
 
 		public virtual object Create(ActorInitializer init) { return new Refinery(init.Self, this); }
 	}
@@ -48,6 +58,10 @@ namespace OpenRA.Mods.RA.Traits
 
 		public bool AllowDocking { get { return !preventDock; } }
 		public CVec DeliveryOffset { get { return info.DockOffset; } }
+		public int DeliveryAngle { get { return info.DockAngle; } }
+		public bool IsDragRequired { get { return info.IsDragRequired; } }
+		public WVec DragOffset { get { return info.DragOffset; } }
+		public int DragLength { get { return info.DragLength; } }
 
 		public Refinery(Actor self, RefineryInfo info)
 		{
@@ -59,7 +73,7 @@ namespace OpenRA.Mods.RA.Traits
 
 		public virtual Activity DockSequence(Actor harv, Actor self)
 		{
-			return new HarvesterDockSequence(harv, self, info.DockAngle);
+			return new SpriteHarvesterDockSequence(harv, self, DeliveryAngle, IsDragRequired, DragOffset, DragLength);
 		}
 
 		public IEnumerable<TraitPair<Harvester>> GetLinkedHarvesters()

OpenRA.Mods.TS/Activities/VoxelHarvesterDockSequence.cs

@@ -8,70 +8,34 @@
  */
 #endregion
 
-using System;
-using System.Collections.Generic;
 using OpenRA.Activities;
-using OpenRA.Mods.Common.Activities;
+using OpenRA.Mods.RA.Activities;
-using OpenRA.Mods.RA.Traits;
 using OpenRA.Mods.TS.Traits;
-using OpenRA.Traits;
 
 namespace OpenRA.Mods.TS.Activities
 {
-	public class VoxelHarvesterDockSequence : Activity
+	public class VoxelHarvesterDockSequence : HarvesterDockSequence
 	{
-		enum State { Turn, Dock, Loop, Undock }
-
-		readonly Actor proc;
-		readonly Harvester harv;
 		readonly WithVoxelUnloadBody body;
-		State state;
 
-		public VoxelHarvesterDockSequence(Actor self, Actor proc)
+		public VoxelHarvesterDockSequence(Actor self, Actor refinery, int dockAngle, bool isDragRequired, WVec dragOffset, int dragLength)
+			: base(self, refinery, dockAngle, isDragRequired, dragOffset, dragLength)
 		{
-			this.proc = proc;
-			state = State.Turn;
-			harv = self.Trait<Harvester>();
 			body = self.Trait<WithVoxelUnloadBody>();
 		}
 
-		public override Activity Tick(Actor self)
+		public override Activity OnStateDock(Actor self)
 		{
-			switch (state)
+			body.Docked = true;
-			{
+			dockingState = State.Loop;
-				case State.Turn:
+			return this;
-					state = State.Dock;
-					return Util.SequenceActivities(new Turn(self, 160), this);
-				case State.Dock:
-					if (proc.IsInWorld && !proc.IsDead)
-						foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
-							nd.Docked(proc, self);
-					state = State.Loop;
-					body.Docked = true;
-					return this;
-				case State.Loop:
-					if (!proc.IsInWorld || proc.IsDead || harv.TickUnload(self, proc))
-						state = State.Undock;
-					return this;
-				case State.Undock:
-					if (proc.IsInWorld && !proc.IsDead)
-						foreach (var nd in proc.TraitsImplementing<INotifyDocking>())
-							nd.Undocked(proc, self);
-					body.Docked = false;
-					return NextActivity;
-			}
-
-			throw new InvalidOperationException("Invalid harvester dock state");
 		}
 
-		public override void Cancel(Actor self)
+		public override Activity OnStateUndock(Actor self)
 		{
-			state = State.Undock;
+			body.Docked = false;
-		}
+			dockingState = State.Complete;
-
+			return this;
-		public override IEnumerable<Target> GetTargets(Actor self)
-		{
-			yield return Target.FromActor(proc);
 		}
 	}
-}
+}

OpenRA.Mods.TS/Traits/Buildings/TiberianSunRefinery.cs

@@ -25,7 +25,7 @@ namespace OpenRA.Mods.TS.Traits
 
 		public override Activity DockSequence(Actor harv, Actor self)
 		{
-			return new VoxelHarvesterDockSequence(harv, self);
+			return new VoxelHarvesterDockSequence(harv, self, DeliveryAngle, IsDragRequired, DragOffset, DragLength);
 		}
 	}
 }