Merge pull request #3571 from pchote/split-shadows

Add support for TS/RA2 split-shadows.

OpenRA.Game/Graphics/Animation.cs

@@ -9,6 +9,7 @@
 #endregion
 
 using System;
+using System.Collections.Generic;
 
 namespace OpenRA.Graphics
 {
@@ -34,14 +35,23 @@ namespace OpenRA.Graphics
 			this.facingFunc = facingFunc;
 		}
 
-		public Sprite Image
+		int CurrentFrame { get { return backwards ? CurrentSequence.Start + CurrentSequence.Length - frame - 1 : frame; } }
+		public Sprite Image { get { return CurrentSequence.GetSprite(CurrentFrame, facingFunc()); } }
+
+		public IEnumerable<IRenderable> Render(WPos pos, int zOffset, PaletteReference palette, float scale)
 		{
-			get
+			if (CurrentSequence.ShadowStart >= 0)
 			{
-				return backwards
+				var shadow = CurrentSequence.GetShadow(CurrentFrame, facingFunc());
-					? CurrentSequence.GetSprite(CurrentSequence.End - frame - 1, facingFunc())
+				yield return new SpriteRenderable(shadow, pos, CurrentSequence.ShadowZOffset + zOffset, palette, scale);
-					: CurrentSequence.GetSprite(frame, facingFunc());
 			}
+
+			yield return new SpriteRenderable(Image, pos, CurrentSequence.ZOffset + zOffset, palette, scale);
+		}
+
+		public IEnumerable<IRenderable> Render(WPos pos, PaletteReference palette)
+		{
+			return Render(pos, 0, palette, 1f);
 		}
 
 		public void Play(string sequenceName)

OpenRA.Game/Graphics/AnimationWithOffset.cs

@@ -9,6 +9,7 @@
 #endregion
 
 using System;
+using System.Collections.Generic;
 using OpenRA.Traits;
 
 namespace OpenRA.Graphics
@@ -34,19 +35,14 @@ namespace OpenRA.Graphics
 			this.ZOffset = zOffset;
 		}
 
-		public IRenderable Image(Actor self, WorldRenderer wr, PaletteReference pal)
+		public IEnumerable<IRenderable> Render(Actor self, WorldRenderer wr, PaletteReference pal, float scale)
-		{
-			return Image(self, wr, pal, 1f);
-		}
-
-		public IRenderable Image(Actor self, WorldRenderer wr, PaletteReference pal, float scale)
 		{
 			var p = self.CenterPosition;
 			if (OffsetFunc != null)
 				p += OffsetFunc();
 
 			var z = (ZOffset != null) ? ZOffset(p) : 0;
-			return new SpriteRenderable(Animation.Image, p, z, pal, scale);
+			return Animation.Render(p, z, pal, scale);
 		}
 
 		public static implicit operator AnimationWithOffset(Animation a)

OpenRA.Game/Graphics/Renderable.cs

@@ -10,6 +10,7 @@
 
 using System.Collections.Generic;
 using System.Drawing;
