Move Palette traits to their own directory.

Also adds missing TraitLocation definitions.

OpenRA.Mods.Common/Traits/Palettes/PaletteFromFile.cs

@@ -0,0 +1,82 @@
+#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.Collections.Generic;
+using OpenRA.FileSystem;
+using OpenRA.Graphics;
+using OpenRA.Traits;
+
+namespace OpenRA.Mods.Common.Traits
+{
+	[TraitLocation(SystemActors.World | SystemActors.EditorWorld)]
+	[Desc("Load VGA palette (.pal) registers.")]
+	class PaletteFromFileInfo : TraitInfo, IProvidesCursorPaletteInfo
+	{
+		[PaletteDefinition]
+		[FieldLoader.Require]
+		[Desc("internal palette name")]
+		public readonly string Name = null;
+
+		[Desc("If defined, load the palette only for this tileset.")]
+		public readonly string Tileset = null;
+
+		[FieldLoader.Require]
+		[Desc("filename to load")]
+		public readonly string Filename = null;
+
+		[Desc("Map listed indices to transparent. Ignores previous color.")]
+		public readonly int[] TransparentIndex = { 0 };
+
+		[Desc("Map listed indices to shadow. Ignores previous color.")]
+		public readonly int[] ShadowIndex = { };
+
+		public readonly bool AllowModifiers = true;
+
+		[Desc("Whether this palette is available for cursors.")]
+		public readonly bool CursorPalette = false;
+
+		public override object Create(ActorInitializer init) { return new PaletteFromFile(init.World, this); }
+
+		string IProvidesCursorPaletteInfo.Palette => CursorPalette ? Name : null;
+
+		ImmutablePalette IProvidesCursorPaletteInfo.ReadPalette(IReadOnlyFileSystem fileSystem)
+		{
+			return new ImmutablePalette(fileSystem.Open(Filename), TransparentIndex, ShadowIndex);
+		}
+	}
+
+	class PaletteFromFile : ILoadsPalettes, IProvidesAssetBrowserPalettes
+	{
+		readonly World world;
+		readonly PaletteFromFileInfo info;
+		public PaletteFromFile(World world, PaletteFromFileInfo info)
+		{
+			this.world = world;
+			this.info = info;
+		}
+
+		public void LoadPalettes(WorldRenderer wr)
+		{
+			if (info.Tileset == null || info.Tileset.ToLowerInvariant() == world.Map.Tileset.ToLowerInvariant())
+				wr.AddPalette(info.Name, ((IProvidesCursorPaletteInfo)info).ReadPalette(world.Map), info.AllowModifiers);
+		}
+
+		public IEnumerable<string> PaletteNames
+		{
+			get
+			{
+				// Only expose the palette if it is available for the shellmap's tileset (which is a requirement for its use).
+				if (info.Tileset == null || info.Tileset == world.Map.Rules.TerrainInfo.Id)
+					yield return info.Name;
+			}
+		}
+	}
+}