#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 ReplaceWithColoredOverlayPalette : UpdateRule
	{
		public override string Name => "WithColoredOverlay Palette changed to Color.";

		public override string Description => "The Palette field has been removed from WithColoredOverlay. You must now specify the Color directly.";

		readonly List<string> locations = new();

		public override IEnumerable<string> AfterUpdate(ModData modData)
		{
			if (locations.Count > 0)
				yield return
					"You must define new Color fields on the following traits:\n" +
					UpdateUtils.FormatMessageList(locations);

			locations.Clear();
		}

		public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
		{
			foreach (var node in actorNode.ChildrenMatching("WithColoredOverlay"))
				if (node.RemoveNodes("Palette") > 0)
					locations.Add($"{actorNode.Key}: {node.Key} ({actorNode.Location.Name})");

			yield break;
		}
	}
}
