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

ogs::magic::PhysicalComponent Class Reference

A spell component with physical attributes. More...

#include <PhysicalComponent.h>

Inheritance diagram for ogs::magic::PhysicalComponent:

Inheritance graph
[legend]
Collaboration diagram for ogs::magic::PhysicalComponent:

Collaboration graph
[legend]
List of all members.

Public Member Functions

const std::string & getDetails () const
 Determine the details of this component.

float getCost () const
 Determine the cost of this component.

bool useDivineFocus () const
 Determine if this component requires a divine focus when casting the divine version of a spell.


Static Public Member Functions

PhysicalComponent Material (const std::string &details, float cost=0.0, bool useDivineFocus=false)
 Create a new Material component.

PhysicalComponent Focus (const std::string &details, float cost=0.0, bool useDivineFocus=false)
 Create a new Focus component.


Protected Member Functions

 PhysicalComponent (Component::Type type, const std::string &details, float cost=0.0, bool useDivineFocus=false)
 Create a new physical component.


Detailed Description

These attributes further describe the physical nature of the component. Some components have significant costs and others use a divine focus when casting divine magic.


Constructor & Destructor Documentation

ogs::magic::PhysicalComponent::PhysicalComponent Component::Type  type,
const std::string &  details,
float  cost = 0.0,
bool  useDivineFocus = false
[inline, protected]
 

Parameters:
type Type of component (MATERIAL or FOCUS).
details Details of this component.
cost Cost of component in standard monetary unit (default 0).
useDivineFocus True if divine version of spell requires divine focus (default false).


Member Function Documentation

PhysicalComponent ogs::magic::PhysicalComponent::Focus const std::string &  details,
float  cost = 0.0,
bool  useDivineFocus = false
[inline, static]
 

Parameters:
details Details of physical component.
cost Cost of component in standard monetary unit (default 0).
useDivineFocus True if divine version of spell requires divine focus (default false).
Returns:
A focus component.

float ogs::magic::PhysicalComponent::getCost  )  const [inline]
 

Returns:
Cost in standard monetary units.

const std::string & ogs::magic::PhysicalComponent::getDetails  )  const [inline]
 

Returns:
Details of component.

PhysicalComponent ogs::magic::PhysicalComponent::Material const std::string &  details,
float  cost = 0.0,
bool  useDivineFocus = false
[inline, static]
 

Parameters:
details Details of physical component.
cost Cost of component in standard monetary unit (default 0).
useDivineFocus True if divine version of spell requires divine focus (default false).
Returns:
A material component.

bool ogs::magic::PhysicalComponent::useDivineFocus  )  const [inline]
 

Returns:
True if divine fcous is required for divine spell.


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