+using System.Linq;
 
 namespace OpenRA.Graphics
 {
@@ -47,6 +48,8 @@ namespace OpenRA.Graphics
 
 	public struct SpriteRenderable : IRenderable
 	{
+		public static readonly IEnumerable<IRenderable> None = new IRenderable[0].AsEnumerable();
+
 		readonly Sprite sprite;
 		readonly WPos pos;
 		readonly int zOffset;

OpenRA.Game/Graphics/Sequence.cs

@@ -9,7 +9,6 @@
 #endregion
 
 using System;
-using System.Xml;
 using System.Collections.Generic;
 using System.Linq;
 using OpenRA.FileFormats;
@@ -19,16 +18,17 @@ namespace OpenRA.Graphics
 	public class Sequence
 	{
 		readonly Sprite[] sprites;
-		readonly int start, length, stride, facings, tick;
 		readonly bool reverseFacings, transpose;
 
 		public readonly string Name;
-		public int Start { get { return start; } }
+		public readonly int Start;
-		public int End { get { return start + length; } }
+		public readonly int Length;
-		public int Length { get { return length; } }
+		public readonly int Stride;
-		public int Stride { get { return stride; } }
+		public readonly int Facings;
-		public int Facings { get { return facings; } }
+		public readonly int Tick;
-		public int Tick { get { return tick; } }
+		public readonly int ZOffset;
+		public readonly int ShadowStart;
+		public readonly int ShadowZOffset;
 
 		public Sequence(string unit, string name, MiniYaml info)
 		{
@@ -37,7 +37,7 @@ namespace OpenRA.Graphics
 			var d = info.NodesDict;
 			var offset = float2.Zero;
 
-			start = int.Parse(d["Start"].Value);
+			Start = int.Parse(d["Start"].Value);
 
 			if (d.ContainsKey("Offset"))
 				offset = FieldLoader.GetValue<float2>("Offset", d["Offset"].Value);
@@ -48,60 +48,83 @@ namespace OpenRA.Graphics
 				s => new Sprite(s.sheet, s.bounds, s.offset + offset, s.channel)).ToArray();
 
 			if (!d.ContainsKey("Length"))
-				length = 1;
+				Length = 1;
 			else if (d["Length"].Value == "*")
-				length = sprites.Length - Start;
+				Length = sprites.Length - Start;
 			else
-				length = int.Parse(d["Length"].Value);
+				Length = int.Parse(d["Length"].Value);
 
 			if (d.ContainsKey("Stride"))
-				stride = int.Parse(d["Stride"].Value);
+				Stride = int.Parse(d["Stride"].Value);
 			else
-				stride = length;
+				Stride = Length;
 
 			if (d.ContainsKey("Facings"))
 			{
 				var f = int.Parse(d["Facings"].Value);
-				facings = Math.Abs(f);
+				Facings = Math.Abs(f);
 				reverseFacings = f < 0;
 			}
 			else
-				facings = 1;
+				Facings = 1;
 
 			if (d.ContainsKey("Tick"))
-				tick = int.Parse(d["Tick"].Value);
+				Tick = int.Parse(d["Tick"].Value);
 			else
-				tick = 40;
+				Tick = 40;
 
 			if (d.ContainsKey("Transpose"))
 			    transpose = bool.Parse(d["Transpose"].Value);
 
-			if (length > stride)
+			if (d.ContainsKey("ShadowStart"))
+				ShadowStart = int.Parse(d["ShadowStart"].Value);
+			else
+				ShadowStart = -1;
+
+			if (d.ContainsKey("ShadowZOffset"))
+				ShadowZOffset = int.Parse(d["ShadowZOffset"].Value);
+			else
+				ShadowZOffset = -5;
+
+			if (d.ContainsKey("ZOffset"))
+				ZOffset = int.Parse(d["ZOffset"].Value);
+
+			if (Length > Stride)
 				throw new InvalidOperationException(
 					"{0}: Sequence {1}.{2}: Length must be <= stride"
 						.F(info.Nodes[0].Location, unit, name));
 
-			if (start < 0 || start + facings * stride > sprites.Length)
+			if (Start < 0 || Start + Facings * Stride > sprites.Length || ShadowStart + Facings * Stride > sprites.Length)
 				throw new InvalidOperationException(
 					"{6}: Sequence {0}.{1} uses frames [{2}..{3}] of SHP `{4}`, but only 0..{5} actually exist"
-					.F(unit, name, start, start + facings * stride - 1, srcOverride ?? unit, sprites.Length - 1,
+					.F(unit, name, Start, Start + Facings * Stride - 1, srcOverride ?? unit, sprites.Length - 1,
 					info.Nodes[0].Location));
 		}
 
 		public Sprite GetSprite(int frame)
 		{
-			return GetSprite(frame, 0);
+			return GetSprite(Start, frame, 0);
 		}
 
 		public Sprite GetSprite(int frame, int facing)
 		{
-			var f = Traits.Util.QuantizeFacing(facing, facings);
+			return GetSprite(Start, frame, facing);
+		}
+
+		public Sprite GetShadow(int frame, int facing)
+		{
+			return ShadowStart >= 0 ? GetSprite(ShadowStart, frame, facing) : null;
+		}
+
+		Sprite GetSprite(int start, int frame, int facing)
+		{
+			var f = Traits.Util.QuantizeFacing(facing, Facings);
 
 			if (reverseFacings)
-				f = (facings - f) % facings;
+				f = (Facings - f) % Facings;
 
-			int i = transpose ? (frame % length) * facings + f :
+			int i = transpose ? (frame % Length) * Facings + f :
-				(f * stride) + (frame % length);
+				(f * Stride) + (frame % Length);
 
 			return sprites[start + i];
 		}

OpenRA.Game/Traits/Render/RenderSimple.cs

@@ -25,7 +25,7 @@ namespace OpenRA.Traits
 			var anim = new Animation(RenderSimple.GetImage(ai), () => 0);
 			anim.PlayRepeating("idle");
 
-			yield return new SpriteRenderable(anim.Image, WPos.Zero, 0, pr, 1f);
+			return anim.Render(WPos.Zero, pr);
 		}
 	}
 

OpenRA.Game/Traits/Render/RenderSprites.cs

@@ -90,8 +90,13 @@ namespace OpenRA.Traits
 			}
 
 			foreach (var a in anims.Values)
