/*
 * This file is part of aion-emu <aion-emu.com>.
 *
 * aion-emu is free software: you can redistribute it and/or modify
 * it 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.
 *
 * aion-emu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with aion-emu.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.aionemu.gameserver.ai.desires;

import com.aionemu.gameserver.ai.AI;

/**
 * This class implements basic functionality common for each desire
 * 
 * @author SoulKeeper
 * @see com.aionemu.gameserver.ai.desires.Desire
 * @see com.aionemu.gameserver.ai.desires.DesireQueue
 * @see com.aionemu.gameserver.ai.AI
 * @see com.aionemu.gameserver.ai.AI#handleDesire(Desire)
 */
public abstract class AbstractDesire implements Desire
{
	/**
	 * Current execution counter
	 */
	protected int executionCounter;
	/**
	 * Desire power. It's used to calculate what npc whants to do most of all.
	 */
	protected int	desirePower;

	/**
	 * Creates new desire. By design any desire should have desire power. So constructor accepts basic amout.
	 * 
	 * @param desirePower
	 *            basic amount of desirePower
	 */
	protected AbstractDesire(int desirePower)
	{
		this.desirePower = desirePower;
	}

	/**
	 * Compares this desire with another, used by {@link com.aionemu.gameserver.ai.desires.DesireQueue} to keep track of
	 * desire priorities.
	 * 
	 * @param o
	 *            desire to compare with
	 * @return result of desire comparation
	 */
	@Override
	public int compareTo(Desire o)
	{
		return o.getDesirePower() - getDesirePower();
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int getDesirePower()
	{
		return desirePower;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public synchronized void increaseDesirePower(int desirePower)
	{
		this.desirePower = this.desirePower + desirePower;
	}

	@Override
	public boolean handleDesire(AI<?> ai)
	{
		// TODO Auto-generated method stub
		return false;
	}
	
	public abstract int getExecutionInterval();
	
	@Override
	public boolean isReadyToRun()
	{
		boolean isReady =  executionCounter % getExecutionInterval() == 0;
		executionCounter++;
		return isReady;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public synchronized void reduceDesirePower(int desirePower)
	{
		this.desirePower = this.desirePower - desirePower;
	}
}