Split *AimAnimation from WithTurretAttackAnimation

These two didn't interact and actually even conflicted when used at the same time, so splitting them is the sensible thing to do.

OpenRA.Mods.Common/OpenRA.Mods.Common.csproj

@@ -423,6 +423,7 @@
     <Compile Include="Traits\Render\RenderSpritesEditorOnly.cs" />
     <Compile Include="Traits\Render\WithTurretAttackAnimation.cs" />
     <Compile Include="Traits\Render\WithAcceptDeliveredCashAnimation.cs" />
+    <Compile Include="Traits\Render\WithTurretAimAnimation.cs" />
     <Compile Include="Traits\Render\RenderUtils.cs" />
     <Compile Include="Traits\Render\RenderDebugState.cs" />
     <Compile Include="Traits\Render\RenderNameTag.cs" />

OpenRA.Mods.Common/Traits/Render/WithTurretAimAnimation.cs

@@ -0,0 +1,68 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2018 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, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System.Linq;
+using OpenRA.Traits;
+
+namespace OpenRA.Mods.Common.Traits.Render
+{
+	public class WithTurretAimAnimationInfo : ITraitInfo, Requires<WithSpriteTurretInfo>, Requires<ArmamentInfo>, Requires<AttackBaseInfo>
+	{
+		[Desc("Armament name")]
+		public readonly string Armament = "primary";
+
+		[Desc("Turret name")]
+		public readonly string Turret = "primary";
+
+		[Desc("Displayed while targeting.")]
+		[SequenceReference] public readonly string Sequence = null;
+
+		[Desc("Shown while reloading.")]
+		[SequenceReference(null, true)] public readonly string ReloadPrefix = null;
+
+		public object Create(ActorInitializer init) { return new WithTurretAimAnimation(init, this); }
+	}
+
+	public class WithTurretAimAnimation : ITick
+	{
+		readonly WithTurretAimAnimationInfo info;
+		readonly AttackBase attack;
+		readonly Armament armament;
+		readonly WithSpriteTurret wst;
+
+		public WithTurretAimAnimation(ActorInitializer init, WithTurretAimAnimationInfo info)
+		{
+			this.info = info;
+			attack = init.Self.Trait<AttackBase>();
+			armament = init.Self.TraitsImplementing<Armament>()
+				.Single(a => a.Info.Name == info.Armament);
+			wst = init.Self.TraitsImplementing<WithSpriteTurret>()
+				.Single(st => st.Info.Turret == info.Turret);
+		}
+
+		void ITick.Tick(Actor self)
+		{
+			if (string.IsNullOrEmpty(info.Sequence) && string.IsNullOrEmpty(info.ReloadPrefix))
+				return;
+
+			var sequence = wst.Info.Sequence;
+			if (!string.IsNullOrEmpty(info.Sequence) && attack.IsAiming)
+				sequence = info.Sequence;
+
+			var prefix = (armament.IsReloading && !string.IsNullOrEmpty(info.ReloadPrefix)) ? info.ReloadPrefix : "";
+
+			if (!string.IsNullOrEmpty(prefix) && sequence != (prefix + sequence))
+				sequence = prefix + sequence;
+
+			wst.DefaultAnimation.ReplaceAnim(sequence);
+		}
+	}
+}

OpenRA.Mods.Common/Traits/Render/WithTurretAttackAnimation.cs

