hoa_global::GlobalElementalEffect Class Reference

Represents an elemental effect on an actor or other object. More...

#include <global_skills.h>

Collaboration diagram for hoa_global::GlobalElementalEffect:

[legend]List of all members.

Public Member Functions
void	DecrementIntensity (uint8 amount=1)
	Decrements the elemental effect's intensity.
	GlobalElementalEffect ()
void	IncrementIntensity (uint8 amount=1)
	Increments the elemental effect's intensity.
	~GlobalElementalEffect ()
GLOBAL_INTENSITY	GetIntensity () const
GLOBAL_ELEMENTAL	GetType () const
	Class Member Access Functions.
void	SetIntensity (GLOBAL_INTENSITY intensity)
Private Attributes
GLOBAL_INTENSITY	_intensity
	The intensity of the elemental effect has Note that this member only includes positive values since it is an unsigned integer. This is done for simplicity. Whether the elemental effect is a defensive boost or an offensive boost is not determined by this class, but rather the context in which the class object is used.
GLOBAL_ELEMENTAL	_type
	The type (identifier) of elemental that the object represents Refer to the Elemental Effect Types for a list of the valid types and values that this member may be.

---

Detailed Description

Represents an elemental effect on an actor or other object.

****************************************************************************

Elemental effects are special types of attack and defense bonuses. They do not apply on individual attack points, but rather on the whole of a character or enemy. There are really two types of elemental effects: physical and metaphysical (the same as the two types of attacks). The difference between physical and metaphysical attacks is the relationship of elemental strengths and weaknesses. For example, equpping an armor with the metaphysical "fire" elemental makes the bearer weak against water, but strong against earth. On the contrary, an armor with the phyiscal "piercing" elemental makes the bearer strong against piercing attacks.

Definition at line 119 of file global_skills.h.

---

Constructor & Destructor Documentation

hoa_global::GlobalElementalEffect::GlobalElementalEffect

(

)

[inline]

Definition at line 121 of file global_skills.h.

hoa_global::GlobalElementalEffect::~GlobalElementalEffect

(

)

[inline]

Definition at line 124 of file global_skills.h.

---

Member Function Documentation

void hoa_global::GlobalElementalEffect::DecrementIntensity

(

uint8

amount = 1

)

Decrements the elemental effect's intensity.

Parameters:

amount

The number of levels to decrease the intensity by (default = 1)

GLOBAL_INTENSITY hoa_global::GlobalElementalEffect::GetIntensity

(

)

const [inline]

Definition at line 134 of file global_skills.h.

References _intensity.

GLOBAL_ELEMENTAL hoa_global::GlobalElementalEffect::GetType

(

)

const [inline]

Class Member Access Functions.

Note:

The "Set" functions may also change the _icon_image member of this class

Definition at line 131 of file global_skills.h.

References _type.

void hoa_global::GlobalElementalEffect::IncrementIntensity

(

uint8

amount = 1

)

Increments the elemental effect's intensity.

Parameters:

amount

The number of levels to increase the intensity by (default = 1)

void hoa_global::GlobalElementalEffect::SetIntensity

(

GLOBAL_INTENSITY

intensity

)

[inline]

Definition at line 137 of file global_skills.h.

References _intensity.

---

Member Data Documentation

GLOBAL_INTENSITY hoa_global::GlobalElementalEffect::_intensity [private]

The intensity of the elemental effect has Note that this member only includes positive values since it is an unsigned integer. This is done for simplicity. Whether the elemental effect is a defensive boost or an offensive boost is not determined by this class, but rather the context in which the class object is used.

Definition at line 163 of file global_skills.h.

Referenced by GetIntensity(), and SetIntensity().

GLOBAL_ELEMENTAL hoa_global::GlobalElementalEffect::_type [private]

The type (identifier) of elemental that the object represents Refer to the Elemental Effect Types for a list of the valid types and values that this member may be.

Definition at line 156 of file global_skills.h.

Referenced by GetType().

---

The documentation for this class was generated from the following file:

• global_skills.h

---