WeaponProf.java

/*
 * WeaponProf.java
 * Copyright 2002 (C) Greg Bingleman <byngl@hotmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * Created on December 13, 2002, 9:19 AM
 *
 * Current Ver: $Revision$
 * Last Editor: $Author$
 * Last Edited: $Date$
 *
 */
package plugin.bonustokens;

import pcgen.core.bonus.MultiTagBonusObj;

/**
 * Handles the BONUS:WEAPONPROF= token.
 */
public final class WeaponProf extends MultiTagBonusObj
{
	private static final String[] bonusTags =
			{"CRITMULTADD", "CRITRANGEADD", "CRITRANGEDOUBLE", "DAMAGE",
				"DAMAGE-SHORTRANGE", "DAMAGESIZE", "PCSIZE", "REACH", "TOHIT",
				"TOHIT-SHORTRANGE", "TOHITOVERSIZE", "WEAPONBAB",
				"WIELDCATEGORY"};

	/**
	 * Return the bonus tag handled by this class.
	 * @return The bonus handled by this class.
	 */
	@Override
	public String getBonusHandled()
	{
		return "WEAPONPROF=";
	}

	/**
	 * Get by index, an individual weapon proficiency attribute that may be bonused.
	 * @param tagNumber the index of the weapon proficiency attribute.
	 * @see pcgen.core.bonus.MultiTagBonusObj#getBonusTag(int)
	 * @return The weapon proficiency attribute.
	 */
	@Override
	protected String getBonusTag(final int tagNumber)
	{
		return bonusTags[tagNumber];
	}

	/**
	 * Get the number of weapon proficiency attributes that may be bonused.
	 * @see pcgen.core.bonus.MultiTagBonusObj#getBonusTag(int)
	 * @return The number of weapon proficiency attributes.
	 */
	@Override
	protected int getBonusTagLength()
	{
		return bonusTags.length;
	}
}