Refactored WaterPaletteRotation

Moved RotationBase from tileset definition to WaterPaletteRotation effect.
Unhardcoded rotation range and rotation rate.
Added possibility to exclude Tilesets from effect.

Fixed RA water palette rotation for actors on desert maps (#8872).

OpenRA.Game/Map/TileSet.cs

@@ -171,7 +171,6 @@ namespace OpenRA
 		public readonly int SheetSize = 512;
 		public readonly string Palette;
 		public readonly string PlayerPalette;
-		public readonly int WaterPaletteRotationBase = 0x60;
 		public readonly Color[] HeightDebugColors = new[] { Color.Red };
 		public readonly string[] EditorTemplateOrder;
 		public readonly bool IgnoreTileSpriteOffsets;

OpenRA.Mods.Common/Traits/PaletteEffects/WaterPaletteRotation.cs

@@ -15,11 +15,24 @@ using OpenRA.Traits;
 
 namespace OpenRA.Mods.Common.Traits
 {
-	[Desc("Palette effect used for sprinkle \"animations\" on terrain tiles.")]
+	[Desc("Palette effect used for sprinkle \"animations\".")]
 	class WaterPaletteRotationInfo : ITraitInfo
 	{
+		[Desc("Defines which palettes should be excluded from this effect.")]
 		public readonly HashSet<string> ExcludePalettes = new HashSet<string>();
 
+		[Desc("Don't apply the effect for these tileset IDs.")]
+		public readonly string[] ExcludeTilesets = { };
+
+		[Desc("Palette index of first RotationRange color.")]
+		public readonly int RotationBase = 0x60;
+
+		[Desc("Range of colors to rotate.")]
+		public readonly int RotationRange = 7;
+
+		[Desc("Step towards next color index per tick.")]
+		public readonly float RotationStep = .25f;
+
 		public object Create(ActorInitializer init) { return new WaterPaletteRotation(init.World, this); }
 	}
 
@@ -28,35 +41,39 @@ namespace OpenRA.Mods.Common.Traits
 		readonly WaterPaletteRotationInfo info;
 		readonly World world;
 		float t = 0;
+		uint[] temp;
 
 		public WaterPaletteRotation(World world, WaterPaletteRotationInfo info)
 		{
 			this.world = world;
 			this.info = info;
+
+			temp = new uint[info.RotationRange]; /* allocating this on the fly actually hurts our profile */
 		}
 
-		public void Tick(Actor self) { t += .25f; }
-
-		uint[] temp = new uint[7]; /* allocating this on the fly actually hurts our profile */
+		public void Tick(Actor self)
+		{
+			t += info.RotationStep;
+		}
 
 		public void AdjustPalette(IReadOnlyDictionary<string, MutablePalette> palettes)
 		{
-			var rotate = (int)t % 7;
+			var rotate = (int)t % info.RotationRange;
 			if (rotate == 0)
 				return;
 
 			foreach (var kvp in palettes)
 			{
-				if (info.ExcludePalettes.Contains(kvp.Key))
+				if (info.ExcludePalettes.Contains(kvp.Key) || info.ExcludeTilesets.Contains(world.TileSet.Id))
 					continue;
 
 				var palette = kvp.Value;
 
-				for (var i = 0; i < 7; i++)
-					temp[(rotate + i) % 7] = palette[world.TileSet.WaterPaletteRotationBase + i];
+				for (var i = 0; i < info.RotationRange; i++)
+					temp[(rotate + i) % info.RotationRange] = palette[info.RotationBase + i];
 
-				for (var i = 0; i < 7; i++)
-					palette[world.TileSet.WaterPaletteRotationBase + i] = temp[i];
+				for (var i = 0; i < info.RotationRange; i++)
+					palette[info.RotationBase + i] = temp[i];
 			}
 		}
 	}

mods/cnc/rules/palettes.yaml

@@ -73,5 +73,6 @@
 	CloakPaletteEffect:
 	FlashPaletteEffect:
 	WaterPaletteRotation:
-		ExcludePalettes: effect
+		ExcludePalettes: effect, chrome
+		RotationBase: 32
 

mods/cnc/tilesets/desert.yaml

@@ -2,7 +2,6 @@ General:
 	Name: Desert
 	Id: DESERT
 	Palette: desert.pal
-	WaterPaletteRotationBase: 32
 	EditorTemplateOrder: Terrain, Debris, Road, Cliffs, Beach, River, Bridge
 
 Terrain:

mods/cnc/tilesets/jungle.yaml

@@ -2,7 +2,6 @@ General:
 	Name: Jungle
 	Id: JUNGLE
 	Palette: jungle.pal
-	WaterPaletteRotationBase: 32
 	EditorTemplateOrder: Terrain, Debris, Road, Cliffs, Beach, River, Bridge
 
 Terrain:

mods/cnc/tilesets/snow.yaml

@@ -2,7 +2,6 @@ General:
 	Name: Snow
 	Id: SNOW
 	Palette: snow.pal
-	WaterPaletteRotationBase: 32
 	EditorTemplateOrder: Terrain, Debris, Road, Cliffs, Beach, River, Bridge
 
 Terrain:

mods/cnc/tilesets/temperat.yaml

@@ -2,7 +2,6 @@ General:
 	Name: Temperate
 	Id: TEMPERAT
 	Palette: temperat.pal
-	WaterPaletteRotationBase: 32
 	EditorTemplateOrder: Terrain, Debris, Road, Cliffs, Beach, River, Bridge
 
 Terrain:

mods/cnc/tilesets/winter.yaml

@@ -2,7 +2,6 @@ General:
 	Name: Winter
 	Id: WINTER
 	Palette: winter.pal
-	WaterPaletteRotationBase: 32
 	EditorTemplateOrder: Terrain, Debris, Road, Cliffs, Beach, River, Bridge
 
 Terrain:

mods/ra/rules/palettes.yaml

@@ -1,7 +1,8 @@
 ^Palettes:
-	PlayerPaletteFromCurrentTileset:
+	PaletteFromFile@player:
 		Name: player
-		ShadowIndex: 3,4
+		Filename: temperat.pal
+		ShadowIndex: 4
 	PaletteFromCurrentTileset:
 		Name: terrain
 		ShadowIndex: 3,4
@@ -66,8 +67,16 @@
 		RemapIndex: 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95
 	PlayerHighlightPalette:
 	MenuPaletteEffect:
-	WaterPaletteRotation:
-		ExcludePalettes: player, effect
+	WaterPaletteRotation@defaultwater:
+		ExcludePalettes: chrome
+		ExcludeTilesets: DESERT
+	WaterPaletteRotation@actorswater:
+		ExcludePalettes: chrome, terrain
+		ExcludeTilesets: TEMPERAT, SNOW, INTERIOR
+	WaterPaletteRotation@desertwater:
+		ExcludePalettes: chrome, effect, player
+		ExcludeTilesets: TEMPERAT, SNOW, INTERIOR
+		RotationBase: 32
 	LightPaletteRotator:
 		ExcludePalettes: terrain, effect
 	ChronoshiftPaletteEffect:

mods/ra/tilesets/desert.yaml

@@ -3,7 +3,6 @@ General:
 	Id: DESERT
 	Palette: desert.pal
 	PlayerPalette: temperat.pal
-	WaterPaletteRotationBase: 32
 	EditorTemplateOrder: Terrain, Debris, Road, Cliffs, Water Cliffs, Beach, River, Bridge
 
 Terrain: