hoa_global Namespace Reference

All calls to global code are wrapped in this namespace. More...


Classes

class  GameGlobal
 Retains all the state information about the player's active game. More...
class  GlobalActor
 Represents an actor that can participate in battles. More...
class  GlobalArmor
 Represents all four types of armor found in the game. More...
class  GlobalAttackPoint
 Represents the "attack points" present on an actor. More...
class  GlobalCharacter
 Represents playable game characters. More...
class  GlobalCharacterGrowth
 A container class for tracking the growth of a character. More...
class  GlobalElementalEffect
 Represents an elemental effect on an actor or other object. More...
class  GlobalEnemy
 Represents those enemies that fight in battles. More...
class  GlobalEventGroup
 A container that manages the occurences of several related game events. More...
class  GlobalItem
 Represents items found and used throughout the game. More...
class  GlobalKeyItem
 Represents key items found in the game. More...
class  GlobalObject
 An abstract parent class for representing a game object. More...
class  GlobalParty
 Represents a party of actors. More...
class  GlobalShard
 Represents a shard item. More...
class  GlobalSkill
 A class for representing skills used in the game. More...
class  GlobalStatusEffect
 Represents a status effect on an actor or other object. More...
class  GlobalTarget
 Represents a target for an item, action, or skill. More...
class  GlobalWeapon
 Representing weapon that may be equipped by characters or enemies. More...

Namespaces

namespace  private_global

GlobalObject Types

Used for identification of different game object types

enum  GLOBAL_OBJECT {
  GLOBAL_OBJECT_INVALID = -1, GLOBAL_OBJECT_ITEM = 0, GLOBAL_OBJECT_WEAPON = 1, GLOBAL_OBJECT_HEAD_ARMOR = 2,
  GLOBAL_OBJECT_TORSO_ARMOR = 3, GLOBAL_OBJECT_ARM_ARMOR = 4, GLOBAL_OBJECT_LEG_ARMOR = 5, GLOBAL_OBJECT_SHARD = 6,
  GLOBAL_OBJECT_KEY_ITEM = 7, GLOBAL_OBJECT_TOTAL = 8
}
GlobalObjectGlobalCreateNewObject (uint32 id, uint32 count=1)
 Creates a new type of GlobalObject.

Enumerations

Elemental Effect Types
Constants used to identify the various elementals There are a total of eight elementals: four physical and four metaphysical.

enum  GLOBAL_ELEMENTAL {
  GLOBAL_ELEMENTAL_INVALID = 0, GLOBAL_ELEMENTAL_FIRE = 1, GLOBAL_ELEMENTAL_WATER = 2, GLOBAL_ELEMENTAL_VOLT = 3,
  GLOBAL_ELEMENTAL_EARTH = 4, GLOBAL_ELEMENTAL_SLICING = 5, GLOBAL_ELEMENTAL_SMASHING = 6, GLOBAL_ELEMENTAL_MAULING = 7,
  GLOBAL_ELEMENTAL_PIERCING = 8, GLOBAL_ELEMENTAL_TOTAL = 9
}
EffectIntensity Levels
Used to reflect the potency of elemental and status effects

enum  GLOBAL_INTENSITY {
  GLOBAL_INTENSITY_INVALID = -5, GLOBAL_INTENSITY_NEG_EXTREME = -4, GLOBAL_INTENSITY_NEG_GREATER = -3, GLOBAL_INTENSITY_NEG_MODERATE = -2,
  GLOBAL_INTENSITY_NEG_LESSER = -1, GLOBAL_INTENSITY_NEUTRAL = 0, GLOBAL_INTENSITY_POS_LESSER = 1, GLOBAL_INTENSITY_POS_MODERATE = 2,
  GLOBAL_INTENSITY_POS_GREATER = 3, GLOBAL_INTENSITY_POS_EXTREME = 4, GLOBAL_INTENSITY_TOTAL = 5
}
Skill Types
Enum values used to identify the type of a skill.

enum  GLOBAL_SKILL {
  GLOBAL_SKILL_INVALID = -1, GLOBAL_SKILL_ATTACK = 0, GLOBAL_SKILL_DEFEND = 1, GLOBAL_SKILL_SUPPORT = 2,
  GLOBAL_SKILL_TOTAL = 3
}
Status Effect Types
Used to identify all of the numerous types of status effects

enum  GLOBAL_STATUS { GLOBAL_STATUS_INVALID = -1, GLOBAL_STATUS_POISON = 0, GLOBAL_STATUS_SLOW = 1, GLOBAL_STATUS_TOTAL = 2 }
Target Types
Enum values used for declaring the type of target of items, skills, and actions.

