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.
74 lines
2.4 KiB
C#
74 lines
2.4 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
|
|
{
|
|
sealed class UpdateMapInits : UpdateRule
|
|
{
|
|
public override string Name => "Update map actor definitions";
|
|
|
|
public override string Description
|
|
{
|
|
get
|
|
{
|
|
return "Several changes have been made to initial actor state in maps:\n" +
|
|
UpdateUtils.FormatMessageList(new[]
|
|
{
|
|
"Facing is now defined as a world angle",
|
|
"TurretFacing is now defined as a world angle relative to Facing",
|
|
"Plugs has been removed (use Plug instead)",
|
|
"TurretFacings has been removed (use TurretFacing instead)"
|
|
}) +
|
|
"\nMaps are automatically updated to keep the previous actor facings.";
|
|
}
|
|
}
|
|
|
|
public override IEnumerable<string> UpdateMapActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
|
|
{
|
|
if (actorNode.RemoveNodes("Plugs") > 0)
|
|
yield return $"Initial plugs for actor {actorNode.Key} will need to be reconfigured using the map editor.";
|
|
|
|
if (actorNode.RemoveNodes("TurretFacings") > 0)
|
|
yield return $"Initial turret facings for actor {actorNode.Key} will need to be reconfigured using the map editor.";
|
|
|
|
var bodyFacing = WAngle.Zero;
|
|
foreach (var facing in actorNode.ChildrenMatching("Facing"))
|
|
{
|
|
bodyFacing = WAngle.FromFacing(facing.NodeValue<int>());
|
|
facing.ReplaceValue(FieldSaver.FormatValue(bodyFacing));
|
|
}
|
|
|
|
var removeNodes = new List<MiniYamlNodeBuilder>();
|
|
foreach (var facing in actorNode.ChildrenMatching("TurretFacing"))
|
|
{
|
|
var turretFacing = WAngle.FromFacing(facing.NodeValue<int>()) - bodyFacing;
|
|
if (turretFacing == WAngle.Zero)
|
|
removeNodes.Add(facing);
|
|
else
|
|
facing.ReplaceValue(FieldSaver.FormatValue(turretFacing));
|
|
}
|
|
|
|
foreach (var node in removeNodes)
|
|
actorNode.Value.Nodes.Remove(node);
|
|
}
|
|
|
|
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
|
|
{
|
|
foreach (var turret in actorNode.ChildrenMatching("Turreted"))
|
|
turret.RemoveNodes("PreviewFacing");
|
|
|
|
yield break;
|
|
}
|
|
}
|
|
}
|