hoa_script Namespace Reference

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

Classes
class	GameScript
	Singleton class that manages all open script files. More...
class	ModifyScriptDescriptor
	Represents a Lua file opened with read, execute, and modify permissions. More...
class	ReadScriptDescriptor
	Represents a Lua file opened with read and execute permissions. More...
class	ScriptDescriptor
	An abstract class for representing open script files. More...
class	WriteScriptDescriptor
	Provides a simplistic interface for writing data to a new Lua file. More...
Namespaces
namespace	private_script
	An internal namespace to be used only by the scripting engine itself. Don't use this namespace anywhere else!
Enumerations
Script File Access Modes
Used to indicate with what priveledges a file is to be opened with.
enum	SCRIPT_ACCESS_MODE { SCRIPT_CLOSED = 0, SCRIPT_READ = 1, SCRIPT_WRITE = 2, SCRIPT_MODIFY = 3 }
Variables
bool	SCRIPT_DEBUG
	Determines whether the code in the hoa_script namespace should print debug statements or not.
bool	SCRIPT_DEBUG = false
	Determines whether the code in the hoa_script namespace should print debug statements or not.
bool	SCRIPT_DEBUG
GameScript *	ScriptManager
	The singleton pointer responsible for the interaction between the C++ engine and Lua scripts.
GameScript *	ScriptManager = NULL
	The singleton pointer responsible for the interaction between the C++ engine and Lua scripts.

---

Detailed Description

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

---

Enumeration Type Documentation

enum hoa_script::SCRIPT_ACCESS_MODE

Enumerator:

SCRIPT_CLOSED
SCRIPT_READ
SCRIPT_WRITE
SCRIPT_MODIFY

Definition at line 71 of file script.h.

---

Variable Documentation

bool hoa_script::SCRIPT_DEBUG

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

Definition at line 34 of file script.cpp.

bool hoa_script::SCRIPT_DEBUG = false

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

Definition at line 34 of file script.cpp.

bool hoa_script::SCRIPT_DEBUG

Definition at line 34 of file script.cpp.

Referenced by hoa_script::ModifyScriptDescriptor::_CommitTable(), hoa_script::WriteScriptDescriptor::CloseFile(), hoa_script::ReadScriptDescriptor::CloseFile(), hoa_script::ModifyScriptDescriptor::CloseFile(), hoa_script::ModifyScriptDescriptor::CommitChanges(), hoa_main::EnableDebugging(), hoa_script::GameScript::GameScript(), hoa_script::WriteScriptDescriptor::OpenFile(), hoa_script::ReadScriptDescriptor::OpenFile(), hoa_script::ModifyScriptDescriptor::OpenFile(), hoa_script::GameScript::~GameScript(), hoa_script::ModifyScriptDescriptor::~ModifyScriptDescriptor(), hoa_script::ReadScriptDescriptor::~ReadScriptDescriptor(), and hoa_script::WriteScriptDescriptor::~WriteScriptDescriptor().

GameScript* hoa_script::ScriptManager

The singleton pointer responsible for the interaction between the C++ engine and Lua scripts.

Definition at line 33 of file script.cpp.

Referenced by hoa_global::GlobalCharacterGrowth::AcknowledgeGrowth(), hoa_defs::BindEngineToLua(), hoa_script::ModifyScriptDescriptor::CloseFile(), hoa_script::ReadScriptDescriptor::CloseFile(), hoa_script::WriteScriptDescriptor::CloseFile(), hoa_global::GlobalCharacter::GlobalCharacter(), InitializeEngine(), main(), hoa_script::ModifyScriptDescriptor::OpenFile(), and hoa_map::private_map::DialogueManager::Update().

GameScript* hoa_script::ScriptManager = NULL

The singleton pointer responsible for the interaction between the C++ engine and Lua scripts.

Definition at line 33 of file script.cpp.

Referenced by hoa_global::GlobalCharacterGrowth::AcknowledgeGrowth(), hoa_defs::BindEngineToLua(), hoa_script::WriteScriptDescriptor::CloseFile(), hoa_script::ReadScriptDescriptor::CloseFile(), hoa_script::ModifyScriptDescriptor::CloseFile(), hoa_global::GlobalCharacter::GlobalCharacter(), InitializeEngine(), main(), hoa_script::ModifyScriptDescriptor::OpenFile(), and hoa_map::private_map::DialogueManager::Update().

---