From 227cf35d5f4f8425cafa7e655280baba693a9a2e Mon Sep 17 00:00:00 2001
From: xecollons <x.collons@gmail.com>
Date: Sat, 10 Mar 2018 17:19:26 +0100
Subject: [PATCH] Added TooltipDescription

---
 OpenRA.Mods.Common/OpenRA.Mods.Common.csproj  |  1 +
 .../Traits/TooltipDescription.cs              | 41 +++++++++++++++++++
 2 files changed, 42 insertions(+)
 create mode 100644 OpenRA.Mods.Common/Traits/TooltipDescription.cs

diff --git a/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj b/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj
index a664d82d37..98a4ed45c9 100644
--- a/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj
+++ b/OpenRA.Mods.Common/OpenRA.Mods.Common.csproj
@@ -304,6 +304,7 @@
     <Compile Include="Traits\CommandBarBlacklist.cs" />
     <Compile Include="Traits\Conditions\GrantRandomCondition.cs" />
     <Compile Include="Traits\Contrail.cs" />
+    <Compile Include="Traits\TooltipDescription.cs" />
     <Compile Include="Traits\Health.cs" />
     <Compile Include="Traits\HitShape.cs" />
     <Compile Include="Traits\Player\DeveloperMode.cs" />
diff --git a/OpenRA.Mods.Common/Traits/TooltipDescription.cs b/OpenRA.Mods.Common/Traits/TooltipDescription.cs
new file mode 100644
index 0000000000..1fdcb70913
--- /dev/null
+++ b/OpenRA.Mods.Common/Traits/TooltipDescription.cs
@@ -0,0 +1,41 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2018 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 OpenRA.Traits;
+
+namespace OpenRA.Mods.Common.Traits
+{
+	[Desc("Additional info shown in the battlefield tooltip.")]
+	public class TooltipDescriptionInfo : ConditionalTraitInfo
+	{
+		[Desc("Text shown in tooltip.")]
+		[Translate]
+		public readonly string Description = "";
+
+		public override object Create(ActorInitializer init) { return new TooltipDescription(this); }
+	}
+
+	public class TooltipDescription : ConditionalTrait<TooltipDescriptionInfo>, IProvideTooltipInfo
+	{
+		public TooltipDescription(TooltipDescriptionInfo info)
+			: base(info) { }
+
+		public bool IsTooltipVisible(Player forPlayer) { return !IsTraitDisabled; }
+
+		public string TooltipText
+		{
+			get
+			{
+				return Info.Description;
+			}
+		}
+	}
+}