var PETRA = function(m)
{
/* 
 * Common functions and variables to all queue plans.
 * has a "--" suffix because it needs to be loaded before the other queueplan files.
 */

m.QueuePlan = function(gameState, type, metadata)
{
	this.type = gameState.applyCiv(type);
	this.metadata = metadata;

	this.template = gameState.getTemplate(this.type);
	if (!this.template)
	{
		warn("Tried to add the inexisting template " + this.type + " to Petra. Please report this on the forums")
		return false;
	}
	this.ID = m.playerGlobals[PlayerID].uniqueIDBOPlans++;
	this.cost = new API3.Resources(this.template.cost());
	this.number = 1;

	this.category = "";
	this.lastIsGo = undefined;

	return true;
};

// Check the content of this queue
m.QueuePlan.prototype.isInvalid = function(gameState)
{
	return false;
};

// if true, the queue manager will begin increasing this plan's account.
m.QueuePlan.prototype.isGo = function(gameState)
{
	return true;
};

// can we start this plan immediately?
m.QueuePlan.prototype.canStart = function(gameState)
{
	return false;
};

// process the plan.
m.QueuePlan.prototype.start = function(gameState)
{
	// should call onStart.
};

m.QueuePlan.prototype.getCost = function()
{
	var costs = new API3.Resources();
	costs.add(this.cost);
	if (this.number !== 1)
			costs.multiply(this.number);
	return costs;
};

// On Event functions.
// Can be used to do some specific stuffs
// Need to be updated to actually do something if you want them to.
// this is called by "Start" if it succeeds.
m.QueuePlan.prototype.onStart = function(gameState)
{
};

// This is called by "isGo()" if it becomes true while it was false.
m.QueuePlan.prototype.onGo = function(gameState)
{
};

// This is called by "isGo()" if it becomes false while it was true.
m.QueuePlan.prototype.onNotGo = function(gameState)
{
};

return m;
}(PETRA);