OGS Java API Spec

ogs.feats
Class AllWeapons

java.lang.Object
  |
  +--ogs.support.Object
        |
        +--ogs.core.Feature
              |
              +--ogs.core.Feat
                    |
                    +--ogs.feats.WeaponProficiency
                          |
                          +--ogs.feats.AllWeapons
All Implemented Interfaces:
EventListener

public class AllWeapons
extends WeaponProficiency

A weapon proficiency for all weapons of one group. Simple Weapon Proficiency is a general feat that indicates that a creature is proficient with all simple weapons. Some cclasses are also proficient with all martial weapons. Exotic weapons can only be selected as single weapons. This class can be used instead of the SingleWeapon class to indicate that a creature is proficient with all weapons in one of these groups.

See Also:
SingleWeapon

Field Summary
 
Fields inherited from class ogs.core.Feat
COMBAT, CUMULATIVE, EXCLUSIVE, GENERAL, MAGIC, REPEATABLE, SPECIAL
 
Fields inherited from class ogs.support.Object
listeners
 
Method Summary
static AllWeapons createMartial()
          Create a new Martial Weapon Proficiency feat.
static AllWeapons createSimple()
          Create a new Simple Weapon Proficiency feat.
 int getCompatibility()
          Determine the compatability of this feat.
 int getProficiency()
          Determine weapon proficiency that this feat applies to.
 boolean isProficient(Weapon weapon)
          Determine if a weapon is a proficient weapon.
 
Methods inherited from class ogs.feats.WeaponProficiency
getGroup
 
Methods inherited from class ogs.core.Feat
canAttach, findFeat, getSlots, getSlotsLevel
 
Methods inherited from class ogs.core.Feature
attachObject, canDetach, detachObject, getObject
 
Methods inherited from class ogs.support.Object
addListener, handleEvent, notifyListeners, removeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createSimple

public static AllWeapons createSimple()
Create a new Simple Weapon Proficiency feat.

Returns:
A new Simple Weapon Proficiency feat.

createMartial

public static AllWeapons createMartial()
Create a new Martial Weapon Proficiency feat.

Returns:
A new Simple Weapon Proficiency feat.

getCompatibility

public int getCompatibility()
Determine the compatability of this feat. Weapon proficiency feats for all weapons are exclusive feats.

Specified by:
getCompatibility in class Feat
Returns:
Feat.EXCLUSIVE

getProficiency

public int getProficiency()
Determine weapon proficiency that this feat applies to.

Specified by:
getProficiency in class WeaponProficiency
Returns:
Proficiency of weapon: SIMPLE or MARTIAL.

isProficient

public boolean isProficient(Weapon weapon)
Determine if a weapon is a proficient weapon. A proficient weapon is a weapon that a creature with this feat is proficient with. If this feat is not attached to a creature, the weapon is not a proficient weapon.

Specified by:
isProficient in class WeaponProficiency
Returns:
True if weapon is a proficient weapon.

OGS Java API Spec