Add PlayerConditionProperties

OpenRA.Mods.Common/Scripting/Properties/PlayerConditionProperties.cs

@@ -0,0 +1,59 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2020 The OpenRA Developers (see AUTHORS)
+ * 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.Linq;
+using Eluant;
+using OpenRA.Mods.Common.Traits;
+using OpenRA.Scripting;
+
+namespace OpenRA.Mods.Common.Scripting
+{
+	[ScriptPropertyGroup("Player")]
+	public class PlayerConditionProperties : ScriptPlayerProperties
+	{
+		readonly ExternalCondition[] externalConditions;
+
+		public PlayerConditionProperties(ScriptContext context, Player player)
+			: base(context, player)
+		{
+			externalConditions = player.PlayerActor.TraitsImplementing<ExternalCondition>().ToArray();
+		}
+
+		[Desc("Grant an external condition on the player actor and return the revocation token.",
+			"Conditions must be defined on an ExternalConditions trait on the player actor.",
+			"If duration > 0 the condition will be automatically revoked after the defined number of ticks.")]
+		public int GrantCondition(string condition, int duration = 0)
+		{
+			var external = externalConditions
+				.FirstOrDefault(t => t.Info.Condition == condition && t.CanGrantCondition(Player.PlayerActor, this));
+
+			if (external == null)
+				throw new LuaException("Condition `{0}` has not been listed on an enabled ExternalCondition trait".F(condition));
+
+			return external.GrantCondition(Player.PlayerActor, this, duration);
+		}
+
+		[Desc("Revoke a condition using the token returned by GrantCondition.")]
+		public void RevokeCondition(int token)
+		{
+			foreach (var external in externalConditions)
+				if (external.TryRevokeCondition(Player.PlayerActor, this, token))
+					break;
+		}
+
+		[Desc("Check whether this player actor accepts a specific external condition.")]
+		public bool AcceptsCondition(string condition)
+		{
+			return externalConditions
+				.Any(t => t.Info.Condition == condition && t.CanGrantCondition(Player.PlayerActor, this));
+		}
+	}
+}