-				if (a.DisableFunc == null || !a.DisableFunc())
+			{
-					yield return a.Image(self, wr, palette, Info.Scale);
+				if (a.DisableFunc != null && a.DisableFunc())
+					continue;
+
+				foreach (var r in a.Render(self, wr, palette, Info.Scale))
+					yield return r;
+			}
 		}
 
 		public virtual void Tick(Actor self)

OpenRA.Mods.Cnc/Effects/IonCannon.cs

@@ -34,7 +34,7 @@ namespace OpenRA.Mods.Cnc.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(anim.Image, target.CenterPosition, 1, wr.Palette("effect"), 1.0f);
+			return anim.Render(target.CenterPosition, wr.Palette("effect"));
 		}
 
 		void Finish(World world)

OpenRA.Mods.RA/Cloak.cs

@@ -66,8 +66,6 @@ namespace OpenRA.Mods.RA
 			if (!canCloak) Uncloak();
 		}
 
-		static readonly IRenderable[] Nothing = { };
-
 		public IEnumerable<IRenderable> ModifyRender(Actor self, WorldRenderer wr, IEnumerable<IRenderable> r)
 		{
 			if (remainingTime > 0)
@@ -79,7 +77,7 @@ namespace OpenRA.Mods.RA
 				else
 					return r.Select(a => a.WithPalette(wr.Palette(info.Palette)));
 			else
-				return Nothing;
+				return SpriteRenderable.None;
 		}
 
 		public void Tick(Actor self)

OpenRA.Mods.RA/Effects/Corpse.cs

@@ -33,7 +33,7 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(Anim.Image, Pos, 0, wr.Palette(PaletteName), 1f);
+			return Anim.Render(Pos, wr.Palette(PaletteName));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/CrateEffect.cs

@@ -34,9 +34,10 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			if (a.IsInWorld)
+			if (!a.IsInWorld)
-				yield return new SpriteRenderable(anim.Image,
+				return SpriteRenderable.None;
-					a.CenterPosition, 0, wr.Palette("effect"), 1f);
+
+			return anim.Render(a.CenterPosition, wr.Palette("effect"));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/Explosion.cs

@@ -31,7 +31,7 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(anim.Image, pos, 0, wr.Palette("effect"), 1f);
+			return anim.Render(pos, wr.Palette("effect"));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/GpsDot.cs

@@ -80,10 +80,10 @@ namespace OpenRA.Mods.RA.Effects
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
 			if (!show || self.Destroyed)
