Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberfilth committed Aug 7, 2022
1 parent 8985495 commit c7ce87f
Show file tree
Hide file tree
Showing 41 changed files with 1,935 additions and 1,044 deletions.
36 changes: 3 additions & 33 deletions docs/AllConstants.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,55 +48,25 @@ <h1 class="allitems">All Constants</h1>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="npc_lookup.html#caveNPC1">caveNPC1</a></td>
<td class="itemunit"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>Array of creatures found in a cave, ordered by cave level</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="npc_lookup.html#caveNPC2">caveNPC2</a></td>
<td class="itemunit"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="npc_lookup.html#caveNPC3">caveNPC3</a></td>
<td class="itemunit"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="plot_gen.html#DayStr">DayStr</a></td>
<td class="itemunit"><a class="bold" href="plot_gen.html">plot_gen</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="item_lookup.html#dgnItems1">dgnItems1</a></td>
<td class="itemunit"><a class="bold" href="item_lookup.html">item_lookup</a></td>
<td class="itemdesc"><p>Array of items found in a dungeon, ordered by dungeon level</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="item_lookup.html#dgnItems2">dgnItems2</a></td>
<td class="itemunit"><a class="bold" href="item_lookup.html">item_lookup</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="item_lookup.html#dgnItems3">dgnItems3</a></td>
<td class="itemunit"><a class="bold" href="item_lookup.html">item_lookup</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="npc_lookup.html#dgnNPC1">dgnNPC1</a></td>
<td class="itemunit"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>Array of creatures found in a dungeon, ordered by dungeon level</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="npc_lookup.html#dgnNPC2">dgnNPC2</a></td>
<td class="itemunit"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="npc_lookup.html#dgnNPC3">dgnNPC3</a></td>
<td class="itemunit"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="scrTargeting.html#empty">empty</a></td>
<td class="itemunit"><a class="bold" href="scrTargeting.html">scrTargeting</a></td>
Expand Down
557 changes: 376 additions & 181 deletions docs/AllFunctions.html

Large diffs are not rendered by default.

1,089 changes: 632 additions & 457 deletions docs/AllIdentifiers.html

Large diffs are not rendered by default.

