hoa_system Namespace Reference

All calls to the system engine are wrapped in this namespace. More...


Classes

class  GameSystem
 Engine class that manages system information and functions. More...
class  SystemTimer
 A class which allows the user to easily control timed events. More...

Namespaces

namespace  private_system
 An internal namespace to be used only within the system code.

Enumerations

enum  SYSTEM_TIMER_STATE {
  SYSTEM_TIMER_INVALID = -1, SYSTEM_TIMER_INITIAL = 0, SYSTEM_TIMER_RUNNING = 1, SYSTEM_TIMER_PAUSED = 2,
  SYSTEM_TIMER_FINISHED = 3, SYSTEM_TIMER_TOTAL = 4
}
 All of the possible states which a SystemTimer classs object may be in. More...

Variables

bool SYSTEM_DEBUG
 Determines whether the code in the hoa_system namespace should print debug statements or not.
bool SYSTEM_DEBUG = false
 Determines whether the code in the hoa_system namespace should print debug statements or not.
bool SYSTEM_DEBUG
const uint32 SYSTEM_INFINITE_TIME = 4294967295UL
 A constant that represents an "infinite" number of milliseconds that can never be reached.
const int32 SYSTEM_LOOP_INFINITE = -1
 A constant to pass to any "number_loops" function argument in the TimerSystem class Passing this constant to a TimerSystem object will instruct the timer to run indefinitely and never finish.
GameSystemSystemManager
 The singleton pointer responsible for managing the system during game operation.
GameSystemSystemManager = NULL
 The singleton pointer responsible for managing the system during game operation.


Detailed Description

All calls to the system engine are wrapped in this namespace.

Enumeration Type Documentation

enum hoa_system::SYSTEM_TIMER_STATE

All of the possible states which a SystemTimer classs object may be in.

Enumerator:
SYSTEM_TIMER_INVALID 
SYSTEM_TIMER_INITIAL 
SYSTEM_TIMER_RUNNING 
SYSTEM_TIMER_PAUSED 
SYSTEM_TIMER_FINISHED 
SYSTEM_TIMER_TOTAL 

Definition at line 52 of file system.h.


Variable Documentation

bool hoa_system::SYSTEM_DEBUG

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

Definition at line 33 of file system.cpp.

bool hoa_system::SYSTEM_DEBUG = false

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

Definition at line 33 of file system.cpp.

bool hoa_system::SYSTEM_DEBUG

Definition at line 33 of file system.cpp.

Referenced by hoa_main::EnableDebugging(), hoa_system::GameSystem::GameSystem(), hoa_system::SystemTimer::SetDuration(), hoa_system::SystemTimer::SetModeOwner(), hoa_system::SystemTimer::SetNumberLoops(), and hoa_system::GameSystem::~GameSystem().

const uint32 hoa_system::SYSTEM_INFINITE_TIME = 4294967295UL

A constant that represents an "infinite" number of milliseconds that can never be reached.

Note:
This value is technically not infinite, but it is the maximum value of a 32-bit unsigned integer (2^32 - 1). This value will only be reached after ~49.7 consecutive days of the game running, which shouldn't happen.

Definition at line 43 of file system.h.

const int32 hoa_system::SYSTEM_LOOP_INFINITE = -1

A constant to pass to any "number_loops" function argument in the TimerSystem class Passing this constant to a TimerSystem object will instruct the timer to run indefinitely and never finish.

Definition at line 49 of file system.h.

GameSystem* hoa_system::SystemManager

The singleton pointer responsible for managing the system during game operation.

Definition at line 32 of file system.cpp.

Referenced by hoa_boot::BootMode::_AnimateLogo(), hoa_menu::MenuMode::_DrawBottomMenu(), hoa_battle::BattleMode::_Initialize(), hoa_input::GameInput::_JoystickEventHandler(), hoa_input::GameInput::_KeyEventHandler(), hoa_boot::BootMode::_OnQuit(), hoa_quit::QuitMode::_QuitGame(), hoa_system::SystemTimer::_UpdateTimer(), hoa_defs::BindEngineToLua(), hoa_boot::BootMode::BootMode(), hoa_battle::private_battle::BattleEnemyActor::DrawSprite(), hoa_battle::private_battle::BattleCharacterActor::DrawSprite(), hoa_input::GameInput::EventHandler(), hoa_map::private_map::ActionAnimate::Execute(), hoa_map::private_map::ActionRandomMove::Execute(), hoa_system::SystemTimer::Initialize(), InitializeEngine(), main(), hoa_battle::BattleMode::SetPerformingScript(), hoa_map::private_map::EnemyZone::Update(), hoa_shop::private_shop::ObjectSellListWindow::Update(), hoa_shop::private_shop::ObjectListWindow::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_scene::SceneMode::Update(), hoa_quit::QuitMode::Update(), hoa_mode_manager::GameModeManager::Update(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_map::private_map::EnemySprite::Update(), hoa_map::MapMode::Update(), hoa_boot::BootMode::Update(), hoa_battle::private_battle::ActionWindow::Update(), hoa_battle::private_battle::BattleEnemyActor::Update(), hoa_battle::private_battle::BattleCharacterActor::Update(), hoa_battle::private_battle::ScriptEvent::Update(), hoa_audio::GameAudio::Update(), and hoa_system::SystemTimer::~SystemTimer().

GameSystem* hoa_system::SystemManager = NULL

The singleton pointer responsible for managing the system during game operation.

Definition at line 32 of file system.cpp.

Referenced by hoa_boot::BootMode::_AnimateLogo(), hoa_menu::MenuMode::_DrawBottomMenu(), hoa_battle::BattleMode::_Initialize(), hoa_input::GameInput::_JoystickEventHandler(), hoa_input::GameInput::_KeyEventHandler(), hoa_boot::BootMode::_OnQuit(), hoa_quit::QuitMode::_QuitGame(), hoa_system::SystemTimer::_UpdateTimer(), hoa_defs::BindEngineToLua(), hoa_boot::BootMode::BootMode(), hoa_battle::private_battle::BattleCharacterActor::DrawSprite(), hoa_battle::private_battle::BattleEnemyActor::DrawSprite(), hoa_input::GameInput::EventHandler(), hoa_map::private_map::ActionRandomMove::Execute(), hoa_map::private_map::ActionAnimate::Execute(), hoa_system::SystemTimer::Initialize(), InitializeEngine(), main(), hoa_battle::BattleMode::SetPerformingScript(), hoa_audio::GameAudio::Update(), hoa_battle::private_battle::ScriptEvent::Update(), hoa_battle::private_battle::BattleCharacterActor::Update(), hoa_battle::private_battle::BattleEnemyActor::Update(), hoa_battle::private_battle::ActionWindow::Update(), hoa_boot::BootMode::Update(), hoa_map::MapMode::Update(), hoa_map::private_map::EnemySprite::Update(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_mode_manager::GameModeManager::Update(), hoa_quit::QuitMode::Update(), hoa_scene::SceneMode::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_shop::private_shop::ObjectListWindow::Update(), hoa_shop::private_shop::ObjectSellListWindow::Update(), hoa_map::private_map::EnemyZone::Update(), and hoa_system::SystemTimer::~SystemTimer().


Generated on Fri Jul 6 23:16:05 2007 for Hero of Allacrost by  doxygen 1.5.1