Files
OpenRA/OpenRA.Mods.Common/UtilityCommands/CheckMissingSprites.cs
Eduardo Cáceres 2677e9c013 Use pattern matching
2022-05-18 11:42:36 -05:00

93 lines
3.0 KiB
C#

#region Copyright & License Information
/*
* Copyright 2007-2021 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;
using OpenRA.Mods.Common.Graphics;
using OpenRA.Mods.Common.Terrain;
using OpenRA.Mods.Common.Traits;
namespace OpenRA.Mods.Common.UtilityCommands
{
class CheckMissingSprites : IUtilityCommand
{
string IUtilityCommand.Name => "--check-missing-sprites";
bool IUtilityCommand.ValidateArguments(string[] args)
{
return true;
}
[Desc("Check tileset and sequence definitions for missing sprite files.")]
void IUtilityCommand.Run(Utility utility, string[] args)
{
// HACK: The engine code assumes that Game.modData is set.
var modData = Game.ModData = utility.ModData;
var failed = false;
// We need two levels of YamlException handling to provide the desired behaviour:
// Parse errors within a single tileset should skip that tileset and allow the rest to be tested
// however, certain errors will be thrown by the outer modData.DefaultSequences, which prevent
// any tilesets from being checked further.
try
{
// DefaultSequences is a dictionary of tileset: SequenceProvider
// so we can also use this to key our tileset checks
foreach (var kv in modData.DefaultSequences)
{
try
{
Console.WriteLine("Tileset: " + kv.Key);
var terrainInfo = modData.DefaultTerrainInfo[kv.Key];
if (terrainInfo is ITemplatedTerrainInfo templatedTerrainInfo)
foreach (var r in modData.DefaultRules.Actors[SystemActors.World].TraitInfos<ITiledTerrainRendererInfo>())
failed |= r.ValidateTileSprites(templatedTerrainInfo, Console.WriteLine);
foreach (var image in kv.Value.Images)
{
foreach (var sequence in kv.Value.Sequences(image))
{
if (!(kv.Value.GetSequence(image, sequence) is FileNotFoundSequence s))
continue;
Console.WriteLine("\tSequence `{0}.{1}` references sprite `{2}` that does not exist.", image, sequence, s.Filename);
failed = true;
}
}
}
catch (YamlException e)
{
// The stacktrace associated with yaml errors are not very useful
// Suppress them to make the lint output less intimidating for modders
Console.WriteLine($"\t{e.Message}");
failed = true;
}
catch (Exception e)
{
Console.WriteLine($"Failed with exception: {e}");
failed = true;
}
}
}
catch (YamlException e)
{
// The stacktrace associated with yaml errors are not very useful
// Suppress them to make the lint output less intimidating for modders
Console.WriteLine($"{e.Message}");
failed = true;
}
if (failed)
Environment.Exit(1);
}
}
}