b58c1ea5bc
- Rename the filename parameter to name and make it mandatory. Review all callers and ensure a useful string is provided as input, to ensure sufficient context is included for logging and debugging. This can be a filename, url, or any arbitrary text so include whatever context seems reasonable. - When several MiniYamls are created that have similar content, provide a shared string pool. This allows strings that are common between all the yaml to be shared, reducing long term memory usage. We also change the pool from a dictionary to a set. Originally a Dictionary had to be used so we could call TryGetValue to get a reference to the pooled string. Now that more recent versions of dotnet provide a TryGetValue on HashSet, we can use a set directly without the memory wasted by having to store both keys and values in a dictionary.
58 lines
1.8 KiB
C#
58 lines
1.8 KiB
C#
#region Copyright & License Information
|
|
/*
|
|
* Copyright (c) The OpenRA Developers and Contributors
|
|
* 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;
|
|
|
|
namespace OpenRA.Mods.Common.UpdateRules.Rules
|
|
{
|
|
public class RemoveSequenceHasEmbeddedPalette : UpdateRule
|
|
{
|
|
public override string Name => "Remove sequence HasEmbeddedPalette property.";
|
|
|
|
public override string Description =>
|
|
"The PaletteFromEmbeddedSpritePalette trait no longer references a sequence.\n" +
|
|
"Image and Sequence are replaced by Filename and Frame.";
|
|
|
|
readonly HashSet<string> locations = new();
|
|
|
|
public override IEnumerable<string> AfterUpdate(ModData modData)
|
|
{
|
|
if (locations.Count > 0)
|
|
yield return
|
|
"The PaletteFromEmbeddedSpritePalette trait no longer references a sequence.\n" +
|
|
"You must manually define Filename (and Frame if needed) on the following actors:\n" +
|
|
UpdateUtils.FormatMessageList(locations);
|
|
|
|
locations.Clear();
|
|
}
|
|
|
|
public override IEnumerable<string> UpdateSequenceNode(ModData modData, MiniYamlNodeBuilder imageNode)
|
|
{
|
|
foreach (var sequenceNode in imageNode.Value.Nodes)
|
|
sequenceNode.RemoveNodes("HasEmbeddedPalette");
|
|
|
|
yield break;
|
|
}
|
|
|
|
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
|
|
{
|
|
foreach (var traitNode in actorNode.ChildrenMatching("PaletteFromEmbeddedSpritePalette"))
|
|
{
|
|
traitNode.RemoveNodes("Image");
|
|
traitNode.RemoveNodes("Sequence");
|
|
locations.Add($"{actorNode.Key} ({actorNode.Location.Name})");
|
|
}
|
|
|
|
yield break;
|
|
}
|
|
}
|
|
}
|