OGS Java API Spec

ogs.items
Class Armor

java.lang.Object
  |
  +--ogs.support.Object
        |
        +--ogs.core.Entity
              |
              +--ogs.core.Item
                    |
                    +--ogs.items.Armor
All Implemented Interfaces:
EventListener

public abstract class Armor
extends Item

An item worn for protection in combat. Armor is typically a suit or partial suit of steel, leather, or other material that is worn over the body. Armor belongs to one of three proficiencies: light, medium, or heavy. The armor proficiency determines the armor proficiency feat required to use it effectively.

See Also:
ArmorProficiency

Field Summary
static int HEAVY
          Use requires heavy armor proficiency.
static int LIGHT
          Use requires light armor proficiency.
static int MEDIUM
          Use requires medium armor proficiency.
 
Fields inherited from class ogs.core.Item
GLASS, IRON, PAPER, STONE, UNKNOWN, WOOD
 
Fields inherited from class ogs.core.Entity
currentHealth, defense, maximumHealth, size, weight
 
Fields inherited from class ogs.support.Object
listeners
 
Constructor Summary
Armor()
           
 
Method Summary
static int getArcaneSpellFailure()
          Determine the arcane spell failure.
static Modifier getArmorCheckPenalty()
          Determine the armor check penalty.
static Modifier getDefenseBonus()
          Determine the defense bonus.
static int getProficiency()
          Determine proficiency of armor.
 
Methods inherited from class ogs.core.Item
getDensity, getHardness, getMaterial, getThickness, getWorth, setDensity, setHardness, setMaterial, setThickness, setWorth, updateHealthPoints
 
Methods inherited from class ogs.core.Entity
getCurrentHealth, getDefense, getMaximumHealth, getSize, getWeight, setCurrentHealth, setMaximumHealth, setWeight
 
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
 

Field Detail

LIGHT

public static final int LIGHT
Use requires light armor proficiency.

See Also:
Constant Field Values

MEDIUM

public static final int MEDIUM
Use requires medium armor proficiency.

See Also:
Constant Field Values

HEAVY

public static final int HEAVY
Use requires heavy armor proficiency.

See Also:
Constant Field Values
Constructor Detail

Armor

public Armor()
Method Detail

getProficiency

public static int getProficiency()
Determine proficiency of armor. Subclasses must override this method and return one of the values LIGHT, MEDIUM, or HEAVY.

Returns:
Zero (0).

getDefenseBonus

public static Modifier getDefenseBonus()
Determine the defense bonus. Subclasses must override this method.

Returns:
Defense bonus.

getArmorCheckPenalty

public static Modifier getArmorCheckPenalty()
Determine the armor check penalty. Subclasses must override this method.

Returns:
Armor check penalty.

getArcaneSpellFailure

public static int getArcaneSpellFailure()
Determine the arcane spell failure. Subclasses must override this method.

Returns:
Arcane spell failure.

OGS Java API Spec