enum  GLOBAL_TARGET {
  GLOBAL_TARGET_INVALID = -1, GLOBAL_TARGET_ATTACK_POINT = 0, GLOBAL_TARGET_ACTOR = 1, GLOBAL_TARGET_PARTY = 2,
  GLOBAL_TARGET_TOTAL = 3
}
GlobalItem and GlobalSkill Usage Cases
Enum values used for identification of different game object types

enum  GLOBAL_USE {
  GLOBAL_USE_INVALID = -1, GLOBAL_USE_MENU = 0, GLOBAL_USE_BATTLE = 1, GLOBAL_USE_ALL = 2,
  GLOBAL_USE_TOTAL = 3
}

Variables

const int32 GLOBAL_BAD_EVENT = -5555555
 A return value used for when a specified event name fails to be found.
bool GLOBAL_DEBUG
 Determines whether the code in the hoa_global namespace should print debug statements or not.
bool GLOBAL_DEBUG = false
 Determines whether the code in the hoa_global namespace should print debug statements or not.
bool GLOBAL_DEBUG
GameGlobalGlobalManager
 The singleton pointer responsible for the management of global game data.
GameGlobalGlobalManager = NULL
 The singleton pointer responsible for the management of global game data.
Game Character IDs
Integers that are used for identification of characters These series of constants are used as bit-masks for determining things such as if the character may use a certain item. Only one bit should be set for each character ID.

const uint32 GLOBAL_CHARACTER_ALL = 0xFFFFFFFF
const uint32 GLOBAL_CHARACTER_CLAUDIUS = 0x00000001
const uint32 GLOBAL_CHARACTER_INVALID = 0x00000000
const uint32 GLOBAL_CHARACTER_LAILA = 0x00000002
Character Attack Point Positions
Intergers that represent the location of the four attack points on characters

const uint32 GLOBAL_POSITION_ARMS = 2
const uint32 GLOBAL_POSITION_HEAD = 0
const uint32 GLOBAL_POSITION_LEGS = 3
const uint32 GLOBAL_POSITION_TORSO = 1


Detailed Description

All calls to global code are wrapped in this namespace.

Enumeration Type Documentation

enum hoa_global::GLOBAL_ELEMENTAL

Enumerator:
GLOBAL_ELEMENTAL_INVALID 
GLOBAL_ELEMENTAL_FIRE 
GLOBAL_ELEMENTAL_WATER 
GLOBAL_ELEMENTAL_VOLT 
GLOBAL_ELEMENTAL_EARTH 
GLOBAL_ELEMENTAL_SLICING 
GLOBAL_ELEMENTAL_SMASHING 
GLOBAL_ELEMENTAL_MAULING 
GLOBAL_ELEMENTAL_PIERCING 
GLOBAL_ELEMENTAL_TOTAL 

Definition at line 52 of file global_skills.h.

enum hoa_global::GLOBAL_INTENSITY

Enumerator:
GLOBAL_INTENSITY_INVALID 
GLOBAL_INTENSITY_NEG_EXTREME 
GLOBAL_INTENSITY_NEG_GREATER 
GLOBAL_INTENSITY_NEG_MODERATE 
GLOBAL_INTENSITY_NEG_LESSER 
GLOBAL_INTENSITY_NEUTRAL 
GLOBAL_INTENSITY_POS_LESSER 
GLOBAL_INTENSITY_POS_MODERATE 
GLOBAL_INTENSITY_POS_GREATER 
GLOBAL_INTENSITY_POS_EXTREME 
GLOBAL_INTENSITY_TOTAL 

Definition at line 80 of file global_skills.h.

enum hoa_global::GLOBAL_OBJECT

Enumerator:
GLOBAL_OBJECT_INVALID 
GLOBAL_OBJECT_ITEM 
GLOBAL_OBJECT_WEAPON 
GLOBAL_OBJECT_HEAD_ARMOR 
GLOBAL_OBJECT_TORSO_ARMOR 
GLOBAL_OBJECT_ARM_ARMOR 
GLOBAL_OBJECT_LEG_ARMOR 
GLOBAL_OBJECT_SHARD 
GLOBAL_OBJECT_KEY_ITEM 
GLOBAL_OBJECT_TOTAL 

Definition at line 62 of file global_objects.h.

enum hoa_global::GLOBAL_SKILL

