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.
56 lines
2.0 KiB
C#
56 lines
2.0 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;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
|
|
namespace OpenRA.Mods.Common.UpdateRules.Rules
|
|
{
|
|
public class RemoveTurnToDock : UpdateRule
|
|
{
|
|
public override string Name => "TurnToDock is removed from the Aircraft trait.";
|
|
|
|
public override string Description =>
|
|
"TurnToDock is removed from the Aircraft trait in favor of letting the Exit trait on the host" +
|
|
"building determine whether or not turning is required and to what facing the aircraft must turn.";
|
|
|
|
readonly List<Tuple<string, string>> turningAircraft = new();
|
|
|
|
public override IEnumerable<string> AfterUpdate(ModData modData)
|
|
{
|
|
var message = "TurnToDock is now deprecated. The following actors had TurnToDock enabled:\n"
|
|
+ UpdateUtils.FormatMessageList(turningAircraft.Select(n => n.Item1 + " (" + n.Item2 + ")"))
|
|
+ "\n If you wish these units to keep their turning behaviour when docking with a host building" +
|
|
" you will need to define a 'Facing' parameter on the 'Exit' trait of the host building. This change" +
|
|
" does not affect the behaviour for landing on terrain which is governed by TurnToLand.";
|
|
|
|
if (turningAircraft.Count > 0)
|
|
yield return message;
|
|
|
|
turningAircraft.Clear();
|
|
}
|
|
|
|
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
|
|
{
|
|
var aircraft = actorNode.LastChildMatching("Aircraft");
|
|
if (aircraft != null)
|
|
{
|
|
var turnToDock = aircraft.LastChildMatching("TurnToDock");
|
|
if (turnToDock == null || !turnToDock.NodeValue<bool>())
|
|
yield break;
|
|
|
|
turningAircraft.Add(Tuple.Create(actorNode.Key, actorNode.Location.Filename));
|
|
}
|
|
}
|
|
}
|
|
}
|