From: Clyne Sullivan Date: Tue, 8 Sep 2015 22:23:50 +0000 (-0400) Subject: started official documentation X-Git-Url: https://code.bitgloo.com/?a=commitdiff_plain;h=e39254e1157c557232ee521b25d2ba5a60fa7578;p=clyne%2Fgamedev.git started official documentation --- diff --git a/doc/Quest.htm b/doc/Quest.htm new file mode 100644 index 0000000..bc68644 --- /dev/null +++ b/doc/Quest.htm @@ -0,0 +1,56 @@ + + + + Quest + + + +

Quest

Description

Quest.h provides quest functionality, including the master list of quests and methods for the player to access them.

+
+

class Quest

public:
+ char *title,*desc;
+ unsigned int xp;
+ Quest();
+ Quest(const char *t,const char *d,unsigned int x);
+ ~Quest(); +

char *title: Points to a string containing the quest's title.
char *desc: Points to a string containing a description of the quest.
unsigned int xp: Contains the amount of XP rewarded upon quest completion.
Quest(): Initializes a blank quest.
Quest(const char *t,const char *d,unsigned int x): Creates a quest with title t, description d, and a reward of x XP.
~Quest(): Frees memory previously used by the quest.

class QuestHandler

private:
+ unsigned char ccnt;
+ Quest *current[];
+public:
+ QuestHandler();
+ int assign(const char *t);
+ int drop(const char *t);
+ int finish(const char *t);
+

unsigned char ccnt: Contains an index to the next free slot in current[].
Quest *current[]: Contains all current quests.
QuestHandler(): Initializes a blank QuestHandler
int assign(const char *t): Adds a quest with the name t to current[]. Returns -1 on error.
int drop(const char *t): Drop a quest in current[] with the name t. Returns -1 on error.
int finish(const char *t): Removes quest with name t from current[]. Returns quest's reward.