OpenRA/OpenRA.Mods.Common/Traits/RejectsOrders.cs

#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.Frozen;
using System.Linq;

namespace OpenRA.Mods.Common.Traits
{
	[Desc("Can be used to make a unit partly uncontrollable by the player.")]
	public class RejectsOrdersInfo : ConditionalTraitInfo
	{
		[Desc("Explicit list of rejected orders. Leave empty to reject all minus those listed under Except.")]
		public readonly FrozenSet<string> Reject = FrozenSet<string>.Empty;

		[Desc("List of orders that should *not* be rejected.",
			"Also overrides other instances of this trait's Reject fields.")]
		public readonly FrozenSet<string> Except = FrozenSet<string>.Empty;

		[Desc("Remove current and all queued orders from the actor when this trait is enabled.")]
		public readonly bool RemoveOrders = false;

		public override object Create(ActorInitializer init) { return new RejectsOrders(this); }
	}

	public class RejectsOrders : ConditionalTrait<RejectsOrdersInfo>
	{
		public FrozenSet<string> Reject => Info.Reject;
		public FrozenSet<string> Except => Info.Except;

		public RejectsOrders(RejectsOrdersInfo info)
			: base(info) { }

		protected override void TraitEnabled(Actor self)
		{
			if (Info.RemoveOrders)
				self.CancelActivity();
		}
	}

	public static class RejectsOrdersExts
	{
		public static bool AcceptsOrder(this Actor self, string orderString)
		{
			var rejectsOrdersTraits = self.TraitsImplementing<RejectsOrders>().Where(t => !t.IsTraitDisabled).ToArray();
			if (rejectsOrdersTraits.Length == 0)
				return true;

			foreach (var rejectsOrdersTrait in rejectsOrdersTraits)
				if (rejectsOrdersTrait.Except.Contains(orderString))
					return true;

			var anyRejects = false;
			foreach (var rejectsOrdersTrait in rejectsOrdersTraits)
			{
				anyRejects = anyRejects || rejectsOrdersTrait.Reject.Count > 0;
				if (rejectsOrdersTrait.Reject.Contains(orderString))
					return false;
			}

			return anyRejects;
		}
	}
}