@@ -14,7 +14,7 @@ using OpenRA.Traits;
 
 namespace OpenRA.Mods.Common.Traits.Render
 {
-	public class WithTurretAttackAnimationInfo : ITraitInfo, Requires<WithSpriteTurretInfo>, Requires<ArmamentInfo>, Requires<AttackBaseInfo>
+	public class WithTurretAttackAnimationInfo : ITraitInfo, Requires<WithSpriteTurretInfo>, Requires<ArmamentInfo>
 	{
 		[Desc("Armament name")]
 		public readonly string Armament = "primary";
@@ -23,13 +23,7 @@ namespace OpenRA.Mods.Common.Traits.Render
 		public readonly string Turret = "primary";
 
 		[Desc("Displayed while attacking.")]
-		[SequenceReference] public readonly string AttackSequence = null;
+		[SequenceReference] public readonly string Sequence = null;
-
-		[Desc("Displayed while targeting.")]
-		[SequenceReference] public readonly string AimSequence = null;
-
-		[Desc("Shown while reloading.")]
-		[SequenceReference(null, true)] public readonly string ReloadPrefix = null;
 
 		[Desc("Delay in ticks before animation starts, either relative to attack preparation or attack.")]
 		public readonly int Delay = 0;
@@ -43,8 +37,6 @@ namespace OpenRA.Mods.Common.Traits.Render
 	public class WithTurretAttackAnimation : ITick, INotifyAttack
 	{
 		readonly WithTurretAttackAnimationInfo info;
-		readonly AttackBase attack;
-		readonly Armament armament;
 		readonly WithSpriteTurret wst;
 
 		int tick;
@@ -52,21 +44,21 @@ namespace OpenRA.Mods.Common.Traits.Render
 		public WithTurretAttackAnimation(ActorInitializer init, WithTurretAttackAnimationInfo info)
 		{
 			this.info = info;
-			attack = init.Self.Trait<AttackBase>();
-			armament = init.Self.TraitsImplementing<Armament>()
-				.Single(a => a.Info.Name == info.Armament);
 			wst = init.Self.TraitsImplementing<WithSpriteTurret>()
 				.Single(st => st.Info.Turret == info.Turret);
 		}
 
 		void PlayAttackAnimation(Actor self)
 		{
-			if (!string.IsNullOrEmpty(info.AttackSequence))
+			if (!string.IsNullOrEmpty(info.Sequence))
-				wst.PlayCustomAnimation(self, info.AttackSequence);
+				wst.PlayCustomAnimation(self, info.Sequence);
 		}
 
 		void INotifyAttack.Attacking(Actor self, Target target, Armament a, Barrel barrel)
 		{
+			if (a.Info.Name != info.Armament)
+				return;
+
 			if (info.DelayRelativeTo == AttackDelayType.Attack)
 			{
 				if (info.Delay > 0)
@@ -78,6 +70,9 @@ namespace OpenRA.Mods.Common.Traits.Render
 
 		void INotifyAttack.PreparingAttack(Actor self, Target target, Armament a, Barrel barrel)
 		{
+			if (a.Info.Name != info.Armament)
+				return;
+
 			if (info.DelayRelativeTo == AttackDelayType.Preparation)
 			{
 				if (info.Delay > 0)
@@ -91,20 +86,6 @@ namespace OpenRA.Mods.Common.Traits.Render
 		{
 			if (info.Delay > 0 && --tick == 0)
 				PlayAttackAnimation(self);
-
-			if (string.IsNullOrEmpty(info.AimSequence) && string.IsNullOrEmpty(info.ReloadPrefix))
-				return;
-
-			var sequence = wst.Info.Sequence;
-			if (!string.IsNullOrEmpty(info.AimSequence) && attack.IsAiming)
-				sequence = info.AimSequence;
-
-			var prefix = (armament.IsReloading && !string.IsNullOrEmpty(info.ReloadPrefix)) ? info.ReloadPrefix : "";
-
-			if (!string.IsNullOrEmpty(prefix) && sequence != (prefix + sequence))
-				sequence = prefix + sequence;
-
-			wst.DefaultAnimation.ReplaceAnim(sequence);
 		}
 	}
 }

OpenRA.Mods.Common/UtilityCommands/UpgradeRules.cs

@@ -1709,6 +1709,53 @@ namespace OpenRA.Mods.Common.UtilityCommands
 					}
 				}
 
+				// Split aim animation logic from WithTurretAttackAnimation to separate WithTurretAimAnimation
+				if (engineVersion < 20180223)
+				{
+					var turAttackAnim = node.Value.Nodes.FirstOrDefault(n => n.Key.StartsWith("WithTurretAttackAnimation", StringComparison.Ordinal));
+					if (turAttackAnim != null)
+					{
+						var atkSequence = turAttackAnim.Value.Nodes.FirstOrDefault(n => n.Key == "AttackSequence");
+						var aimSequence = turAttackAnim.Value.Nodes.FirstOrDefault(n => n.Key == "AimSequence");
+
+						// If only AimSequence is null, just rename AttackSequence to Sequence (ReloadPrefix is very unlikely to be defined in that case).
+						// If only AttackSequence is null, just rename the trait and property (the delay properties will likely be undefined).
+						// If both aren't null, split/copy everything relevant to the new WithTurretAimAnimation.
+						// If both are null (extremely unlikely), do nothing.
+						if (atkSequence == null && aimSequence != null)
+						{
+							RenameNodeKey(turAttackAnim, "WithTurretAimAnimation");
+							RenameNodeKey(aimSequence, "Sequence");
+						}
+						else if (atkSequence != null && aimSequence == null)
+							RenameNodeKey(atkSequence, "Sequence");
+						else if (atkSequence != null && aimSequence != null)
+						{
+							var aimAnim = new MiniYamlNode("WithTurretAimAnimation", "");
+							RenameNodeKey(aimSequence, "Sequence");
+							aimAnim.Value.Nodes.Add(aimSequence);
+							turAttackAnim.Value.Nodes.Remove(aimSequence);
+
+							var relPrefix = turAttackAnim.Value.Nodes.FirstOrDefault(n => n.Key == "ReloadPrefix");
+							var turr = turAttackAnim.Value.Nodes.FirstOrDefault(n => n.Key == "Turret");
+							var arm = turAttackAnim.Value.Nodes.FirstOrDefault(n => n.Key == "Armament");
+							if (relPrefix != null)
+							{
+								aimAnim.Value.Nodes.Add(relPrefix);
+								turAttackAnim.Value.Nodes.Remove(relPrefix);
+							}
+
+							if (turr != null)
+								aimAnim.Value.Nodes.Add(turr);
+							if (arm != null)
+								aimAnim.Value.Nodes.Add(arm);
+
+							RenameNodeKey(atkSequence, "Sequence");
+							node.Value.Nodes.Add(aimAnim);
+						}
+					}
+				}
+
 				UpgradeActorRules(modData, engineVersion, ref node.Value.Nodes, node, depth + 1);
 			}