ClassId.java

/*
 * Copyright (C) 2004-2014 L2J Server
 * 
 * This file is part of L2J Server.
 * 
 * L2J Server 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.
 * 
 * L2J Server 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 this program. If not, see <http://www.gnu.org/licenses/>.
 */
package com.l2jserver.gameserver.model.base;

import com.l2jserver.gameserver.enums.Race;
import com.l2jserver.gameserver.model.interfaces.IIdentifiable;

/**
 * This class defines all classes (ex : human fighter, darkFighter...) that a player can chose.<br>
 * Data:
 * <ul>
 * <li>id : The Identifier of the class</li>
 * <li>isMage : True if the class is a mage class</li>
 * <li>race : The race of this class</li>
 * <li>parent : The parent ClassId or null if this class is the root</li>
 * </ul>
 * @version $Revision: 1.4.4.4 $ $Date: 2005/03/27 15:29:33 $
 */
public enum ClassId implements IIdentifiable
{
	fighter(0x00, false, Race.HUMAN, null),
	
	warrior(0x01, false, Race.HUMAN, fighter),
	gladiator(0x02, false, Race.HUMAN, warrior),
	warlord(0x03, false, Race.HUMAN, warrior),
	knight(0x04, false, Race.HUMAN, fighter),
	paladin(0x05, false, Race.HUMAN, knight),
	darkAvenger(0x06, false, Race.HUMAN, knight),
	rogue(0x07, false, Race.HUMAN, fighter),
	treasureHunter(0x08, false, Race.HUMAN, rogue),
	hawkeye(0x09, false, Race.HUMAN, rogue),
	
	mage(0x0a, true, Race.HUMAN, null),
	wizard(0x0b, true, Race.HUMAN, mage),
	sorceror(0x0c, true, Race.HUMAN, wizard),
	necromancer(0x0d, true, Race.HUMAN, wizard),
	warlock(0x0e, true, true, Race.HUMAN, wizard),
	cleric(0x0f, true, Race.HUMAN, mage),
	bishop(0x10, true, Race.HUMAN, cleric),
	prophet(0x11, true, Race.HUMAN, cleric),
	
	elvenFighter(0x12, false, Race.ELF, null),
	elvenKnight(0x13, false, Race.ELF, elvenFighter),
	templeKnight(0x14, false, Race.ELF, elvenKnight),
	swordSinger(0x15, false, Race.ELF, elvenKnight),
	elvenScout(0x16, false, Race.ELF, elvenFighter),
	plainsWalker(0x17, false, Race.ELF, elvenScout),
	silverRanger(0x18, false, Race.ELF, elvenScout),
	
	elvenMage(0x19, true, Race.ELF, null),
	elvenWizard(0x1a, true, Race.ELF, elvenMage),
	spellsinger(0x1b, true, Race.ELF, elvenWizard),
	elementalSummoner(0x1c, true, true, Race.ELF, elvenWizard),
	oracle(0x1d, true, Race.ELF, elvenMage),
	elder(0x1e, true, Race.ELF, oracle),
	
	darkFighter(0x1f, false, Race.DARK_ELF, null),
	palusKnight(0x20, false, Race.DARK_ELF, darkFighter),
	shillienKnight(0x21, false, Race.DARK_ELF, palusKnight),
	bladedancer(0x22, false, Race.DARK_ELF, palusKnight),
	assassin(0x23, false, Race.DARK_ELF, darkFighter),
	abyssWalker(0x24, false, Race.DARK_ELF, assassin),
	phantomRanger(0x25, false, Race.DARK_ELF, assassin),
	
	darkMage(0x26, true, Race.DARK_ELF, null),
	darkWizard(0x27, true, Race.DARK_ELF, darkMage),
	spellhowler(0x28, true, Race.DARK_ELF, darkWizard),
	phantomSummoner(0x29, true, true, Race.DARK_ELF, darkWizard),
	shillienOracle(0x2a, true, Race.DARK_ELF, darkMage),
	shillenElder(0x2b, true, Race.DARK_ELF, shillienOracle),
	
	orcFighter(0x2c, false, Race.ORC, null),
	orcRaider(0x2d, false, Race.ORC, orcFighter),
	destroyer(0x2e, false, Race.ORC, orcRaider),
	orcMonk(0x2f, false, Race.ORC, orcFighter),
	tyrant(0x30, false, Race.ORC, orcMonk),
	
	orcMage(0x31, false, Race.ORC, null),
	orcShaman(0x32, true, Race.ORC, orcMage),
	overlord(0x33, true, Race.ORC, orcShaman),
	warcryer(0x34, true, Race.ORC, orcShaman),
	
	dwarvenFighter(0x35, false, Race.DWARF, null),
	scavenger(0x36, false, Race.DWARF, dwarvenFighter),
	bountyHunter(0x37, false, Race.DWARF, scavenger),
	artisan(0x38, false, Race.DWARF, dwarvenFighter),
	warsmith(0x39, false, Race.DWARF, artisan),
	
	/*
	 * Dummy Entries (id's already in decimal format) btw FU NCSoft for the amount of work you put me through to do this!! <START>
	 */
	dummyEntry1(58, false, null, null),
	dummyEntry2(59, false, null, null),
	dummyEntry3(60, false, null, null),
	dummyEntry4(61, false, null, null),
	dummyEntry5(62, false, null, null),
	dummyEntry6(63, false, null, null),
	dummyEntry7(64, false, null, null),
	dummyEntry8(65, false, null, null),
	dummyEntry9(66, false, null, null),
	dummyEntry10(67, false, null, null),
	dummyEntry11(68, false, null, null),
	dummyEntry12(69, false, null, null),
	dummyEntry13(70, false, null, null),
	dummyEntry14(71, false, null, null),
	dummyEntry15(72, false, null, null),
	dummyEntry16(73, false, null, null),
	dummyEntry17(74, false, null, null),
	dummyEntry18(75, false, null, null),
	dummyEntry19(76, false, null, null),
	dummyEntry20(77, false, null, null),
	dummyEntry21(78, false, null, null),
	dummyEntry22(79, false, null, null),
	dummyEntry23(80, false, null, null),
	dummyEntry24(81, false, null, null),
	dummyEntry25(82, false, null, null),
	dummyEntry26(83, false, null, null),
	dummyEntry27(84, false, null, null),
	dummyEntry28(85, false, null, null),
	dummyEntry29(86, false, null, null),
	dummyEntry30(87, false, null, null),
	/*
	 * <END> Of Dummy entries
	 */
	
	/*
	 * Now the bad boys! new class ids :)) (3rd classes)
	 */
	duelist(0x58, false, Race.HUMAN, gladiator),
	dreadnought(0x59, false, Race.HUMAN, warlord),
	phoenixKnight(0x5a, false, Race.HUMAN, paladin),
	hellKnight(0x5b, false, Race.HUMAN, darkAvenger),
	sagittarius(0x5c, false, Race.HUMAN, hawkeye),
	adventurer(0x5d, false, Race.HUMAN, treasureHunter),
	archmage(0x5e, true, Race.HUMAN, sorceror),
	soultaker(0x5f, true, Race.HUMAN, necromancer),
	arcanaLord(0x60, true, true, Race.HUMAN, warlock),
	cardinal(0x61, true, Race.HUMAN, bishop),
	hierophant(0x62, true, Race.HUMAN, prophet),
	
	evaTemplar(0x63, false, Race.ELF, templeKnight),
	swordMuse(0x64, false, Race.ELF, swordSinger),
	windRider(0x65, false, Race.ELF, plainsWalker),
	moonlightSentinel(0x66, false, Race.ELF, silverRanger),
	mysticMuse(0x67, true, Race.ELF, spellsinger),
	elementalMaster(0x68, true, true, Race.ELF, elementalSummoner),
	evaSaint(0x69, true, Race.ELF, elder),
	
	shillienTemplar(0x6a, false, Race.DARK_ELF, shillienKnight),
	spectralDancer(0x6b, false, Race.DARK_ELF, bladedancer),
	ghostHunter(0x6c, false, Race.DARK_ELF, abyssWalker),
	ghostSentinel(0x6d, false, Race.DARK_ELF, phantomRanger),
	stormScreamer(0x6e, true, Race.DARK_ELF, spellhowler),
	spectralMaster(0x6f, true, true, Race.DARK_ELF, phantomSummoner),
	shillienSaint(0x70, true, Race.DARK_ELF, shillenElder),
	
	titan(0x71, false, Race.ORC, destroyer),
	grandKhavatari(0x72, false, Race.ORC, tyrant),
	dominator(0x73, true, Race.ORC, overlord),
	doomcryer(0x74, true, Race.ORC, warcryer),
	
	fortuneSeeker(0x75, false, Race.DWARF, bountyHunter),
	maestro(0x76, false, Race.DWARF, warsmith),
	
	dummyEntry31(0x77, false, null, null),
	dummyEntry32(0x78, false, null, null),
	dummyEntry33(0x79, false, null, null),
	dummyEntry34(0x7a, false, null, null),
	
	maleSoldier(0x7b, false, Race.KAMAEL, null),
	femaleSoldier(0x7C, false, Race.KAMAEL, null),
	trooper(0x7D, false, Race.KAMAEL, maleSoldier),
	warder(0x7E, false, Race.KAMAEL, femaleSoldier),
	berserker(0x7F, false, Race.KAMAEL, trooper),
	maleSoulbreaker(0x80, false, Race.KAMAEL, trooper),
	femaleSoulbreaker(0x81, false, Race.KAMAEL, warder),
	arbalester(0x82, false, Race.KAMAEL, warder),
	doombringer(0x83, false, Race.KAMAEL, berserker),
	maleSoulhound(0x84, false, Race.KAMAEL, maleSoulbreaker),
	femaleSoulhound(0x85, false, Race.KAMAEL, femaleSoulbreaker),
	trickster(0x86, false, Race.KAMAEL, arbalester),
	inspector(0x87, false, Race.KAMAEL, warder), // DS: yes, both male/female inspectors use skills from warder
	judicator(0x88, false, Race.KAMAEL, inspector),
	
	dummyEntry35(0x89, false, null, null),
	dummyEntry36(0x8a, false, null, null),
	
	// Awakening
	sigelKnight(139, false, Race.HUMAN, phoenixKnight),
	tyrrWarrior(140, false, Race.HUMAN, duelist),
	othellRogue(141, false, Race.HUMAN, adventurer),
	yulArcher(142, false, Race.HUMAN, sagittarius),
	feohWizard(143, true, Race.HUMAN, soultaker),
	issEnchanter(144, false, Race.KAMAEL, judicator),
	wynnSummoner(145, true, Race.HUMAN, arcanaLord),
	aeoreHealer(146, true, Race.HUMAN, cardinal),
	
	dummyEntry37(0x93, false, null, null),
	
	SigelPhoenixKnight(148, false, Race.HUMAN, phoenixKnight),
	SigelHellKnight(149, false, Race.HUMAN, hellKnight),
	SigelEvaTemplar(150, false, Race.ELF, evaTemplar),
	SigelShillienTemplar(151, false, Race.DARK_ELF, shillienTemplar),
	TyrrDuelist(152, false, Race.HUMAN, duelist),
	TyrrDreadnought(153, false, Race.HUMAN, dreadnought),
	TyrrTitan(154, false, Race.ORC, titan),
	TyrrGrandKhavatari(155, false, Race.ORC, grandKhavatari),
	TyrrMaestro(156, false, Race.DWARF, maestro),
	TyrrDoombringer(157, false, Race.KAMAEL, doombringer),
	OthellAdventurer(158, false, Race.HUMAN, adventurer),
	OthellWindRider(159, false, Race.ELF, windRider),
	OthellGhostHunter(160, false, Race.DARK_ELF, ghostHunter),
	OthellFortuneSeeker(161, false, Race.DWARF, fortuneSeeker),
	YulSagittarius(162, false, Race.HUMAN, sagittarius),
	YulMoonlightSentinel(163, false, Race.ELF, moonlightSentinel),
	YulGhostSentinel(164, false, Race.DARK_ELF, ghostSentinel),
	YulTrickster(165, false, Race.KAMAEL, trickster),
	FeohArchmage(166, true, Race.HUMAN, archmage),
	FeohSoultaker(167, true, Race.HUMAN, soultaker),
	FeohMysticMuse(168, true, Race.ELF, mysticMuse),
	FeohStormScreamer(169, true, Race.DARK_ELF, stormScreamer),
	FeohSoulhound(170, true, Race.KAMAEL, maleSoulhound),
	IssHierophant(171, false, Race.HUMAN, hierophant),
	IssSwordMuse(172, false, Race.ELF, swordMuse),
	IssSpectralDancer(173, false, Race.DARK_ELF, spectralDancer),
	IssDominator(174, false, Race.ORC, dominator),
	IssDoomcryer(175, false, Race.ORC, doomcryer),
	WynnArcanaLord(176, true, true, Race.HUMAN, arcanaLord),
	WynnElementalMaster(177, true, true, Race.ELF, elementalMaster),
	WynnSpectralMaster(178, true, true, Race.DARK_ELF, spectralMaster),
	AeoreCardinal(179, true, Race.HUMAN, cardinal),
	AeoreEvaSaint(180, true, Race.ELF, evaSaint),
	AeoreShillienSaint(181, true, Race.DARK_ELF, shillienSaint),
	ErtheiaFighter(182, false, Race.ERTHEIA, null),
	ErtheiaWizard(183, true, Race.ERTHEIA, null),
	Marauder(184, false, Race.ERTHEIA, ErtheiaFighter),
	CloudBreaker(185, true, Race.ERTHEIA, ErtheiaWizard),
	Ripper(186, false, Race.ERTHEIA, Marauder),
	Stratomancer(187, true, Race.ERTHEIA, CloudBreaker),
	Eviscerator(188, false, Race.ERTHEIA, Ripper),
	SayhaSeer(189, true, Race.ERTHEIA, Stratomancer);
	