Enumerator:
GLOBAL_SKILL_INVALID 
GLOBAL_SKILL_ATTACK 
GLOBAL_SKILL_DEFEND 
GLOBAL_SKILL_SUPPORT 
GLOBAL_SKILL_TOTAL 

Definition at line 97 of file global_skills.h.

enum hoa_global::GLOBAL_STATUS

Enumerator:
GLOBAL_STATUS_INVALID 
GLOBAL_STATUS_POISON 
GLOBAL_STATUS_SLOW 
GLOBAL_STATUS_TOTAL 

Definition at line 68 of file global_skills.h.

enum hoa_global::GLOBAL_TARGET

Enumerator:
GLOBAL_TARGET_INVALID 
GLOBAL_TARGET_ATTACK_POINT 
GLOBAL_TARGET_ACTOR 
GLOBAL_TARGET_PARTY 
GLOBAL_TARGET_TOTAL 

Definition at line 33 of file global_actors.h.

enum hoa_global::GLOBAL_USE

Enumerator:
GLOBAL_USE_INVALID 
GLOBAL_USE_MENU 
GLOBAL_USE_BATTLE 
GLOBAL_USE_ALL 
GLOBAL_USE_TOTAL 

Definition at line 44 of file global_actors.h.


Function Documentation

GlobalObject * hoa_global::GlobalCreateNewObject ( uint32  id,
uint32  count = 1 
)

Creates a new type of GlobalObject.

