QuestWeaver
A procedural quest generator
Main API

Classes

struct  weave::ContractFailedException
 The main exception type used by all classes of the QuestWeaver system. More...
 
struct  weave::Directories
 This struct hold information about the programs file search paths. More...
 
class  weave::Logger
 The logger used to print errors and debug messages. More...
 
class  weave::QuestWeaver
 Main entry point for applications using the quest system. More...
 
class  weave::RandomStream
 RNG used by the quest system. More...
 
struct  weave::WeaverConfig
 Holds the configuration data to create new QuestWeaver instances. More...
 

Typedefs

typedef uint64_t weave::ID
 Used to identify unique objects in the quest system, i.e. More...
 

Enumerations

enum  weave::FormatterType { weave::FormatterType::TEXT, weave::FormatterType::HTML }
 Defines the possible output formats of the texts produced by the quest system. More...
 
enum  weave::StreamType { weave::StreamType::JSON, weave::StreamType::BINARY }
 Defines the possible serialization types of the quest system. More...
 

Detailed Description

Typedef Documentation

typedef uint64_t weave::ID

Used to identify unique objects in the quest system, i.e.

quests or world entities.

Definition at line 17 of file WeaverTypes.h.

Enumeration Type Documentation

enum weave::FormatterType
strong

Defines the possible output formats of the texts produced by the quest system.

Enumerator
TEXT 

All texts will be created as vanilla texts without any additional formatting markers.

HTML 

A number of html tags will be injected into the created text to allow the output to be formatted with css classes.

Definition at line 98 of file WeaverTypes.h.

enum weave::StreamType
strong

Defines the possible serialization types of the quest system.

Enumerator
JSON 

A verbose text format, good for debugging or manual changes.

Big size and slow compared to the binary format.

BINARY 

A compact binary format without compression; fastest option.

Definition at line 80 of file WeaverTypes.h.