	/** The Identifier of the Class */
	private final int _id;
	
	/** True if the class is a mage class */
	private final boolean _isMage;
	
	/** True if the class is a summoner class */
	private final boolean _isSummoner;
	
	/** The Race object of the class */
	private final Race _race;
	
	/** The parent ClassId or null if this class is a root */
	private final ClassId _parent;
	
	/**
	 * Class constructor.
	 * @param pId the class Id.
	 * @param pIsMage {code true} if the class is mage class.
	 * @param race the race related to the class.
	 * @param pParent the parent class Id.
	 */
	private ClassId(int pId, boolean pIsMage, Race race, ClassId pParent)
	{
		_id = pId;
		_isMage = pIsMage;
		_isSummoner = false;
		_race = race;
		_parent = pParent;
	}
	
	/**
	 * Class constructor.
	 * @param pId the class Id.
	 * @param pIsMage {code true} if the class is mage class.
	 * @param pIsSummoner {code true} if the class is summoner class.
	 * @param race the race related to the class.
	 * @param pParent the parent class Id.
	 */
	private ClassId(int pId, boolean pIsMage, boolean pIsSummoner, Race race, ClassId pParent)
	{
		_id = pId;
		_isMage = pIsMage;
		_isSummoner = pIsSummoner;
		_race = race;
		_parent = pParent;
	}
	
	/**
	 * Gets the ID of the class.
	 * @return the ID of the class
	 */
	@Override
	public final int getId()
	{
		return _id;
	}
	
	/**
	 * @return {code true} if the class is a mage class.
	 */
	public final boolean isMage()
	{
		return _isMage;
	}
	
	/**
	 * @return {code true} if the class is a summoner class.
	 */
	public final boolean isSummoner()
	{
		return _isSummoner;
	}
	
	/**
	 * @return the Race object of the class.
	 */
	public final Race getRace()
	{
		return _race;
	}
	
	/**
	 * @param cid the parent ClassId to check.
	 * @return {code true} if this Class is a child of the selected ClassId.
	 */
	public final boolean childOf(ClassId cid)
	{
		if (_parent == null)
		{
			return false;
		}
		
		if (_parent == cid)
		{
			return true;
		}
		
		return _parent.childOf(cid);
		
	}
	
	/**
	 * @param cid the parent ClassId to check.
	 * @return {code true} if this Class is equal to the selected ClassId or a child of the selected ClassId.
	 */
	public final boolean equalsOrChildOf(ClassId cid)
	{
		return (this == cid) || childOf(cid);
	}
	
	/**
	 * @return the child level of this Class (0=root, 1=child leve 1...)
	 */
	public final int level()
	{
		if (_parent == null)
		{
			return 0;
		}
		// 603 temp fix start
		else if (_parent == ErtheiaFighter || _parent == ErtheiaWizard)
		{
			return 2;
		}
		// 603 temp fix end
		
		return 1 + _parent.level();
	}
	
	/**
	 * @return its parent Class Id
	 */
	public final ClassId getParent()
	{
		return _parent;
	}
	
	public static ClassId getClassId(int cId)
	{
		try
		{
			return ClassId.values()[cId];
		}
		catch (Exception e)
		{
			return null;
		}
	}
}