949ba589c0
This changeset is motivated by a simple concept - get rid of the MiniYaml.Clone and MiniYamlNode.Clone methods to avoid deep copying yaml trees during merging. MiniYaml becoming immutable allows the merge function to reuse existing yaml trees rather than cloning them, saving on memory and improving merge performance. On initial loading the YAML for all maps is processed, so this provides a small reduction in initial loading time. The rest of the changeset is dealing with the change in the exposed API surface. Some With* helper methods are introduced to allow creating new YAML from existing YAML. Areas of code that generated small amounts of YAML are able to transition directly to the immutable model without too much ceremony. Some use cases are far less ergonomic even with these helper methods and so a MiniYamlBuilder is introduced to retain mutable creation functionality. This allows those areas to continue to use the old mutable structures. The main users are the update rules and linting capabilities.
57 lines
1.8 KiB
C#
57 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.Filename})");
|
|
}
|
|
|
|
yield break;
|
|
}
|
|
}
|
|
}
|