-				yield break;
+				return SpriteRenderable.None;
 
 			var palette = wr.Palette(info.IndicatorPalettePrefix+self.Owner.InternalName);
-			yield return new SpriteRenderable(anim.Image, self.CenterPosition, 0, palette, 1f);
+			return anim.Render(self.CenterPosition, palette);
 		}
 	}
 }

OpenRA.Mods.RA/Effects/GpsSatellite.cs

@@ -37,7 +37,7 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(Anim.Image, Pos, 0, wr.Palette("effect"), 1f);
+			return Anim.Render(Pos, wr.Palette("effect"));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/NukeLaunch.cs

@@ -75,7 +75,7 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(anim.Image, pos, 0, wr.Palette("effect"), 1f);
+			return anim.Render(pos, wr.Palette("effect"));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/Parachute.cs

@@ -76,7 +76,8 @@ namespace OpenRA.Mods.RA.Effects
 				yield return c.WithPos(pos);
 			}
 
-			yield return new SpriteRenderable(paraAnim.Image, pos + parachuteOffset, 1, rc.First().Palette, 1f);
+			foreach (var r in paraAnim.Render(pos + parachuteOffset, 1, rc.First().Palette, 1f))
+				yield return r;
 		}
 	}
 }

OpenRA.Mods.RA/Effects/PowerdownIndicator.cs

@@ -36,9 +36,10 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			if (!a.Destroyed && a.Owner.IsAlliedWith(a.World.RenderPlayer))
+			if (a.Destroyed || a.Owner.IsAlliedWith(a.World.RenderPlayer))
-				yield return new SpriteRenderable(anim.Image, a.CenterPosition, 0,
+				return SpriteRenderable.None;
-					wr.Palette("chrome"), 1f);
+
+			return anim.Render(a.CenterPosition, wr.Palette("chrome"));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/RallyPoint.cs

@@ -50,14 +50,15 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			if (building.IsInWorld && building.Owner == building.World.LocalPlayer
+			if (building.Owner != building.World.LocalPlayer)
-				&& building.World.Selection.Actors.Contains(building))
+				return SpriteRenderable.None;
-			{
+
+			if (!building.IsInWorld || !building.World.Selection.Actors.Contains(building))
+				return SpriteRenderable.None;
+
 			var pos = cachedLocation.CenterPosition;
 			var palette = wr.Palette(palettePrefix+building.Owner.InternalName);
-				yield return new SpriteRenderable(circles.Image, pos, 0, palette, 1f);
+			return circles.Render(pos, palette).Concat(flag.Render(pos, palette));
-				yield return new SpriteRenderable(flag.Image, pos, 0, palette, 1f);
-			}
 		}
 	}
 }

OpenRA.Mods.RA/Effects/RepairIndicator.cs

@@ -44,11 +44,11 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			if (!building.Destroyed)
+			if (building.Destroyed)
-			{
+				return SpriteRenderable.None;
-				yield return new SpriteRenderable(anim.Image, building.CenterPosition, 0,
+
-					wr.Palette(palettePrefix+player.InternalName), 1f);
+			return anim.Render(building.CenterPosition,
-			}
+					wr.Palette(palettePrefix+player.InternalName));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/SatelliteLaunch.cs

@@ -39,7 +39,7 @@ namespace OpenRA.Mods.RA.Effects
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(doors.Image, pos, 0, wr.Palette("effect"), 1f);
+			return doors.Render(pos, wr.Palette("effect"));
 		}
 	}
 }

OpenRA.Mods.RA/Effects/Smoke.cs

@@ -28,14 +28,14 @@ namespace OpenRA.Mods.RA.Effects
 				() => world.AddFrameEndTask(w => w.Remove(this)));
 		}
 
-		public void Tick( World world )
+		public void Tick(World world)
 		{
 			Anim.Tick();
 		}
 
 		public IEnumerable<IRenderable> Render(WorldRenderer wr)
 		{
-			yield return new SpriteRenderable(Anim.Image, Pos, 0, wr.Palette("effect"), 1f);
+			return Anim.Render(Pos, wr.Palette("effect"));
 		}
 	}
 }

