/**
 * 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.model;

import javax.xml.bind.annotation.XmlEnum;

/**
 * This enum represent class that a player may belong to.
 * 
 * @author Luno
 * 
 */
@XmlEnum
public enum PlayerClass
{
	WARRIOR(0, true),
	GLADIATOR(1), //fighter
	TEMPLAR(2),   //knight
	SCOUT(3, true),
	ASSASSIN(4),
	RANGER(5),
	MAGE(6, true),
	SORCERER(7), //wizard
	SPIRIT_MASTER(8),//elementalist
	PRIEST(9, true),
	CLERIC(10),
	CHANTER(11);

	/** This id is used on client side */
	private byte	classId;
	
	/** This is the mask for this class id, used with bitwise AND in arguments that contain more than one possible class */
	private int		idMask;
	
	/** Tells whether player can create new character with this class */
	private boolean	startingClass;

	private PlayerClass(int classId)
	{
		this(classId, false);
	}

	private PlayerClass(int classId, boolean startingClass)
	{
		this.classId = (byte) classId;
		this.startingClass = startingClass;
		this.idMask = (int)Math.pow(2, classId);
	}

	/**
	 * Returns client-side id for this PlayerClass
	 * 
	 * @return classID
	 */
	public byte getClassId()
	{
		return classId;
	}

	/**
	 * Returns <tt>PlayerClass</tt> object correlating with given classId.
	 * 
	 * @param classId
	 *            - id of player class
	 * @return PlayerClass objects that matches the given classId. If there isn't any objects that matches given id,
	 *         then <b>IllegalArgumentException</b> is being thrown.
	 */
	public static PlayerClass getPlayerClassById(byte classId)
	{
		for(PlayerClass pc : values())
		{
			if(pc.getClassId() == classId)
				return pc;
		}

		throw new IllegalArgumentException("There is no player class with id " + classId);
	}

	/**
	 * 
	 * @return true if this is one of starting classes ( player can create char with this class )
	 */
	public boolean isStartingClass()
	{
		return startingClass;
	}
	
	/**
	 * 
	 * @param pc
	 * @return starting class for second class
	 */
	public static PlayerClass getStartingClassFor(PlayerClass pc)
	{
		switch(pc)
		{
			case ASSASSIN:
			case RANGER:
				return SCOUT;
			case GLADIATOR:
			case TEMPLAR:
				return WARRIOR;
			case CHANTER:
			case CLERIC:
				return PRIEST;
			case SORCERER:
			case SPIRIT_MASTER:
				return MAGE;
			default:
				throw new IllegalArgumentException("Given player class is starting class: " + pc);
		}
	}
	
	public int getMask()
	{
		return idMask;
	}
}