Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

ogs::items::Armor Class Reference

An item worn for protection in combat. More...

#include <Armor.h>

Inheritance diagram for ogs::items::Armor:

Inheritance graph
[legend]
Collaboration diagram for ogs::items::Armor:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Proficiency { LIGHT = 1, MEDIUM = 2, HEAVY = 3 }
 The proficiency required to effectively utilize the armor. More...


Public Member Functions

virtual Proficiency getProficiency () const=0
 Determine the proficiency required to effectively utilize this armor.

virtual ogs::core::ModifiergetDefenseBonus ()=0
 Determine the defense modifier added when wearing this armor.

virtual ogs::core::ModifiergetArmorCheckPenalty ()=0
 Determine the armor check penalty for this armor.

virtual int getArcaneSpellFailure ()=0
 Determine the arcane spell failure of this armor.


Detailed Description

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:
ogs::feats::ArmorProficiency


Member Enumeration Documentation

enum ogs::items::Armor::Proficiency
 

Enumeration values:
LIGHT  Requires light armor proficiency feat.
MEDIUM  Requires medium armor proficiency feat.
HEAVY  Requires heavy armor proficiency feat.


Member Function Documentation

int Armor::getArcaneSpellFailure  )  [pure virtual]
 

Derived classes should override this function if the arcane spell failure is not zero (0).

Returns:
Arcane spell failure.(default 0).

Modifier & Armor::getArmorCheckPenalty  )  [pure virtual]
 

Derived classes must override this method! The default implementation throws a logic error.

Returns:
Armor check penalty.

Modifier & Armor::getDefenseBonus  )  [pure virtual]
 

Returns:
Defense modifier.

virtual Proficiency ogs::items::Armor::getProficiency  )  const [pure virtual]
 

Returns:
Proficiency of this armor: LIGHT, MEDIUM, or HEAVY.


The documentation for this class was generated from the following files:
Generated on Sun Apr 20 03:39:43 2003 for Open Gaming System (OGS) by doxygen1.3