Add FilenamePattern support to sequences.

OpenRA.Mods.Cnc/Graphics/ClassicTilesetSpecificSpriteSequence.cs

@@ -10,6 +10,7 @@
 #endregion
 
 using System.Collections.Generic;
+using System.Linq;
 using OpenRA.Graphics;
 using OpenRA.Mods.Common.Graphics;
 
@@ -33,11 +34,28 @@ public class ClassicTilesetSpecificSpriteSequence : ClassicSpriteSequence
 		[Desc("Dictionary of <tileset name>: filename to override the Filename key.")]
 		static readonly SpriteSequenceField<Dictionary<string, string>> TilesetFilenames = new(nameof(TilesetFilenames), null);
 
+		[Desc("Dictionary of <tileset name>: <filename pattern> to override the FilenamePattern key.")]
+		static readonly SpriteSequenceField<Dictionary<string, string>> TilesetFilenamesPattern = new(nameof(TilesetFilenamesPattern), null);
+
 		public ClassicTilesetSpecificSpriteSequence(SpriteCache cache, ISpriteSequenceLoader loader, string image, string sequence, MiniYaml data, MiniYaml defaults)
 			: base(cache, loader, image, sequence, data, defaults) { }
 
 		protected override IEnumerable<ReservationInfo> ParseFilenames(ModData modData, string tileset, int[] frames, MiniYaml data, MiniYaml defaults)
 		{
+			var tilesetFilenamesPatternNode = data.NodeWithKeyOrDefault(TilesetFilenamesPattern.Key) ?? defaults.NodeWithKeyOrDefault(TilesetFilenamesPattern.Key);
+			if (tilesetFilenamesPatternNode != null)
+			{
+				var tilesetNode = tilesetFilenamesPatternNode.Value.NodeWithKeyOrDefault(tileset);
+				if (tilesetNode != null)
+				{
+					var patternStart = LoadField("Start", 0, tilesetNode.Value);
+					var patternCount = LoadField("Count", 1, tilesetNode.Value);
+
+					return Enumerable.Range(patternStart, patternCount).Select(i =>
+						new ReservationInfo(tilesetNode.Value.Value.FormatInvariant(i), FirstFrame, FirstFrame, tilesetNode.Location));
+				}
+			}
+
 			var node = data.NodeWithKeyOrDefault(TilesetFilenames.Key) ?? defaults.NodeWithKeyOrDefault(TilesetFilenames.Key);
 			if (node != null)
 			{

OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs

@@ -120,6 +120,9 @@ public ReservationInfo(string filename, List<int> loadFrames, int[] frames, Mini
 		[Desc("File name of the sprite to use for this sequence.")]
 		protected static readonly SpriteSequenceField<string> Filename = new(nameof(Filename), null);
 
+		[Desc("File name pattern to build the sprite to use for this sequence.")]
+		protected static readonly SpriteSequenceField<string> FilenamePattern = new(nameof(FilenamePattern), null);
+
 		[Desc("Frame index to start from.")]
 		protected static readonly SpriteSequenceField<int> Start = new(nameof(Start), 0);
 
@@ -199,6 +202,8 @@ public ReservationInfo(string filename, List<int> loadFrames, int[] frames, Mini
 		protected static readonly SpriteSequenceField<float2> DepthSpriteOffset = new(nameof(DepthSpriteOffset), float2.Zero);
 
 		protected static readonly MiniYaml NoData = new(null);
+		protected static readonly int[] FirstFrame = { 0 };
+
 		protected readonly ISpriteSequenceLoader Loader;
 
 		protected string image;
@@ -330,10 +335,21 @@ protected static List<int> CalculateFrameIndices(int start, int? length, int str
 
 		protected virtual IEnumerable<ReservationInfo> ParseFilenames(ModData modData, string tileset, int[] frames, MiniYaml data, MiniYaml defaults)
 		{
+			var filenamePatternNode = data.NodeWithKeyOrDefault(FilenamePattern.Key) ?? defaults.NodeWithKeyOrDefault(FilenamePattern.Key);
+			if (!string.IsNullOrEmpty(filenamePatternNode?.Value.Value))
+			{
+				var patternStart = LoadField("Start", 0, filenamePatternNode.Value);
+				var patternCount = LoadField("Count", 1, filenamePatternNode.Value);
+
+				return Enumerable.Range(patternStart, patternCount).Select(i =>
+					new ReservationInfo(filenamePatternNode.Value.Value.FormatInvariant(i),
+						FirstFrame, FirstFrame, filenamePatternNode.Location));
+			}
+
 			var filename = LoadField(Filename, data, defaults, out var location);
 
 			var loadFrames = CalculateFrameIndices(start, length, stride ?? length ?? 0, facings, frames, transpose, reverseFacings, shadowStart);
-			yield return new ReservationInfo(filename, loadFrames, frames, location);
+			return new[] { new ReservationInfo(filename, loadFrames, frames, location) };
 		}
 
 		protected virtual IEnumerable<ReservationInfo> ParseCombineFilenames(ModData modData, string tileset, int[] frames, MiniYaml data)

OpenRA.Mods.Common/Graphics/TilesetSpecificSpriteSequence.cs

@@ -10,6 +10,7 @@
 #endregion
 
 using System.Collections.Generic;
+using System.Linq;
 using OpenRA.Graphics;
 
 namespace OpenRA.Mods.Common.Graphics
@@ -31,11 +32,28 @@ public class TilesetSpecificSpriteSequence : DefaultSpriteSequence
 		[Desc("Dictionary of <tileset name>: filename to override the Filename key.")]
 		static readonly SpriteSequenceField<Dictionary<string, string>> TilesetFilenames = new(nameof(TilesetFilenames), null);
 
+		[Desc("Dictionary of <tileset name>: <filename pattern> to override the FilenamePattern key.")]
+		static readonly SpriteSequenceField<Dictionary<string, string>> TilesetFilenamesPattern = new(nameof(TilesetFilenamesPattern), null);
+
 		public TilesetSpecificSpriteSequence(SpriteCache cache, ISpriteSequenceLoader loader, string image, string sequence, MiniYaml data, MiniYaml defaults)
 			: base(cache, loader, image, sequence, data, defaults) { }
 
 		protected override IEnumerable<ReservationInfo> ParseFilenames(ModData modData, string tileset, int[] frames, MiniYaml data, MiniYaml defaults)
 		{
+			var tilesetFilenamesPatternNode = data.NodeWithKeyOrDefault(TilesetFilenamesPattern.Key) ?? defaults.NodeWithKeyOrDefault(TilesetFilenamesPattern.Key);
+			if (tilesetFilenamesPatternNode != null)
+			{
+				var tilesetNode = tilesetFilenamesPatternNode.Value.NodeWithKeyOrDefault(tileset);
+				if (tilesetNode != null)
+				{
+					var patternStart = LoadField("Start", 0, tilesetNode.Value);
+					var patternCount = LoadField("Count", 1, tilesetNode.Value);
+
+					return Enumerable.Range(patternStart, patternCount).Select(i =>
+						new ReservationInfo(tilesetNode.Value.Value.FormatInvariant(i), FirstFrame, FirstFrame, tilesetNode.Location));
+				}
+			}
+
 			var node = data.NodeWithKeyOrDefault(TilesetFilenames.Key) ?? defaults.NodeWithKeyOrDefault(TilesetFilenames.Key);
 			if (node != null)
 			{