Add support for additional cloak styles and use native alpha in RA,D2k,TS.

OpenRA.Mods.Common/Traits/Cloak.cs

@@ -39,6 +39,8 @@ namespace OpenRA.Mods.Common.Traits
 	// Type tag for DetectionTypes
 	public class DetectionType { }
 
+	public enum CloakStyle { None, Alpha, Color, Palette }
+
 	[Desc("This unit can cloak and uncloak in specific situations.")]
 	public class CloakInfo : PausableConditionalTraitInfo
 	{
@@ -57,10 +59,6 @@ namespace OpenRA.Mods.Common.Traits
 		public readonly string CloakSound = null;
 		public readonly string UncloakSound = null;
 
-		[PaletteReference(nameof(IsPlayerPalette))]
-		public readonly string Palette = "cloak";
-		public readonly bool IsPlayerPalette = false;
-
 		public readonly BitSet<DetectionType> DetectionTypes = new("Cloak");
 
 		[GrantedConditionReference]
@@ -70,6 +68,22 @@ namespace OpenRA.Mods.Common.Traits
 		[Desc("The type of cloak. Same type of cloaks won't trigger cloaking and uncloaking sound and effect.")]
 		public readonly string CloakType = null;
 
+		[Desc("Render effect to use when cloaked.")]
+		public readonly CloakStyle CloakStyle = CloakStyle.Alpha;
+
+		[Desc("The alpha level to use when cloaked when using Alpha CloakStyle.")]
+		public readonly float CloakedAlpha = 0.55f;
+
+		[Desc("The color to use when cloaked when using Color CloakStyle.")]
+		public readonly Color CloakedColor = Color.FromArgb(140, 0, 0, 0);
+
+		[PaletteReference(nameof(IsPlayerPalette))]
+		[Desc("The palette to use when cloaked when using Palette CloakStyle.")]
+		public readonly string CloakedPalette = null;
+
+		[Desc("Indicates that CloakedPalette is a player palette when using Palette CloakStyle.")]
+		public readonly bool IsPlayerPalette = false;
+
 		[Desc("Which image to use for the effect played when cloaking or uncloaking.")]
 		public readonly string EffectImage = null;
 
@@ -95,8 +109,11 @@ namespace OpenRA.Mods.Common.Traits
 	}
 
 	public class Cloak : PausableConditionalTrait<CloakInfo>, IRenderModifier, INotifyDamage, INotifyUnloadCargo, INotifyLoadCargo, INotifyDemolition, INotifyInfiltration,
-		INotifyAttack, ITick, IVisibilityModifier, IRadarColorModifier, INotifyCreated, INotifyDockClient, INotifySupportPower
+		INotifyAttack, ITick, IVisibilityModifier, IRadarColorModifier, INotifyDockClient, INotifySupportPower
 	{
+		readonly float3 cloakedColor;
+		readonly float cloakedColorAlpha;
+
 		[Sync]
 		int remainingTime;
 
@@ -112,6 +129,8 @@ namespace OpenRA.Mods.Common.Traits
 			: base(info)
 		{
 			remainingTime = info.InitialDelay;
+			cloakedColor = new float3(info.CloakedColor.R, info.CloakedColor.G, info.CloakedColor.B) / 255f;
+			cloakedColorAlpha = info.CloakedColor.A / 255f;
 		}
 
 		protected override void Created(Actor self)
@@ -162,15 +181,28 @@ namespace OpenRA.Mods.Common.Traits
 
 			if (Cloaked && IsVisible(self, self.World.RenderPlayer))
 			{
-				var palette = wr.Palette(Info.IsPlayerPalette ? Info.Palette + self.Owner.InternalName : Info.Palette);
+				switch (Info.CloakStyle)
+				{
+					case CloakStyle.Alpha:
+						return r.Select(a => !a.IsDecoration && a is IModifyableRenderable mr ? mr.WithAlpha(Info.CloakedAlpha) : a);
 
-				if (palette == null)
-					return r;
-				else
-					return r.Select(a => !a.IsDecoration && a is IPalettedRenderable pr ? pr.WithPalette(palette) : a);
+					case CloakStyle.Color:
+						return r.Select(a => !a.IsDecoration && a is IModifyableRenderable mr ?
+							mr.WithTint(cloakedColor, mr.TintModifiers | TintModifiers.ReplaceColor).WithAlpha(cloakedColorAlpha) :
+							a);
+
+					case CloakStyle.Palette:
+					{
+						var palette = wr.Palette(Info.IsPlayerPalette ? Info.CloakedPalette + self.Owner.InternalName : Info.CloakedPalette);
+						return r.Select(a => !a.IsDecoration && a is IPalettedRenderable pr ? pr.WithPalette(palette) : a);
+					}
+
+					default:
+						return r;
+				}
 			}
-			else
-				return SpriteRenderable.None;
+
+			return SpriteRenderable.None;
 		}
 
 		IEnumerable<Rectangle> IRenderModifier.ModifyScreenBounds(Actor self, WorldRenderer wr, IEnumerable<Rectangle> bounds)

OpenRA.Mods.Common/UpdateRules/Rules/20231010/ReplaceCloakPalette.cs

@@ -0,0 +1,49 @@
+#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 ReplaceCloakPalette : UpdateRule
+	{
+		public override string Name => "Change default Cloak style from Palette to Alpha.";
+
+		public override string Description =>
+			"Cloak has gained several new rendering modes\n" +
+			"and its default behaviour has changed from using a palette to native alpha.";
+
+		readonly List<string> locations = new();
+
+		public override IEnumerable<string> AfterUpdate(ModData modData)
+		{
+			if (locations.Count > 0)
+				yield return "Cloak no longer defaults to replacing the actor's palette.\n" +
+					"If you wish to keep the previous behavior you wish to change the\n" +
+					"Cloak definitions on the following actor definitions:\n" +
+					UpdateUtils.FormatMessageList(locations);
+
+			locations.Clear();
+		}
+
+		public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNodeBuilder actorNode)
+		{
+			foreach (var cloak in actorNode.ChildrenMatching("Cloak"))
+			{
+				cloak.RemoveNodes("Palette");
+				cloak.RemoveNodes("IsPlayerPalette");
+				locations.Add($"{actorNode.Key} ({actorNode.Location.Filename})");
+			}
+
+			yield break;
+		}
+	}
+}

OpenRA.Mods.Common/UpdateRules/UpdatePath.cs

@@ -85,6 +85,7 @@ namespace OpenRA.Mods.Common.UpdateRules
 				new ExtractResourceStorageFromHarvester(),
 				new ReplacePaletteModifiers(),
 				new RemoveConyardChronoReturnAnimation(),
+				new ReplaceCloakPalette(),
 
 				// Execute these rules last to avoid premature yaml merge crashes.
 				new AbstractDocking(),