hoa_battle::private_battle::BattleActorEffect Class Reference

Temporary enum used to determine which phase of the time meter a character/enemy is in. Represents postive and negative afflictions that affect actors in battle. More...

#include <battle_actors.h>

Collaboration diagram for hoa_battle::private_battle::BattleActorEffect:

[legend]List of all members.

Public Member Functions
	BattleActorEffect (private_battle::BattleActor *const host)
void	CureEffect () const
	Removes the effect from its host.
void	Update ()
	Updates the effect's timer and other status.
virtual	~BattleActorEffect ()
BattleActorEffect class member access functionss
hoa_utils::ustring	GetEffectName () const
BattleActor *const	GetHost () const
const int32	GetModifiedAgility () const
const int32	GetModifiedHealthPoints () const
const int32	GetModifiedIntelligence () const
const int32	GetModifiedSkillPoints () const
const int32	GetModifiedStrength () const
Private Attributes
hoa_utils::ustring	_effect_name
	The name of the effect.
private_battle::BattleActor *	_host
	A pointer to the actor that the effect is afflicting.
uint32	_time_till_expiration
	The number of milliseconds remaining until the effect is removed.
Status modification members
Members which modifies various properties of the host's status
int32	_agility_modifier
int32	_health_points_modifier
int32	_intelligence_modifier
int32	_skill_points_modifier
int32	_strength_modifier

---

Detailed Description

Temporary enum used to determine which phase of the time meter a character/enemy is in. Represents postive and negative afflictions that affect actors in battle.

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

Note:

This class is place holder code right now and is not used. It will be fleshed out at a later time.

Definition at line 53 of file battle_actors.h.

---

Constructor & Destructor Documentation

hoa_battle::private_battle::BattleActorEffect::BattleActorEffect

(

private_battle::BattleActor *const

host

)

[inline]

Definition at line 55 of file battle_actors.h.

virtual hoa_battle::private_battle::BattleActorEffect::~BattleActorEffect

(

)

[inline, virtual]

Definition at line 57 of file battle_actors.h.

---

Member Function Documentation

void hoa_battle::private_battle::BattleActorEffect::CureEffect

(

)

const [inline]

Removes the effect from its host.

Definition at line 64 of file battle_actors.h.

hoa_utils::ustring hoa_battle::private_battle::BattleActorEffect::GetEffectName

(

)

const [inline]

Definition at line 71 of file battle_actors.h.

References _effect_name.

BattleActor* const hoa_battle::private_battle::BattleActorEffect::GetHost

(

)

const [inline]

Definition at line 69 of file battle_actors.h.

References _host.

const int32 hoa_battle::private_battle::BattleActorEffect::GetModifiedAgility

(

)

const [inline]

Definition at line 82 of file battle_actors.h.

References _agility_modifier.

const int32 hoa_battle::private_battle::BattleActorEffect::GetModifiedHealthPoints

(

)

const [inline]

Definition at line 74 of file battle_actors.h.

References _health_points_modifier.

const int32 hoa_battle::private_battle::BattleActorEffect::GetModifiedIntelligence

(

)

const [inline]

Definition at line 80 of file battle_actors.h.

References _intelligence_modifier.

const int32 hoa_battle::private_battle::BattleActorEffect::GetModifiedSkillPoints

(

)

const [inline]

Definition at line 76 of file battle_actors.h.

References _skill_points_modifier.

const int32 hoa_battle::private_battle::BattleActorEffect::GetModifiedStrength

(

)

const [inline]

Definition at line 78 of file battle_actors.h.

References _strength_modifier.

void hoa_battle::private_battle::BattleActorEffect::Update

(

)

[inline]

Updates the effect's timer and other status.

Definition at line 61 of file battle_actors.h.

---

Member Data Documentation

int32 hoa_battle::private_battle::BattleActorEffect::_agility_modifier [private]

Definition at line 104 of file battle_actors.h.

Referenced by GetModifiedAgility().

hoa_utils::ustring hoa_battle::private_battle::BattleActorEffect::_effect_name [private]

The name of the effect.

Definition at line 90 of file battle_actors.h.

Referenced by GetEffectName().

int32 hoa_battle::private_battle::BattleActorEffect::_health_points_modifier [private]

Definition at line 100 of file battle_actors.h.

Referenced by GetModifiedHealthPoints().

private_battle::BattleActor* hoa_battle::private_battle::BattleActorEffect::_host [private]

A pointer to the actor that the effect is afflicting.

Definition at line 88 of file battle_actors.h.

Referenced by GetHost().

int32 hoa_battle::private_battle::BattleActorEffect::_intelligence_modifier [private]

Definition at line 103 of file battle_actors.h.

Referenced by GetModifiedIntelligence().

int32 hoa_battle::private_battle::BattleActorEffect::_skill_points_modifier [private]

Definition at line 101 of file battle_actors.h.

Referenced by GetModifiedSkillPoints().

int32 hoa_battle::private_battle::BattleActorEffect::_strength_modifier [private]

Definition at line 102 of file battle_actors.h.

Referenced by GetModifiedStrength().

uint32 hoa_battle::private_battle::BattleActorEffect::_time_till_expiration [private]

The number of milliseconds remaining until the effect is removed.

Definition at line 92 of file battle_actors.h.

---

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

• battle_actors.h

---