OGS Java API Spec

ogs.feats
Class WeaponProficiency

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

public abstract class WeaponProficiency
extends Feat

A feat that allows the effective use of a weapon. A creature that uses a weapon without being proficient with it suffers a -4 penatly to attack rolls. This class is the base class for derived classes that identify specific types of weapons for this proficiency feat.


Field Summary
 
Fields inherited from class ogs.core.Feat
COMBAT, CUMULATIVE, EXCLUSIVE, GENERAL, MAGIC, REPEATABLE, SPECIAL
 
Fields inherited from class ogs.support.Object
listeners
 
Constructor Summary
WeaponProficiency()
           
 
Method Summary
 int getGroup()
          Determine the group that this feat belongs to.
abstract  int getProficiency()
          Determine weapon proficiency that this feat applies to.
abstract  boolean isProficient(Weapon weapon)
          Determine if a weapon is a proficient weapon.
 
Methods inherited from class ogs.core.Feat
canAttach, findFeat, getCompatibility, 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
 

Constructor Detail

WeaponProficiency

public WeaponProficiency()
Method Detail

getGroup

public int getGroup()
Determine the group that this feat belongs to. Weapon proficiency feats are general feats.

Specified by:
getGroup in class Feat
Returns:
Feat.GENERAL

getProficiency

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

Returns:
Proficiency of weapon: SIMPLE, MARTIAL, or EXOTIC.

isProficient

public abstract 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.

Returns:
True if weapon is a proficient weapon.

OGS Java API Spec