This library defines the Story object, and other helper objects/routines.
More...
Collaboration diagram for Story Library:
|
Classes | |
| class | story::Story |
| This is the high-level story object. More... | |
Functions | |
| virtual const char * | story::Story::getUuid (void) const =0 throw () |
| every story must have a universally unique ID | |
| virtual const char * | story::Story::getTitle (void) const =0 throw () |
| short title (preferably 16 characters or less!) | |
| virtual const char * | story::Story::getStartingMapId (void) const =0 throw () |
| return the ID of the starting map (game starts here) | |
| virtual std::string | story::Story::getObjectPath (const char *objectType, const char *objectId) const =0 |
| Given an object ID, and type of object, return the path. | |
| virtual smart_ptr< i18n::Manager > | story::Story::getI18nManager (const char *path)=0 |
| given the locale-relative path, return an i18n::Manager object Example: getI18nManager("converse/system.txt") | |
| static smart_ptr< Story > | story::Story::create (const char *locale, const char *story_dir) |
Detailed Description
This library defines the Story object, and other helper objects/routines.
A Story is a kind of database, containing all information that a generic game engine needs to run. In particular, AESOP Server Library and AESOP Reference Client libraries use Story objects to determine how to find and load important game data.
Function Documentation
| virtual const char* story::Story::getUuid | ( | void | ) | const throw () [pure virtual, inherited] |
every story must have a universally unique ID
| virtual const char* story::Story::getTitle | ( | void | ) | const throw () [pure virtual, inherited] |
short title (preferably 16 characters or less!)
| virtual const char* story::Story::getStartingMapId | ( | void | ) | const throw () [pure virtual, inherited] |
return the ID of the starting map (game starts here)
| virtual std::string story::Story::getObjectPath | ( | const char * | objectType, | |
| const char * | objectId | |||
| ) | const [pure virtual, inherited] |
Given an object ID, and type of object, return the path.
Examples:
- getObjectPath("map", "firstGameMap.map")
- getObjectPath("model", "cube.model")
- getObjectPath("type", "chicken.type")
| virtual smart_ptr<i18n::Manager> story::Story::getI18nManager | ( | const char * | path | ) | [pure virtual, inherited] |
given the locale-relative path, return an i18n::Manager object Example: getI18nManager("converse/system.txt")