OpenRA.Mods.RA/Render/RenderBuildingWarFactory.cs

@@ -29,12 +29,10 @@ namespace OpenRA.Mods.RA.Render
 		public override IEnumerable<IRenderable> RenderPreview(ActorInfo building, PaletteReference pr)
 		{
 			var p = BaseBuildingPreview(building, pr);
-			foreach (var r in p)
-				yield return r;
-
 			var anim = new Animation(RenderSprites.GetImage(building), () => 0);
 			anim.PlayRepeating("idle-top");
-			yield return new SpriteRenderable(anim.Image, WPos.Zero, 0, pr, 1f);
+
+			return p.Concat(anim.Render(WPos.Zero, pr));
 		}
 	}
 

OpenRA.Mods.RA/Render/RenderEditorOnly.cs

@@ -23,7 +23,6 @@ namespace OpenRA.Mods.RA.Render
 	{
 		public RenderEditorOnly(Actor self) : base(self, () => 0) { }
 
-		static readonly IRenderable[] Nothing = { };
+		public override IEnumerable<IRenderable> Render(Actor self, WorldRenderer wr) { return SpriteRenderable.None; }
-		public override IEnumerable<IRenderable> Render(Actor self, WorldRenderer wr) { return Nothing; }
 	}
 }

OpenRA.Mods.RA/Render/WithHarvestAnimation.cs

@@ -24,9 +24,6 @@ namespace OpenRA.Mods.RA.Render
 		[Desc("Position relative to body")]
 		public readonly WVec Offset = WVec.Zero;
 
-		[Desc("Additional draw-order offset")]
-		public readonly int ZOffset = 0;
-
 		public object Create(ActorInitializer init) { return new WithHarvestAnimation(init.self, this); }
 	}
 
@@ -47,7 +44,7 @@ namespace OpenRA.Mods.RA.Render
 			rs.anims.Add("harvest_{0}".F(info.Sequence), new AnimationWithOffset(anim,
 				() => body.LocalToWorld(info.Offset.Rotate(body.QuantizeOrientation(self, self.Orientation))),
 				() => !visible,
-			    p => WithTurret.ZOffsetFromCenter(self, p, info.ZOffset)));
+			    p => WithTurret.ZOffsetFromCenter(self, p, 0)));
 		}
 
 		public void Harvested(Actor self, ResourceType resource)

OpenRA.Mods.RA/Render/WithMuzzleFlash.cs

@@ -62,8 +62,13 @@ namespace OpenRA.Mods.RA.Render
 		public IEnumerable<IRenderable> Render(Actor self, WorldRenderer wr)
 		{
 			foreach (var a in muzzleFlashes.Values)
-				if (a.DisableFunc == null || !a.DisableFunc())
+			{
-					yield return a.Image(self, wr, wr.Palette("effect"));
+				if (a.DisableFunc != null && a.DisableFunc())
+					continue;
+
+				foreach (var r in a.Render(self, wr, wr.Palette("effect"), 1f))
+					yield return r;
+			}
 		}
 
 		public void Tick(Actor self)

mods/cnc/sequences/misc.yaml

@@ -224,6 +224,7 @@ ionsfx:
 		Start: 0
 		Length: *
 		Offset: 0, -78
+		ZOffset: 1
 
 bomblet:
 	idle:

mods/d2k/rules/vehicles.yaml

@@ -89,7 +89,6 @@ HARVESTER:
 	LeavesHusk:
 		HuskActor: Harvester.Husk
 	WithHarvestAnimation:
-		ZOffset: 1
 
 HARVESTER.Husk:
 	Inherits: ^Husk

mods/d2k/sequences.yaml

@@ -72,6 +72,7 @@ harvester:
 		Length: 6
 		Facings: 8
 		Tick: 80
+		ZOffset: 1
 	dock: unload2
 		Start: 0
 		Length: 10