aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Entity.htm82
-rw-r--r--doc/Quest.htm64
-rw-r--r--doc/QuestList.htm40
-rw-r--r--doc/World.htm40
4 files changed, 0 insertions, 226 deletions
diff --git a/doc/Entity.htm b/doc/Entity.htm
deleted file mode 100644
index 87cf4f1..0000000
--- a/doc/Entity.htm
+++ /dev/null
@@ -1,82 +0,0 @@
-<!DOCTYPE html>
-<html>
- <head>
- <style>
- body{
- font-family:Consolas;
- font-size:12px;
- }
- .branch{
- border: solid 1px #000000;
- font-family:Consolas;
- font-size:12px;
- margin:auto 20px;
- padding:5px;
- }
- .collapse{
- font-size: 31px;
- display:block;
- }
- .collapse + input{
- display:none;
- }
- .collapse + input + *{
- display:none;
- }
- .collapse+ input:checked + *{
- display:block;
- }
- </style>
- </head>
- <body>
- <h1>Entity Types</h1>
- <hr>
- <h1 style="font-size:20px;">How it works: (Click the words)</h1>
- <label class="collapse" for="_--1">ID (Name)</label>
- <input id="_--1" type="checkbox">
- <div class = "branch">
- <label class="collapse" for="_--1_-1">-1 (Sub-Type)</label>
- <input id="_--1_-1" type="checkbox">
- <div class="branch"><p> - Subtypes with negative IDS have non-standard traits ie: infinite health, doors can be destroyed with a weapon, spawn points, etc...</p></div>
- <label class="collapse" for="_--1_1">&nbsp0 (Base)</label>
- <input id="_--1_1" type="checkbox">
- <div class="branch"><p> - Subtype 0 is always the base version of that entity, all other ID's are variations</p></div>
- <label class="collapse" for="_--1_2">&nbsp1 (Sub-Type)</label>
- <input id="_--1_2" type="checkbox">
- <div class="branch"><p> - Since the subtype is not 0, this entity is a subversion (modified traits) of that version </p></div>
- </div>
- <hr>
-
- <label class="collapse" for="_-1">-1 (Structures)</label>
- <input id="_-1" type="checkbox">
- <div class = "branch">
- <label class="collapse" for="_-1_1">1 (Village)</label>
- <input id="_-1_1" type="checkbox">
- <div class="branch"><p> - village spawns a center of the village which spawns a variety of buildings and NPCS</p></div>
- <label class="collapse" for="_-1_2">2 (Castle)</label>
- <input id="_-1_2" type="checkbox">
- <div class="branch"><p> - Castle - Not yet emplemented</p></div>
- </div>
- <hr>
-
- <label class="collapse" for="_0">&nbsp0 (Players)</label>
- <input id="_0" type="checkbox">
- <div class="branch"><p> - Player</p></div>
- <hr>
-
- <label class="collapse" for="_1">&nbsp1 (NPCs)</label>
- <input id="_1" type="checkbox">
- <div class="branch">
- <label class="collapse" for="_1_0">0 (Base)</label>
- <input id="_1_0" type="checkbox">
- <div class="branch"><p> - Villagers are spawned with the village spawn point <br> - The base villagers and the role-assigned villagers with no task with just talk with the player</p></div>
- <label class="collapse" for="_1_1">1 (The Merchant)</label>
- <input id="_1_1" type="checkbox">
- <div class="branch"><p> - The merchant will try to trade the player certain objects for either money or other items of similar worth</p></div>
- </div>
- <hr>
-
-
-
- </body>
-</html>
diff --git a/doc/Quest.htm b/doc/Quest.htm
deleted file mode 100644
index 5492f16..0000000
--- a/doc/Quest.htm
+++ /dev/null
@@ -1,64 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
- <title>Quest</title>
- <style>
- .code{
- background:#555;
- color:white;
- font-family:Consolas;
- font-size:12px;
- margin:auto 20px;
- padding:20px;
- }
- </style>
-</head>
-<body>
- <h1>Quest</h1>
- <hr>
- <h2>Description</h2>
- <p>Quest.h provides quest functionality, including the master list of quests and methods for the player to access them.</p>
- <br>
- <h3>Macros</h3>
- <div class="code">#define QUEST_LIMIT 5<br>
- #define TOTAL_QUESTS 1
- </div>
- <ul>
- <li><b>QUEST_LIMIT</b>: Total number of quests a QuestHandler can handle.</li>
- <li><b>TOTAL_QUESTS</b>: Total number of quests in the game.</li>
- </ul>
- <h3>class Quest</h3>
- <div class="code"><b>public:</b><br>
- char *title,*desc;<br>
- unsigned int xp;<br>
- Quest();<br>
- Quest(const char *t,const char *d,unsigned int x);<br>
- ~Quest();
- </div>
- <ul>
- <li>char *<b>title</b>: Points to a string containing the quest's title.</li>
- <li>char *<b>desc</b>: Points to a string containing a description of the quest.</li>
- <li>unsigned int <b>xp</b>: Contains the amount of XP rewarded upon quest completion.</li>
- <li><b>Quest()</b>: Initializes a blank quest.</li>
- <li><b>Quest(const char *t,const char *d,unsigned int x)</b>: Creates a quest with title <i>t</i>, description <i>d</i>, and a reward of <i>x</i> XP.</li>
- <li><b> ~Quest()</b>: Frees memory previously used by the quest.</li>
- </ul>
- <h3>class QuestHandler</h3>
- <div class="code"><b>private:</b><br>
- unsigned char ccnt;<br>
- Quest *current[QUEST_LIMIT];<br>
-<b>public:</b><br>
- QuestHandler();<br>
- int assign(const char *t);<br>
- int drop(const char *t);<br>
- int finish(const char *t);<br>
- </div>
- <ul>
- <li>unsigned char <b>ccnt</b>: Contains an index to the next free slot in current[].</li>
- <li>Quest *<b>current[]</b>: Contains all current quests.</li>
- <li><b>QuestHandler()</b>: Initializes a blank QuestHandler</li>
- <li>int <b>assign(const char *t)</b>: Adds a quest with the name <i>t</i> to current[]. Returns -1 on error.</li>
- <li>int <b>drop(const char *t)</b>: Drop a quest in current[] with the name <i>t</i>. Returns -1 on error.</li>
- <li>int <b>finish(const char *t)</b>: Removes quest with name <i>t</i> from current[]. Returns quest's reward.</li>
-</body>
-</html>
diff --git a/doc/QuestList.htm b/doc/QuestList.htm
deleted file mode 100644
index a4bf677..0000000
--- a/doc/QuestList.htm
+++ /dev/null
@@ -1,40 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
- <title>Quest</title>
- <style>
- .title{
- background:#833;
- color:white;
- font-family:Consolas;
- font-size:16px;
- margin:auto 20px;
- padding:12px;
- }
- .code{
- background:#555;
- color:white;
- font-family:Consolas;
- font-size:12px;
- margin:auto 20px;
- padding:20px;
- }
- .reward{
- background:#383;
- color:white;
- font-family:Consolas;
- font-size:16px;
- margin:auto 20px;
- padding:15px;
-
- }
- </style>
-</head>
-<body>
- <h1>Quests</h1>
- <hr>
- <div class="title">Hello there!</div>
- <div class="code">In this quest you must find the starting village of ASS</div>
- <div class="reward">A starting weapon for the class of your choice</div>
-</body>
-</html>
diff --git a/doc/World.htm b/doc/World.htm
deleted file mode 100644
index d17c551..0000000
--- a/doc/World.htm
+++ /dev/null
@@ -1,40 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
- <title>World</title>
- <style>
- .code{
- background:#555;
- color:white;
- font-family:Consolas;
- font-size:12px;
- margin:auto 20px;
- padding:20px;
- }
- </style>
-</head>
-<body>
- <h1>World</h1>
- <hr>
- <h2>Description</h2>
- <p>World.h contains functions to create and draw worlds, and provide basic object detection.</p>
- <br>
- <p>The standard form of world generation in World.h is an array of randomly sized vertical lines.
-The width of each line is defined as a single HLINE, a macro defined in common.h. ...</p>
- <h3>class World</h3>
- <div class="code"><b>private:</b><br>
- struct line_t {<br>
- float start;<br>
- } *line;<br>
- unsigned int lineCount;<br>
-<b>public:</b><br>
- World(float width);<br>
- void draw(void);<br>
- void detect(vec2 *v,const float width);<br>
- </div>
- <ul>
- <li>struct line_t: float <b>start</b>: Where the top of the line is located.</li>
- <li>unsigned int <b>lineCount</b>: Contains the size of the array <i>line</i>.</li>
- </ul>
-</body>
-</html>