Fade in the menu palette effect over a few frames

OpenRA.Mods.Cnc/CncMenuPaletteEffect.cs

@@ -0,0 +1,85 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2011 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. For more information,
+ * see COPYING.
+ */
+#endregion
+
+using System.Collections.Generic;
+using System.Drawing;
+using OpenRA.FileFormats;
+using OpenRA.Traits;
+
+namespace OpenRA.Mods.Cnc
+{
+	class CncMenuPaletteEffectInfo : TraitInfo<CncMenuPaletteEffect> { }
+
+	public class CncMenuPaletteEffect : IPaletteModifier, ITick
+	{		
+		public enum EffectType { None, Black, Desaturated }
+
+		const int effectLength = 10;
+		int remainingFrames;
+		
+		EffectType from = EffectType.Black;
+		EffectType to = EffectType.Black;
+		
+		public void Fade(EffectType type)
+		{
+			remainingFrames = effectLength;
+			from = to;
+			to = type;
+		}
+
+		public void Tick(Actor self)
+		{
+			if (remainingFrames > 0)
+				remainingFrames--;
+		}
+		
+		Color ColorForEffect(EffectType t, Color orig)
+		{
+			switch(t)
+			{
+				case EffectType.Black:
+					return Color.FromArgb(orig.A, Color.Black);
+				case EffectType.Desaturated:
+					var lum = (int)(255 * orig.GetBrightness());
+					return Color.FromArgb(orig.A, lum, lum, lum);
+				default:
+				case EffectType.None:
+					return orig;
+			}
+		}
+		
+		public void AdjustPalette(Dictionary<string,Palette> palettes)
+		{
+			if (to == EffectType.None && remainingFrames == 0)
+				return;
+			
+			var excludePalettes = new List<string>(){"cursor", "chrome", "colorpicker", "shroud", "fog"};
+			foreach (var pal in palettes)
+			{
+				if (excludePalettes.Contains(pal.Key))
+					continue;
+				
+				for (var x = 0; x < 256; x++)
+				{
+					var orig = pal.Value.GetColor(x);
+					var t = ColorForEffect(to, orig);
+					
+					if (remainingFrames == 0)
+						pal.Value.SetColor(x, t);
+					else
+					{
+						var f = ColorForEffect(from, orig);
+						pal.Value.SetColor(x, OpenRA.Graphics.Util.Lerp((float)remainingFrames / effectLength, t, f));
+					}
+				}
+			}
+		}
+	}
+}

OpenRA.Mods.Cnc/OpenRA.Mods.Cnc.csproj

@@ -87,6 +87,7 @@
     <Compile Include="Widgets\CncCheatsLogic.cs" />
     <Compile Include="Widgets\CncInstallFromCDLogic.cs" />
     <Compile Include="Widgets\CncDownloadPackagesLogic.cs" />
+    <Compile Include="CncMenuPaletteEffect.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\OpenRA.FileFormats\OpenRA.FileFormats.csproj">

OpenRA.Mods.Cnc/Widgets/CncIngameChromeLogic.cs

@@ -43,6 +43,9 @@ namespace OpenRA.Mods.Cnc.Widgets
 		public CncIngameChromeLogic([ObjectCreator.Param] Widget widget,
 		                            [ObjectCreator.Param] World world )
 		{
+			world.WorldActor.Trait<CncMenuPaletteEffect>()
+				.Fade(CncMenuPaletteEffect.EffectType.None);
+			
 			ingameRoot = widget.GetWidget("INGAME_ROOT");
 			if (!staticSetup)
 			{
@@ -92,7 +95,7 @@ namespace OpenRA.Mods.Cnc.Widgets
 		                          [ObjectCreator.Param] Action onExit)
 		{
 			menu = widget.GetWidget("INGAME_MENU");
-			world.WorldActor.Trait<DesaturatedPaletteEffect>().Active = true;
+			world.WorldActor.Trait<CncMenuPaletteEffect>().Fade(CncMenuPaletteEffect.EffectType.Desaturated);
 			
 			bool hideButtons = false;
 			menu.GetWidget("MENU_BUTTONS").IsVisible = () => !hideButtons;
@@ -137,7 +140,7 @@ namespace OpenRA.Mods.Cnc.Widgets
 			menu.GetWidget<ButtonWidget>("RESUME_BUTTON").OnClick = () => 
 			{
 				Widget.RootWidget.RemoveChild(menu);
-				world.WorldActor.Trait<DesaturatedPaletteEffect>().Active = false;
+				world.WorldActor.Trait<CncMenuPaletteEffect>().Fade(CncMenuPaletteEffect.EffectType.None);
 				onExit();
 			};
 		}

OpenRA.Mods.Cnc/Widgets/CncMenuLogic.cs

@@ -30,7 +30,8 @@ namespace OpenRA.Mods.Cnc.Widgets
 		public CncMenuLogic([ObjectCreator.Param] Widget widget,
 		                    [ObjectCreator.Param] World world)
 		{
-			world.WorldActor.Trait<DesaturatedPaletteEffect>().Active = true;
+			world.WorldActor.Trait<CncMenuPaletteEffect>()
+				.Fade(CncMenuPaletteEffect.EffectType.Desaturated);
 
 			// Root level menu
 			var mainMenu = widget.GetWidget("MAIN_MENU");

OpenRA.Mods.RA/DesaturatedPaletteEffect.cs

@@ -1,43 +0,0 @@
-#region Copyright & License Information
-/*
- * Copyright 2007-2011 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. For more information,
- * see COPYING.
- */
-#endregion
-
-using System.Collections.Generic;
-using System.Drawing;
-using OpenRA.FileFormats;
-using OpenRA.Traits;
-
-namespace OpenRA.Mods.RA
-{
-	class DesaturatedPaletteEffectInfo : TraitInfo<DesaturatedPaletteEffect> { }
-
-	public class DesaturatedPaletteEffect : IPaletteModifier
-	{
-		public bool Active;
-
-		// TODO: Doing this every frame is stupid
-		public void AdjustPalette(Dictionary<string,Palette> palettes)
-		{
-			if (!Active) return;
-			var excludePalettes = new List<string>(){"cursor", "chrome", "colorpicker", "shroud", "fog"};
-			foreach (var pal in palettes)
-			{
-				if (excludePalettes.Contains(pal.Key))
-					continue;
-				
-				for (var x = 0; x < 256; x++)
-				{
-					var orig = pal.Value.GetColor(x);
-					var lum = (int)(255 * orig.GetBrightness());
-					pal.Value.SetColor(x, Color.FromArgb(orig.A, lum, lum, lum));
-				}
-			}
-		}
-	}
-}

OpenRA.Mods.RA/OpenRA.Mods.RA.csproj

@@ -347,7 +347,6 @@
     <Compile Include="Sellable.cs" />
     <Compile Include="Captures.cs" />
     <Compile Include="Activities\CaptureActor.cs" />
-    <Compile Include="DesaturatedPaletteEffect.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\OpenRA.FileFormats\OpenRA.FileFormats.csproj">

mods/cnc/rules/system.yaml

@@ -46,7 +46,7 @@ Player:
 World:
 	LoadWidgetAtGameStart:
 		Widget: INGAME_ROOT
-	DesaturatedPaletteEffect:
+	CncMenuPaletteEffect:
 	ScreenShaker:
 	NukePaletteEffect:
 	CncWaterPaletteRotation: