ParaScripting::ParaBootStrapper Class Reference
[ParaBootStrapper]

List of all members.

Detailed Description

ParaGlobal namespace contains a list of HAPI functions to access the boot strapper functionality.

Bootstrapper file is a xml file to be executed at the very beginning of the game engine. Its main function is to specify the main game loop file to be activated. When the ParaIDE set a solution to be active, it actually modifies the bootstrapper file to load the main file of that application solution.


Static Public Member Functions

static bool LoadFromFile (const char *sXMLfile)
 load from a given XML file.
static bool SaveToFile (const char *sXMLfile)
 save to a given XML file.
static void LoadDefault ()
 load the default setting.
static const char * GetMainLoopFile ()
 get the game loop file.
static void SetMainLoopFile (const char *sMainFile)
 Set the game loop file.


Member Function Documentation

bool ParaScripting::ParaBootStrapper::LoadFromFile ( const char *  sXMLfile  )  [static]

load from a given XML file.

Parameters:
sXMLfile the path of the file, if this is "", the config/bootstrapper.xml will be used.
Returns:
true if success

bool ParaScripting::ParaBootStrapper::SaveToFile ( const char *  sXMLfile  )  [static]

save to a given XML file.

Parameters:
sXMLfile the path of the file, if this is "", the config/bootstrapper.xml will be used.
Returns:
true if success

void ParaScripting::ParaBootStrapper::LoadDefault (  )  [static]

load the default setting.

this function is called at the constructor.

const char * ParaScripting::ParaBootStrapper::GetMainLoopFile (  )  [static]

get the game loop file.

the game loop file provides the heart beat of the application. It is also the very first(entry) script to be activated when the application starts up. The default game loop is ./script/gameinterface.lua

void ParaScripting::ParaBootStrapper::SetMainLoopFile ( const char *  sMainFile  )  [static]

Set the game loop file.

the game loop file provides the heart beat of the application. It is also the very first(entry) script to be activated when the application starts up. The default game loop is ./script/gameinterface.lua


Generated on Mon Dec 1 14:34:47 2008 for NPL Scripting Reference for ParaEngine by  doxygen 1.5.2