Parameters:
id The id value of the object to create
count The count of the new object to create (default value == 1)
Returns:
A pointer to the newly created GlobalObject, or NULL if the object could not be created
This function actually does not create a GlobalObject (it can't, since its an abstract class), but rather creates one of the derived object class types depending on the value of the id argument.

Definition at line 35 of file global_objects.cpp.

References GLOBAL_DEBUG, hoa_global::private_global::MAX_ITEM_ID, hoa_global::private_global::MAX_KEY_ITEM_ID, hoa_global::private_global::MAX_LEG_ARMOR_ID, hoa_global::private_global::MAX_SHARD_ID, and hoa_global::private_global::MAX_WEAPON_ID.


Variable Documentation

const int32 hoa_global::GLOBAL_BAD_EVENT = -5555555

A return value used for when a specified event name fails to be found.

Definition at line 44 of file global.h.

Referenced by hoa_global::GlobalEventGroup::GetEvent(), and hoa_global::GameGlobal::GetEventValue().

const uint32 hoa_global::GLOBAL_CHARACTER_ALL = 0xFFFFFFFF

Definition at line 71 of file global_actors.h.

Referenced by hoa_defs::BindEngineToLua().

const uint32 hoa_global::GLOBAL_CHARACTER_CLAUDIUS = 0x00000001

Definition at line 69 of file global_actors.h.

Referenced by hoa_boot::BootMode::_OnBattleDebug(), hoa_boot::BootMode::_OnMenuDebug(), hoa_boot::BootMode::_OnNewGame(), and hoa_defs::BindEngineToLua().

const uint32 hoa_global::GLOBAL_CHARACTER_INVALID = 0x00000000

Definition at line 68 of file global_actors.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_menu::private_menu::CharacterWindow::CharacterWindow(), and hoa_menu::private_menu::CharacterWindow::Draw().

const uint32 hoa_global::GLOBAL_CHARACTER_LAILA = 0x00000002

Definition at line 70 of file global_actors.h.

Referenced by hoa_boot::BootMode::_OnNewGame(), and hoa_defs::BindEngineToLua().

bool hoa_global::GLOBAL_DEBUG

Determines whether the code in the hoa_global namespace should print debug statements or not.

Definition at line 40 of file global.cpp.

bool hoa_global::GLOBAL_DEBUG = false

Determines whether the code in the hoa_global namespace should print debug statements or not.

Definition at line 40 of file global.cpp.

bool hoa_global::GLOBAL_DEBUG

Definition at line 40 of file global.cpp.

Referenced by hoa_global::GlobalCharacterGrowth::_AddSkill(), hoa_global::GlobalCharacterGrowth::_CheckForGrowth(), hoa_global::GlobalAttackPoint::_LoadData(), hoa_global::GameGlobal::_SaveInventory(), hoa_global::GlobalCharacterGrowth::AcknowledgeGrowth(), hoa_global::GlobalParty::AddActor(), hoa_global::GameGlobal::AddCharacter(), hoa_global::GlobalEventGroup::AddNewEvent(), hoa_global::GameGlobal::AddNewEventGroup(), hoa_global::GlobalEnemy::AddSkill(), hoa_global::GlobalCharacter::AddSkill(), hoa_global::GameGlobal::AddToInventory(), hoa_global::GlobalSkill::BattleExecute(), hoa_global::GlobalItem::BattleUse(), hoa_global::GlobalStatusEffect::DecrementIntensity(), hoa_global::GameGlobal::DecrementObjectCount(), hoa_main::EnableDebugging(), hoa_global::GlobalActor::EquipArmor(), hoa_global::GameGlobal::GameGlobal(), hoa_global::GlobalParty::GetActorByID(), hoa_global::GlobalActor::GetArmorEquipped(), hoa_global::GlobalActor::GetAttackPoint(), hoa_global::GameGlobal::GetCharacter(), hoa_global::GlobalEventGroup::GetEvent(), hoa_global::GameGlobal::GetEventGroup(), hoa_global::GlobalActor::GetSkill(), hoa_global::GlobalActor::GetTotalEvadeRating(), hoa_global::GlobalActor::GetTotalMetaphysicalDefense(), hoa_global::GlobalActor::GetTotalPhysicalDefense(), hoa_global::GlobalArmor::GlobalArmor(), hoa_global::GlobalCharacter::GlobalCharacter(), GlobalCreateNewObject(), hoa_global::GlobalEnemy::GlobalEnemy(), hoa_global::GlobalItem::GlobalItem(), hoa_global::GlobalSkill::GlobalSkill(), hoa_global::GlobalWeapon::GlobalWeapon(), hoa_global::GlobalStatusEffect::IncrementIntensity(), hoa_global::GameGlobal::IncrementObjectCount(), hoa_global::GlobalEnemy::Initialize(), hoa_global::GlobalSkill::MenuExecute(), hoa_global::GlobalItem::MenuUse(), hoa_global::GlobalParty::RemoveActorAtIndex(), hoa_global::GlobalParty::RemoveActorByID(), hoa_global::GameGlobal::RemoveCharacter(), hoa_global::GameGlobal::RemoveFromInventory(), hoa_global::GlobalParty::ReplaceActorByID(), hoa_global::GlobalParty::ReplaceActorByIndex(), hoa_global::GameGlobal::RetrieveFromInventory(), hoa_global::GlobalEventGroup::SetEvent(), hoa_global::GameGlobal::SetLocation(), hoa_global::GlobalParty::SwapActorsByID(), hoa_global::GlobalParty::SwapActorsByIndex(), and hoa_global::GameGlobal::~GameGlobal().

const uint32 hoa_global::GLOBAL_POSITION_ARMS = 2

Definition at line 58 of file global_actors.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_global::GlobalCharacter::EquipArmArmor().

const uint32 hoa_global::GLOBAL_POSITION_HEAD = 0

Definition at line 56 of file global_actors.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_global::GlobalCharacter::EquipHeadArmor(), and hoa_global::GlobalCharacter::GlobalCharacter().

const uint32 hoa_global::GLOBAL_POSITION_LEGS = 3

Definition at line 59 of file global_actors.h.

Referenced by hoa_defs::BindEngineToLua(), hoa_global::GlobalCharacter::EquipLegArmor(), and hoa_global::GlobalCharacter::GlobalCharacter().

const uint32 hoa_global::GLOBAL_POSITION_TORSO = 1

Definition at line 57 of file global_actors.h.

Referenced by hoa_defs::BindEngineToLua(), and hoa_global::GlobalCharacter::EquipTorsoArmor().

GameGlobal* hoa_global::GlobalManager

The singleton pointer responsible for the management of global game data.

Definition at line 39 of file global.cpp.

Referenced by hoa_battle::private_battle::ActionWindow::_ConstructActionSelectionList(), hoa_menu::MenuMode::_DrawBottomMenu(), hoa_menu::MenuMode::_HandleInventoryMenu(), hoa_menu::MenuMode::_HandleSaveMenu(), hoa_menu::private_menu::EquipWindow::_InitCharSelect(), hoa_menu::private_menu::SkillsWindow::_InitCharSelect(), hoa_menu::private_menu::StatusWindow::_InitCharSelect(), hoa_menu::private_menu::InventoryWindow::_InitCharSelect(), hoa_battle::BattleMode::_Initialize(), hoa_boot::BootMode::_OnBattleDebug(), hoa_boot::BootMode::_OnLoadGame(), hoa_boot::BootMode::_OnMenuDebug(), hoa_boot::BootMode::_OnNewGame(), hoa_boot::BootMode::_OnShopDebug(), hoa_menu::private_menu::EquipWindow::_UpdateEquipList(), hoa_menu::private_menu::InventoryWindow::_UpdateItemText(), hoa_menu::private_menu::SkillsWindow::_UpdateSkillList(), hoa_battle::BattleMode::_UpdateTargetSelection(), hoa_battle::BattleMode::AddEnemy(), hoa_menu::private_menu::SkillsWindow::Draw(), hoa_menu::private_menu::CharacterWindow::Draw(), hoa_menu::private_menu::EquipWindow::EquipWindow(), hoa_menu::private_menu::FormationWindow::FormationWindow(), hoa_shop::ShopMode::GetTotalRemaining(), hoa_global::GlobalArmor::GlobalArmor(), hoa_global::GlobalItem::GlobalItem(), hoa_global::GlobalSkill::GlobalSkill(), hoa_global::GlobalWeapon::GlobalWeapon(), hoa_battle::private_battle::ActionWindow::Initialize(), InitializeEngine(), hoa_battle::BattleMode::PlayerVictory(), hoa_shop::ShopMode::Reset(), hoa_boot::BootMode::Reset(), hoa_battle::private_battle::ScriptEvent::RunScript(), hoa_menu::private_menu::StatusWindow::StatusWindow(), hoa_shop::private_shop::ConfirmWindow::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_menu::private_menu::SkillsWindow::Update(), hoa_menu::private_menu::StatusWindow::Update(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_shop::private_shop::ShopActionWindow::UpdateFinanceText(), hoa_shop::private_shop::ObjectSellListWindow::UpdateSellList(), and hoa_menu::private_menu::StatusWindow::~StatusWindow().

GameGlobal* hoa_global::GlobalManager = NULL

The singleton pointer responsible for the management of global game data.

Definition at line 39 of file global.cpp.

Referenced by hoa_battle::private_battle::ActionWindow::_ConstructActionSelectionList(), hoa_menu::MenuMode::_DrawBottomMenu(), hoa_menu::MenuMode::_HandleInventoryMenu(), hoa_menu::MenuMode::_HandleSaveMenu(), hoa_menu::private_menu::InventoryWindow::_InitCharSelect(), hoa_menu::private_menu::StatusWindow::_InitCharSelect(), hoa_menu::private_menu::SkillsWindow::_InitCharSelect(), hoa_menu::private_menu::EquipWindow::_InitCharSelect(), hoa_battle::BattleMode::_Initialize(), hoa_boot::BootMode::_OnBattleDebug(), hoa_boot::BootMode::_OnLoadGame(), hoa_boot::BootMode::_OnMenuDebug(), hoa_boot::BootMode::_OnNewGame(), hoa_boot::BootMode::_OnShopDebug(), hoa_menu::private_menu::EquipWindow::_UpdateEquipList(), hoa_menu::private_menu::InventoryWindow::_UpdateItemText(), hoa_menu::private_menu::SkillsWindow::_UpdateSkillList(), hoa_battle::BattleMode::_UpdateTargetSelection(), hoa_battle::BattleMode::AddEnemy(), hoa_menu::private_menu::CharacterWindow::Draw(), hoa_menu::private_menu::SkillsWindow::Draw(), hoa_menu::private_menu::EquipWindow::EquipWindow(), hoa_menu::private_menu::FormationWindow::FormationWindow(), hoa_shop::ShopMode::GetTotalRemaining(), hoa_global::GlobalArmor::GlobalArmor(), hoa_global::GlobalItem::GlobalItem(), hoa_global::GlobalSkill::GlobalSkill(), hoa_global::GlobalWeapon::GlobalWeapon(), hoa_battle::private_battle::ActionWindow::Initialize(), InitializeEngine(), hoa_battle::BattleMode::PlayerVictory(), hoa_boot::BootMode::Reset(), hoa_shop::ShopMode::Reset(), hoa_battle::private_battle::ScriptEvent::RunScript(), hoa_menu::private_menu::StatusWindow::StatusWindow(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_menu::private_menu::StatusWindow::Update(), hoa_menu::private_menu::SkillsWindow::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_shop::private_shop::ConfirmWindow::Update(), hoa_shop::private_shop::ShopActionWindow::UpdateFinanceText(), hoa_shop::private_shop::ObjectSellListWindow::UpdateSellList(), and hoa_menu::private_menu::StatusWindow::~StatusWindow().


Generated on Fri Jul 6 23:13:55 2007 for Hero of Allacrost by  doxygen 1.5.1