23 changes: 14 additions & 9 deletions docs/AllTypes.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,51 +53,56 @@ <h1 class="allitems">All Types</h1>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="globalUtils.html#path">path</a></td>
<td class="itemunit"><a class="bold" href="globalUtils.html">globalUtils</a></td>
<td class="itemdesc"><p>Pathfinding - Path to player</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="entities.html#Tattitudes">Tattitudes</a></td>
<td class="itemunit"><a class="bold" href="entities.html">entities</a></td>
<td class="itemdesc"><p>NPC attitudes</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="cave.html#Tbkinds">Tbkinds</a></td>
<td class="itemunit"><a class="bold" href="cave.html">cave</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="smell.html#Tbkinds">Tbkinds</a></td>
<td class="itemunit"><a class="bold" href="smell.html">smell</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="cave.html#TDist">TDist</a></td>
<td class="itemunit"><a class="bold" href="cave.html">cave</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="smell.html#TDist">TDist</a></td>
<td class="itemunit"><a class="bold" href="smell.html">smell</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="entities.html#Tfactions">Tfactions</a></td>
<td class="itemunit"><a class="bold" href="entities.html">entities</a></td>
<td class="itemdesc"><p>NPC factions / groups</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="items.html#tItem">tItem</a></td>
<td class="itemunit"><a class="bold" href="items.html">items</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="items.html#TitemList">TitemList</a></td>
<td class="itemunit"><a class="bold" href="items.html">items</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="items.html#tMaterial">tMaterial</a></td>
<td class="itemunit"><a class="bold" href="items.html">items</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="magicEffects.html#TSmallintArray">TSmallintArray</a></td>
<td class="itemunit"><a class="bold" href="magicEffects.html">magicEffects</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
Expand Down
78 changes: 47 additions & 31 deletions docs/AllUnits.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,133 +99,141 @@ <h1 class="allitems">All Units</h1>
<td class="itemdesc"><p>Common functions / utilities</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="gnome_warrior.html">gnome_warrior</a></td>
<td class="itemname"><a class="bold" href="gnome_assassin.html">gnome_assassin</a></td>
<td class="itemdesc"><p>Intelligent enemy with scent tracking</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="gnome_warrior.html">gnome_warrior</a></td>
<td class="itemdesc"><p>Intelligent enemy with scent tracking</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="green_fungus.html">green_fungus</a></td>
<td class="itemdesc"><p>Stationary hazard, when attacked will either poison the player or release spores</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="hyena_fungus.html">hyena_fungus</a></td>
<td class="itemdesc"><p>Hyena, infected by fungus</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="island.html">island</a></td>
<td class="itemdesc"><p>Stores the overworld map and provides helper functions</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="items.html">items</a></td>
<td class="itemdesc"><p>Items and objects in the game world</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="item_lookup.html">item_lookup</a></td>
<td class="itemdesc"><p>Lookup table for items, based on the environment</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="KeyboardInput.html">KeyboardInput</a></td>
<td class="itemdesc"><p>Player input for game controls and menu selections, grouped in procedures</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="large_blood_bat.html">large_blood_bat</a></td>
<td class="itemdesc"><p>Weak enemy with simple AI, no pathfinding</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="leather_armour1.html">leather_armour1</a></td>
<td class="itemdesc"><p>Low quality leather armour</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="logging.html">logging</a></td>
<td class="itemdesc"><p>Used for logging which procedures are called and in what order</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="los.html">los</a></td>
<td class="itemdesc"><p>Line of sight &amp; targeting functions</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="magicEffects.html">magicEffects</a></td>
<td class="itemdesc"><p>Magic and Spell effects are calculated here</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="main.html">main</a></td>
<td class="itemdesc"><p>Axes, Armour &amp; Ale - A fantasy roguelike. </p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="map.html">map</a></td>
<td class="itemdesc"><p>Organises the current level into an array together with helper functions</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="mushroom_person.html">mushroom_person</a></td>
<td class="itemdesc"><p>Mushroom person - slow but can poison the player</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="noise.html">noise</a></td>
<td class="itemdesc"><p>Generate Perlin noise</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="npc_lookup.html">npc_lookup</a></td>
<td class="itemdesc"><p>Lookup table for NPC's, based on the environment</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="overworld.html">overworld</a></td>
<td class="itemdesc"><p>The overworld that Axes, Armour &amp; Ale is set in. Generated using perlin noise and cellular automata over several iterations and then framed in an 'island' cutout</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="pixie_jar.html">pixie_jar</a></td>
<td class="itemdesc"><p>A glowing pixie in a jar - Light source</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="player.html">player</a></td>
<td class="itemdesc"><p>Player creation and movement</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="player_inventory.html">player_inventory</a></td>
<td class="itemdesc"><p>Handles player inventory and associated functions</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="player_stats.html">player_stats</a></td>
<td class="itemdesc"><p>Additional player stats that are not shared with other entities are stored here</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="plot_gen.html">plot_gen</a></td>
<td class="itemdesc"><p>Generate names and plot elements</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="pointy_stick.html">pointy_stick</a></td>
<td class="itemdesc"><p>A pointy stick</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="redcap_fungus.html">redcap_fungus</a></td>
<td class="itemdesc"><p>Redcap infected by fungus</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="redcap_lesser.html">redcap_lesser</a></td>
<td class="itemdesc"><p>Intelligent enemy with scent tracking</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="redcap_lesser_lobber.html">redcap_lesser_lobber</a></td>
<td class="itemdesc"><p>Hunter enemy, fires projectiles</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="resolution.html">resolution</a></td>
<td class="itemdesc"><p>Determines the terminal size when the game is first opened and resizes the user interface accordingly. For a typical 80x24 terminal size, the camera size will be 57x19 For a terminal size of 102x24 and greater, the camera size will be 80x19 This is kept to 19 rather than the full 20 to allow for screenshake to be added in future versions.</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="rock.html">rock</a></td>
<td class="itemdesc"><p>A rock, causes base damage of 4 points</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="scrCharacter.html">scrCharacter</a></td>
<td class="itemdesc"><p>Character sheet - Shows player stats</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="scrCharIntro.html">scrCharIntro</a></td>
<td class="itemdesc"><p>Character introduction and scene setting</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="scrCharSelect.html">scrCharSelect</a></td>
<td class="itemdesc"><p>Choose your characters race</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="scrDeathList.html">scrDeathList</a></td>
<td class="itemdesc"><p>Display number of enemies killed</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="scrGame.html">scrGame</a></td>
<td class="itemdesc"><p>Main game user interface</p></td>
Expand Down Expand Up @@ -317,6 +325,14 @@ <h1 class="allitems">All Units</h1>
<td class="itemdesc"><p>Generate the game world, caves, dungeons, its levels and related info</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="web.html">web</a></td>
<td class="itemdesc"><p>Environmental hazard - blocks entities</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="web_trap.html">web_trap</a></td>
<td class="itemdesc"><p>A trap that creates more webs when triggered</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="wine_flask.html">wine_flask</a></td>
<td class="itemdesc"><p>Flask of wine - cures poison</p></td>
</tr>
Expand Down
Loading

0 comments on commit c7ce87f

Please sign in to comment.