mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-10 20:46:47 +03:00
Update compiled docs.
This commit is contained in:
parent
e49450d6b6
commit
fcccbde1be
18 changed files with 152 additions and 69 deletions
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>AIObject</strong></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -234,7 +235,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><strong>CameraInfo</strong></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -144,7 +145,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -41,6 +41,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><strong>Color</strong></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -298,7 +299,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -336,7 +337,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -40,6 +40,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><strong>InventoryObject</strong></li>
|
||||
|
@ -337,7 +338,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -40,6 +40,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -560,7 +561,7 @@ takes no arguments.
|
|||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> item = ItemInfo.newItem(
|
||||
PISTOLS_ITEM, <span class="comment">-- object id
|
||||
ObjID.PISTOLS_ITEM, <span class="comment">-- object id
|
||||
</span> <span class="string">"test"</span>, <span class="comment">-- name
|
||||
</span> Position.new(<span class="number">18907</span>, <span class="number">0</span>, <span class="number">21201</span>),
|
||||
Rotation.new(<span class="number">0</span>,<span class="number">0</span>,<span class="number">0</span>),
|
||||
|
@ -653,7 +654,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -40,6 +40,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -432,7 +433,7 @@ INVISIBLE
|
|||
</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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -198,7 +199,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -35,6 +35,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -76,7 +77,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -1074,7 +1075,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -41,6 +41,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -236,7 +237,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -41,6 +41,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -235,7 +236,7 @@ angles, in degrees, about each axis.</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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -118,7 +119,7 @@
|
|||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "door<em>back</em>room" or "cracked<em>greek</em>statue"
|
||||
e.g. "door_back_room" or "cracked_greek_statue"
|
||||
|
||||
|
||||
|
||||
|
@ -164,7 +165,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -40,6 +40,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -179,7 +180,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -162,7 +163,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -37,6 +37,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="classes/Color.html">Color</a></li>
|
||||
<li><a href="classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -63,7 +64,7 @@
|
|||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="modules/gameflow.html">gameflow</a></td>
|
||||
<td class="summary">Functions to be used in GameFlow.lua</td>
|
||||
<td class="summary">Files that will be run on game startup.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="modules/gamelogic.html">gamelogic</a></td>
|
||||
|
@ -76,6 +77,10 @@
|
|||
<td class="name" ><a href="classes/AIObject.html">AIObject</a></td>
|
||||
<td class="summary">AI object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/AudioTrack.html">AudioTrack</a></td>
|
||||
<td class="summary">Metadata about audio tracks (music and ambience).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/CameraInfo.html">CameraInfo</a></td>
|
||||
<td class="summary">Camera info</td>
|
||||
|
@ -140,7 +145,7 @@ angles, in degrees, about each axis.</td>
|
|||
</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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -32,7 +32,10 @@
|
|||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#gameflow_lua">gameflow.lua </a></li>
|
||||
<li><a href="#settings_lua">settings.lua </a></li>
|
||||
<li><a href="#tracks_lua">tracks.lua </a></li>
|
||||
<li><a href="#strings_lua">strings.lua </a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
@ -44,6 +47,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -65,13 +69,13 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Module <code>gameflow</code></h1>
|
||||
<p>Functions to be used in GameFlow.lua</p>
|
||||
<p>Files that will be run on game startup.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<h2><a href="#gameflow_lua">gameflow.lua </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#AddLevel">AddLevel (level)</a></td>
|
||||
|
@ -85,29 +89,39 @@
|
|||
<td class="name" ><a href="#SetTitleScreenImagePath">SetTitleScreenImagePath (path)</a></td>
|
||||
<td class="summary">The path of the .jpg or .png image to show in the background of the title screen.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetWindowTitleKey">SetWindowTitleKey (string)</a></td>
|
||||
<td class="summary">The string ID of the title of the game
|
||||
<strong>(not yet implemented)</strong></td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#settings_lua">settings.lua </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetSettings">SetSettings (settings)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#tracks_lua">tracks.lua </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetAudioTracks">SetAudioTracks (table)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#strings_lua">strings.lua </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetStrings">SetStrings (table)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
<td class="summary">Set string variable keys and their translations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetLanguageNames">SetLanguageNames (table)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetSettings">SetSettings (table)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
<td class="summary">Specify which translations in the strings table correspond to which languages.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
@ -115,8 +129,13 @@
|
|||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
<h2 class="section-header has-description"><a name="gameflow_lua"></a>gameflow.lua </h2>
|
||||
|
||||
<div class="section-description">
|
||||
These functions are called in gameflow.lua, a file loosely equivalent to winroomedit's SCRIPT.DAT.
|
||||
They handle a game's 'metadata'; i.e., things such as level titles, loading screen paths, and default
|
||||
ambient tracks.
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "AddLevel"></a>
|
||||
|
@ -129,6 +148,7 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">level</span>
|
||||
<span class="types"><a class="type" href="../classes/Level.html#">Level</a></span>
|
||||
a level object
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -181,6 +201,66 @@
|
|||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SetWindowTitleKey"></a>
|
||||
<strong>SetWindowTitleKey (string)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The string ID of the title of the game
|
||||
<strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">string</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
|
||||
ID of the title as set in TombIDE.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header has-description"><a name="settings_lua"></a>settings.lua </h2>
|
||||
|
||||
<div class="section-description">
|
||||
These functions are called in settings.lua, a file which holds your local settings.
|
||||
settings.lua shouldn't be bundled with any finished levels/games.
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetSettings"></a>
|
||||
<strong>SetSettings (settings)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">settings</span>
|
||||
<span class="types"><span class="type">Settings</span></span>
|
||||
a settings object
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header has-description"><a name="tracks_lua"></a>tracks.lua </h2>
|
||||
|
||||
<div class="section-description">
|
||||
<strong>TODO CONFIRM PROPER BEHAVIOUR</strong>
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetAudioTracks"></a>
|
||||
<strong>SetAudioTracks (table)</strong>
|
||||
|
@ -195,7 +275,7 @@
|
|||
<ul>
|
||||
<li><span class="parameter">table</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
array-style table with ??? objects
|
||||
array-style table with <a href="../classes/AudioTrack.html#">AudioTrack</a> objects
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
@ -204,14 +284,21 @@
|
|||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header has-description"><a name="strings_lua"></a>strings.lua </h2>
|
||||
|
||||
<div class="section-description">
|
||||
|
||||
These functions used in strings.lua, which is generated by TombIDE.
|
||||
You will not need to call them manually.
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetStrings"></a>
|
||||
<strong>SetStrings (table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
Set string variable keys and their translations.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
@ -232,39 +319,14 @@
|
|||
<strong>SetLanguageNames (table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
Specify which translations in the strings table correspond to which languages.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">table</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
array-style table with TODO EXTRA INFO HERE
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SetSettings"></a>
|
||||
<strong>SetSettings (table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">table</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
|
||||
array-style table with TODO EXTRA INFO HERE
|
||||
array-style table with language names
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
@ -280,7 +342,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
@ -48,6 +48,7 @@
|
|||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../classes/Color.html">Color</a></li>
|
||||
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
|
||||
|
@ -676,7 +677,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-12 20:14:56 </i>
|
||||
<i style="float:right;">Last updated 2021-08-15 23:07:28 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue