Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-04-28 15:57:59 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix broken links in documentation. Add title and description.

Browse source
This commit is contained in:
hispidence 2021-08-23 20:16:01 +01:00
parent 5f66005277
commit f3354fa0ef
22 changed files with 82 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

2
config.ld
View file

@ -6,6 +6,8 @@ new_type("entityclass", "Entity classes", true)
new_type("pregameclass", "Pre-game script classes", true)
new_type("miscclass", "Misc classes", true)
project = "TombEngine"
title = "TombEngine Lua API"
description = "TombEngine scripting interface"
style = true
wrap = true
template = true

4
doc/entity classes/AIObject.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -245,7 +245,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/entity classes/CameraInfo.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -155,7 +155,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/entity classes/ItemInfo.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -680,7 +680,7 @@ Use this if you called new with no arguments
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/entity classes/MeshInfo.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -209,7 +209,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/entity classes/SinkInfo.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -175,7 +175,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/entity classes/SoundSourceInfo.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -173,7 +173,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/enums/InvItem.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -347,7 +347,7 @@ EXAMINE_ITEM8_COMBO2
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/enums/ObjID.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -1085,7 +1085,7 @@ PANEL_MIDDLE_CORNER
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

39
doc/index.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
</head>
<body>
@ -69,15 +69,16 @@
<div id="content">
<h2>TombEngine scripting interface</h2>
<h2>Script Files</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="script_files/Pre-game.html">Pre-game</a></td>
<td class="name" ><a href="script files/Pre-game.html">Pre-game</a></td>
<td class="summary">Scripts that will be run on game startup.</td>
</tr>
<tr>
<td class="name" ><a href="script_files/Level-specific.html">Level-specific</a></td>
<td class="name" ><a href="script files/Level-specific.html">Level-specific</a></td>
<td class="summary">Functions and callbacks for level-specific logic scripts.</td>
</tr>
</table>
@ -95,69 +96,69 @@
<h2>Entity classes</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="entity_classes/AIObject.html">AIObject</a></td>
<td class="name" ><a href="entity classes/AIObject.html">AIObject</a></td>
<td class="summary">AI object</td>
</tr>
<tr>
<td class="name" ><a href="entity_classes/CameraInfo.html">CameraInfo</a></td>
<td class="name" ><a href="entity classes/CameraInfo.html">CameraInfo</a></td>
<td class="summary">Camera info</td>
</tr>
<tr>
<td class="name" ><a href="entity_classes/ItemInfo.html">ItemInfo</a></td>
<td class="name" ><a href="entity classes/ItemInfo.html">ItemInfo</a></td>
<td class="summary">Represents any object inside the game world.</td>
</tr>
<tr>
<td class="name" ><a href="entity_classes/MeshInfo.html">MeshInfo</a></td>
<td class="name" ><a href="entity classes/MeshInfo.html">MeshInfo</a></td>
<td class="summary">Mesh info</td>
</tr>
<tr>
<td class="name" ><a href="entity_classes/SinkInfo.html">SinkInfo</a></td>
<td class="name" ><a href="entity classes/SinkInfo.html">SinkInfo</a></td>
<td class="summary">Sink info</td>
</tr>
<tr>
<td class="name" ><a href="entity_classes/SoundSourceInfo.html">SoundSourceInfo</a></td>
<td class="name" ><a href="entity classes/SoundSourceInfo.html">SoundSourceInfo</a></td>
<td class="summary">Sound source info</td>
</tr>
</table>
<h2>Pre-game script classes</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="pre_game_script_classes/AudioTrack.html">AudioTrack</a></td>
<td class="name" ><a href="pre-game script classes/AudioTrack.html">AudioTrack</a></td>
<td class="summary">Metadata about audio tracks (music and ambience).</td>
</tr>
<tr>
<td class="name" ><a href="pre_game_script_classes/InventoryObject.html">InventoryObject</a></td>
<td class="name" ><a href="pre-game script classes/InventoryObject.html">InventoryObject</a></td>
<td class="summary">Represents the properties of an object as it appears in the inventory.</td>
</tr>
<tr>
<td class="name" ><a href="pre_game_script_classes/Level.html">Level</a></td>
<td class="name" ><a href="pre-game script classes/Level.html">Level</a></td>
<td class="summary">Stores level metadata.</td>
</tr>
<tr>
<td class="name" ><a href="pre_game_script_classes/Mirror.html">Mirror</a></td>
<td class="name" ><a href="pre-game script classes/Mirror.html">Mirror</a></td>
<td class="summary">A mirror effect.</td>
</tr>
<tr>
<td class="name" ><a href="pre_game_script_classes/Settings.html">Settings</a></td>
<td class="name" ><a href="pre-game script classes/Settings.html">Settings</a></td>
<td class="summary">Settings that will be run on game startup.</td>
</tr>
<tr>
<td class="name" ><a href="pre_game_script_classes/SkyLayer.html">SkyLayer</a></td>
<td class="name" ><a href="pre-game script classes/SkyLayer.html">SkyLayer</a></td>
<td class="summary">Describes a layer of moving clouds.</td>
</tr>
</table>
<h2>Misc classes</h2>
<table class="module_list">
<tr>
<td class="name" ><a href="misc_classes/Color.html">Color</a></td>
<td class="name" ><a href="misc classes/Color.html">Color</a></td>
<td class="summary">An RGBA or RGB color.</td>
</tr>
<tr>
<td class="name" ><a href="misc_classes/Position.html">Position</a></td>
<td class="name" ><a href="misc classes/Position.html">Position</a></td>
<td class="summary">Represents a position in the game world.</td>
</tr>
<tr>
<td class="name" ><a href="misc_classes/Rotation.html">Rotation</a></td>
<td class="name" ><a href="misc classes/Rotation.html">Rotation</a></td>
<td class="summary">Represents a rotation.</td>
</tr>
</table>
@ -166,7 +167,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/misc classes/Color.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -301,7 +301,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/misc classes/Position.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -239,7 +239,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/misc classes/Rotation.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -239,7 +239,7 @@ All values will be clamped to [-32768, 32767].</p>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/pre-game script classes/AudioTrack.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -87,7 +87,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/pre-game script classes/InventoryObject.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -348,7 +348,7 @@ associated getters and setters.
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

25
doc/pre-game script classes/Level.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -125,6 +125,10 @@
<td class="summary">(bool) Enable smooth transition from horizon graphic to sky layer.</td>
</tr>
<tr>
<td class="name" ><a href="#storm">storm</a></td>
<td class="summary">(bool) Enable flickering lightning in the sky.</td>
</tr>
<tr>
<td class="name" ><a href="#weather">weather</a></td>
<td class="summary">(WeatherType) Choose weather effect.</td>
</tr>
@ -324,6 +328,23 @@
</dd>
<dt>
<a name = "storm"></a>
<strong>storm</strong>
</dt>
<dd>
(bool) Enable flickering lightning in the sky.
Equivalent to classic TRLE's LIGHTNING setting. As in the TRC Ireland levels.</p>
<p> <strong>(thunder sounds not yet implemented)</strong>
</dd>
<dt>
<a name = "weather"></a>
@ -504,7 +525,7 @@ Must be in the range [1, 127], and equal to or less than the value passed to Set
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/pre-game script classes/Mirror.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -89,7 +89,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/pre-game script classes/Settings.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -132,7 +132,7 @@ an invalid argument.</p>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/pre-game script classes/SkyLayer.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -188,7 +188,7 @@ Less is more. City of The Dead, for example, uses a speed value of 16.
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/script files/Level-specific.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -687,7 +687,7 @@ and provides the delta time (a float representing game time since last call) via
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

4
doc/script files/Pre-game.html
View file

@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<title>TombEngine Lua API</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
@ -356,7 +356,7 @@ Specify which translations in the strings table correspond to which languages.
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
<i style="float:right;">Last updated 2021-08-23 20:14:37 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
ldoc.ltp
View file

@ -300,7 +300,7 @@
<table class="module_list">
# for m in mods() do
<tr>
<td class="name" $(nowrap)><a href="$(no_spaces(kind))/$(m.name).html">$(m.name)</a></td>
<td class="name" $(nowrap)><a href="$(kind)/$(m.name).html">$(m.name)</a></td>
<td class="summary">$(M(ldoc.strip_header(m.summary),m))</td>
</tr>
# end -- for modules