c3c5dbfa35
To prepare them for documentation generation. Also added descriptions to SpriteSequence implementations and their properties. Also made a few code style fixes.
104 lines
4.2 KiB
C#
104 lines
4.2 KiB
C#
#region Copyright & License Information
|
|
/*
|
|
* Copyright 2007-2022 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.Collections.Generic;
|
|
using System.Linq;
|
|
using OpenRA.Graphics;
|
|
|
|
namespace OpenRA.Mods.Cnc.Graphics
|
|
{
|
|
public class ClassicTilesetSpecificSpriteSequenceLoader : ClassicSpriteSequenceLoader
|
|
{
|
|
public readonly string DefaultSpriteExtension = ".shp";
|
|
public readonly Dictionary<string, string> TilesetExtensions = new Dictionary<string, string>();
|
|
public readonly Dictionary<string, string> TilesetCodes = new Dictionary<string, string>();
|
|
|
|
public ClassicTilesetSpecificSpriteSequenceLoader(ModData modData)
|
|
: base(modData)
|
|
{
|
|
var metadata = modData.Manifest.Get<SpriteSequenceFormat>().Metadata;
|
|
if (metadata.TryGetValue("DefaultSpriteExtension", out var yaml))
|
|
DefaultSpriteExtension = yaml.Value;
|
|
|
|
if (metadata.TryGetValue("TilesetExtensions", out yaml))
|
|
TilesetExtensions = yaml.ToDictionary(kv => kv.Value);
|
|
|
|
if (metadata.TryGetValue("TilesetCodes", out yaml))
|
|
TilesetCodes = yaml.ToDictionary(kv => kv.Value);
|
|
}
|
|
|
|
public override ISpriteSequence CreateSequence(ModData modData, string tileSet, SpriteCache cache, string sequence, string animation, MiniYaml info)
|
|
{
|
|
return new ClassicTilesetSpecificSpriteSequence(modData, tileSet, cache, this, sequence, animation, info);
|
|
}
|
|
}
|
|
|
|
[Desc("A sprite sequence that can have tileset-specific variants and has the oddities " +
|
|
"that come with first-generation Westwood titles.")]
|
|
public class ClassicTilesetSpecificSpriteSequence : ClassicSpriteSequence
|
|
{
|
|
// These need to be public properties for the documentation generation to work.
|
|
[Desc("Dictionary of <string: string> with tileset name to override -> tileset name to use instead.")]
|
|
public static Dictionary<string, string> TilesetOverrides => null;
|
|
|
|
[Desc("Use `TilesetCodes` as defined in `mod.yaml` to add a letter as a second character " +
|
|
"into the sprite filename like the Westwood 2.5D titles did for tileset-specific variants.")]
|
|
public static bool UseTilesetCode => false;
|
|
|
|
[Desc("Append a tileset-specific extension to the file name " +
|
|
"- either as defined in `mod.yaml`'s `TilesetExtensions` (if `UseTilesetExtension` is used) " +
|
|
"or the default hardcoded one for this sequence type (.shp).")]
|
|
public static bool AddExtension => true;
|
|
|
|
[Desc("Whether `mod.yaml`'s `TilesetExtensions` should be used with the sequence's file name.")]
|
|
public static bool UseTilesetExtension { get; private set; }
|
|
|
|
public ClassicTilesetSpecificSpriteSequence(ModData modData, string tileSet, SpriteCache cache, ISpriteSequenceLoader loader, string sequence, string animation, MiniYaml info)
|
|
: base(modData, tileSet, cache, loader, sequence, animation, info) { }
|
|
|
|
static string ResolveTilesetId(string tileSet, Dictionary<string, MiniYaml> d)
|
|
{
|
|
if (d.TryGetValue(nameof(TilesetOverrides), out var yaml))
|
|
{
|
|
var tsNode = yaml.Nodes.FirstOrDefault(n => n.Key == tileSet);
|
|
if (tsNode != null)
|
|
tileSet = tsNode.Value.Value;
|
|
}
|
|
|
|
return tileSet;
|
|
}
|
|
|
|
protected override string GetSpriteSrc(ModData modData, string tileSet, string sequence, string animation, string sprite, Dictionary<string, MiniYaml> d)
|
|
{
|
|
var loader = (ClassicTilesetSpecificSpriteSequenceLoader)Loader;
|
|
|
|
var spriteName = sprite ?? sequence;
|
|
|
|
if (LoadField(d, nameof(UseTilesetCode), UseTilesetCode))
|
|
{
|
|
if (loader.TilesetCodes.TryGetValue(ResolveTilesetId(tileSet, d), out var code))
|
|
spriteName = spriteName.Substring(0, 1) + code + spriteName.Substring(2, spriteName.Length - 2);
|
|
}
|
|
|
|
if (LoadField(d, nameof(AddExtension), AddExtension))
|
|
{
|
|
UseTilesetExtension = LoadField(d, nameof(UseTilesetExtension), UseTilesetExtension);
|
|
if (UseTilesetExtension && loader.TilesetExtensions.TryGetValue(ResolveTilesetId(tileSet, d), out var tilesetExtension))
|
|
return spriteName + tilesetExtension;
|
|
|
|
return spriteName + loader.DefaultSpriteExtension;
|
|
}
|
|
|
|
return spriteName;
|
|
}
|
|
}
|
|
}
|