#region Copyright & License Information
/*
 * Copyright 2007-2017 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.Traits;

namespace OpenRA.Mods.Common.Traits
{
	public class BuildableInfo : TraitInfo<Buildable>
	{
		[Desc("The prerequisite names that must be available before this can be built.",
			"This can be prefixed with ! to invert the prerequisite (disabling production if the prerequisite is available)",
			"and/or ~ to hide the actor from the production palette if the prerequisite is not available.",
			"Prerequisites are granted by actors with the ProvidesPrerequisite trait.")]
		public readonly string[] Prerequisites = { };

		[Desc("Production queue(s) that can produce this.")]
		public readonly HashSet<string> Queue = new HashSet<string>();

		[Desc("Override the production structure type (from the Production Produces list) that this unit should be built at.")]
		public readonly string BuildAtProductionType = null;

		[Desc("Disable production when there are more than this many of this actor on the battlefield. Set to 0 to disable.")]
		public readonly int BuildLimit = 0;

		[Desc("Force a specific faction variant, overriding the faction of the producing actor.")]
		public readonly string ForceFaction = null;

		[Desc("Sequence of the actor that contains the icon.")]
		[SequenceReference] public readonly string Icon = "icon";

		[Desc("Palette used for the production icon.")]
		[PaletteReference] public readonly string IconPalette = "chrome";

		[Desc("Base build time in frames (-1 indicates to use the unit's Value).")]
		public readonly int BuildDuration = -1;

		[Desc("Percentage modifier to apply to the build duration.")]
		public readonly int BuildDurationModifier = 60;

		// TODO: UI fluff; doesn't belong here
		public readonly int BuildPaletteOrder = 9999;

		[Desc("Text shown in the production tooltip.")]
		[Translate] public readonly string Description = "";

		public static string GetInitialFaction(ActorInfo ai, string defaultFaction)
		{
			var bi = ai.TraitInfoOrDefault<BuildableInfo>();
			return bi != null ? bi.ForceFaction ?? defaultFaction : defaultFaction;
		}
	}

	public class Buildable { }
}