hoa_global::GlobalArmor Class Reference

Represents all four types of armor found in the game. More...

#include <global_objects.h>

Inheritance diagram for hoa_global::GlobalArmor:

[legend]Collaboration diagram for hoa_global::GlobalArmor:

[legend]List of all members.

Public Member Functions
uint32	GetMetaphysicalDefense () const
GLOBAL_OBJECT	GetObjectType () const
	Purely virtual function used to distinguish between object types.
uint32	GetPhysicalDefense () const
uint32	GetUsableBy () const
	GlobalArmor (uint32 id, uint32 count=1)
	~GlobalArmor ()
Private Attributes
uint32	_metaphysical_defense
	The amount of metaphysical defense that the armor provides.
uint32	_physical_defense
	The amount of physical defense that the armor provides.
uint32	_usable_by
	A bit-mask that determines which characters can use or equip the object See the Game Character ID constants in global_actors.h for more information.

---

Detailed Description

Represents all four types of armor found in the game.

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

Not all pieces of armor can be equipped by all characters. Even though there's only one armor class, there are actually four types of armor: head, torso, arm, and leg. The GetObjectType method is used to identify what armor category an instance of this class belongs to. All four types of armor have the same members/properties.

Definition at line 305 of file global_objects.h.

---

Constructor & Destructor Documentation

hoa_global::GlobalArmor::GlobalArmor	(	uint32	id,
		uint32	count = 1
	)

Definition at line 230 of file global_objects.cpp.

References hoa_global::GameGlobal::_arm_armor_script, hoa_global::GlobalObject::_description, hoa_global::GameGlobal::_head_armor_script, hoa_global::GlobalObject::_icon_image, hoa_global::GlobalObject::_id, hoa_global::GameGlobal::_leg_armor_script, _metaphysical_defense, hoa_global::GlobalObject::_name, _physical_defense, hoa_global::GlobalObject::_price, hoa_global::GameGlobal::_torso_armor_script, _usable_by, hoa_script::ReadScriptDescriptor::CloseTable(), hoa_script::ReadScriptDescriptor::DoesTableExist(), hoa_script::ScriptDescriptor::GetErrorMessages(), hoa_global::GLOBAL_DEBUG, hoa_global::GlobalManager, hoa_script::ScriptDescriptor::IsErrorDetected(), hoa_video::ImageDescriptor::Load(), hoa_utils::MakeUnicodeString(), hoa_global::private_global::MAX_ARM_ARMOR_ID, hoa_global::private_global::MAX_HEAD_ARMOR_ID, hoa_global::private_global::MAX_LEG_ARMOR_ID, hoa_global::private_global::MAX_TORSO_ARMOR_ID, hoa_script::ReadScriptDescriptor::OpenTable(), hoa_script::ReadScriptDescriptor::ReadString(), hoa_script::ReadScriptDescriptor::ReadUInt(), and hoa_video::StillImage::SetFilename().

Here is the call graph for this function:

hoa_global::GlobalArmor::~GlobalArmor

(

)

[inline]

Definition at line 309 of file global_objects.h.

---

Member Function Documentation

uint32 hoa_global::GlobalArmor::GetMetaphysicalDefense

(

)

const [inline]

Definition at line 317 of file global_objects.h.

References _metaphysical_defense.

Referenced by hoa_menu::MenuMode::_DrawBottomMenu(), and hoa_shop::private_shop::ObjectInfoWindow::SetObject().

GLOBAL_OBJECT hoa_global::GlobalArmor::GetObjectType

(

)

const [virtual]

Purely virtual function used to distinguish between object types.

Returns:

A value that represents the type of object

Implements hoa_global::GlobalObject.

Definition at line 287 of file global_objects.cpp.

References hoa_global::GlobalObject::_id, hoa_global::GLOBAL_OBJECT_ARM_ARMOR, hoa_global::GLOBAL_OBJECT_HEAD_ARMOR, hoa_global::GLOBAL_OBJECT_LEG_ARMOR, hoa_global::GLOBAL_OBJECT_TORSO_ARMOR, hoa_global::private_global::MAX_ARM_ARMOR_ID, hoa_global::private_global::MAX_HEAD_ARMOR_ID, and hoa_global::private_global::MAX_TORSO_ARMOR_ID.

Referenced by hoa_global::GlobalActor::EquipArmor().

uint32 hoa_global::GlobalArmor::GetPhysicalDefense

(

)

const [inline]

Definition at line 314 of file global_objects.h.

References _physical_defense.

Referenced by hoa_menu::MenuMode::_DrawBottomMenu(), and hoa_shop::private_shop::ObjectInfoWindow::SetObject().

uint32 hoa_global::GlobalArmor::GetUsableBy

(

)

const [inline]

Definition at line 320 of file global_objects.h.

References _usable_by.

---

Member Data Documentation

uint32 hoa_global::GlobalArmor::_metaphysical_defense [private]

The amount of metaphysical defense that the armor provides.

Definition at line 328 of file global_objects.h.

Referenced by GetMetaphysicalDefense(), and GlobalArmor().

uint32 hoa_global::GlobalArmor::_physical_defense [private]

The amount of physical defense that the armor provides.

Definition at line 325 of file global_objects.h.

Referenced by GetPhysicalDefense(), and GlobalArmor().

uint32 hoa_global::GlobalArmor::_usable_by [private]

A bit-mask that determines which characters can use or equip the object See the Game Character ID constants in global_actors.h for more information.

Definition at line 333 of file global_objects.h.

Referenced by GetUsableBy(), and GlobalArmor().

---

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

• global_objects.h
• global_objects.cpp

---