mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-04-28 15:57:59 +03:00
Add new compiled doc files.
This commit is contained in:
hispidence
parent
bc9e863307
commit
c8377e4ab7
28 changed files with 2411 additions and 2259 deletions
|
|
@ -1,243 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>AIObject</code></h1>
|
||||
<p>AI object</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.pos">AIObject.pos</a></td>
|
||||
<td class="summary">(<a href="../classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.yRot">AIObject.yRot</a></td>
|
||||
<td class="summary">(int) y-axis rotation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.name">AIObject.name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.room">AIObject.room</a></td>
|
||||
<td class="summary">(int) room number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.objID">AIObject.objID</a></td>
|
||||
<td class="summary">(<a href="../classes/ObjID.html#">ObjID</a>) object ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.flags">AIObject.flags</a></td>
|
||||
<td class="summary">(short) flags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.triggerFlags">AIObject.triggerFlags</a></td>
|
||||
<td class="summary">(short) trigger flags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#AIObject.boxNumber">AIObject.boxNumber</a></td>
|
||||
<td class="summary">(short) box number</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "AIObject.pos"></a>
|
||||
<strong>AIObject.pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.yRot"></a>
|
||||
<strong>AIObject.yRot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) y-axis rotation
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.name"></a>
|
||||
<strong>AIObject.name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "door<em>back</em>room" or "cracked<em>greek</em>statue"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.room"></a>
|
||||
<strong>AIObject.room</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) room number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.objID"></a>
|
||||
<strong>AIObject.objID</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/ObjID.html#">ObjID</a>) object ID
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.flags"></a>
|
||||
<strong>AIObject.flags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(short) flags
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.triggerFlags"></a>
|
||||
<strong>AIObject.triggerFlags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(short) trigger flags
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "AIObject.boxNumber"></a>
|
||||
<strong>AIObject.boxNumber</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(short) box number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-16 12:53:44 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/AIObject.html">AIObject</a></li>
|
||||
<li><strong>AudioTrack</strong></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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>AudioTrack</code></h1>
|
||||
<p>Metadata about audio tracks (music and ambience).</p>
|
||||
<p><strong>In progress</strong> </p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-16 12:53:44 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,153 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>CameraInfo</code></h1>
|
||||
<p>Camera info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#CameraInfo.pos">CameraInfo.pos</a></td>
|
||||
<td class="summary">(<a href="../classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#CameraInfo.name">CameraInfo.name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#CameraInfo.room">CameraInfo.room</a></td>
|
||||
<td class="summary">(string) room number</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CameraInfo.pos"></a>
|
||||
<strong>CameraInfo.pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CameraInfo.name"></a>
|
||||
<strong>CameraInfo.name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "flyby_start" or "big_door_hint"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CameraInfo.room"></a>
|
||||
<strong>CameraInfo.room</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) room number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-16 12:53:44 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,518 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><strong>Level</strong></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>Level</code></h1>
|
||||
<p>A container for level metadata - things which aren't present in the compiled
|
||||
level file itself.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.nameKey">Level.nameKey</a></td>
|
||||
<td class="summary">(string) string key for the level's (localised) name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.scriptFile">Level.scriptFile</a></td>
|
||||
<td class="summary">(string) path of the Lua file holding the level's logic script, relative to the location of the tombengine executable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.levelFile">Level.levelFile</a></td>
|
||||
<td class="summary">(string) path of the compiled level file, relative to the location of the tombengine executable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.loadScreenFile">Level.loadScreenFile</a></td>
|
||||
<td class="summary">(string) path of the level's load screen file (.png or .jpg), relative to the location of the tombengine executable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.ambientTrack">Level.ambientTrack</a></td>
|
||||
<td class="summary">(string) initial ambient sound track to play - this is the filename of the track <strong>without</strong> the .wav extension</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.layer1">Level.layer1</a></td>
|
||||
<td class="summary">(<a href="../classes/SkyLayer.html#">SkyLayer</a>) Primary sky layer</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.layer2">Level.layer2</a></td>
|
||||
<td class="summary">(<a href="../classes/SkyLayer.html#">SkyLayer</a>) Secondary sky layer <strong>(not yet implemented)</strong></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.fog">Level.fog</a></td>
|
||||
<td class="summary">(<a href="../classes/Color.html#">Color</a>) distance fog RGB color (as seen in TR4's Desert Railroad).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.horizon">Level.horizon</a></td>
|
||||
<td class="summary">(bool) if set to true, the horizon and sky layer will be drawn; if set to false; they won't.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.colAddHorizon">Level.colAddHorizon</a></td>
|
||||
<td class="summary">(bool) if true, the horizon graphic will transition smoothly to the sky layer.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.storm">Level.storm</a></td>
|
||||
<td class="summary">(bool) equivalent to classic TRLE's LIGHTNING setting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.weather">Level.weather</a></td>
|
||||
<td class="summary">(WeatherType) Must be one of the values WeatherType.NORMAL, WeatherType.RAIN, or WeatherType.SNOW.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.laraType">Level.laraType</a></td>
|
||||
<td class="summary">(LaraType) Must be one of the LaraType values.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.rumble">Level.rumble</a></td>
|
||||
<td class="summary">(bool) If true, an occasional screen shake effect (as seen in TRC's Sinking Submarine) will
|
||||
happen throughout the level.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.mirror">Level.mirror</a></td>
|
||||
<td class="summary">(<a href="../classes/Mirror.html#">Mirror</a>) object holding the location and size of the room's mirror, if present.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.UVRotate">Level.UVRotate</a></td>
|
||||
<td class="summary">(byte) Default speed of "UVRotate" animated textures.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.farView">Level.farView</a></td>
|
||||
<td class="summary">(byte) The maximum draw distance, in sectors (blocks), of this particular level.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.unlimitedAir">Level.unlimitedAir</a></td>
|
||||
<td class="summary">(bool) If true, the player will have an unlimited oxygen supply when in water.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.objects">Level.objects</a></td>
|
||||
<td class="summary">(table of <a href="../classes/InventoryObject.html#">InventoryObject</a>s) table of inventory object overrides</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.new">Level.new ()</a></td>
|
||||
<td class="summary">Make a new Level object.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Level.nameKey"></a>
|
||||
<strong>Level.nameKey</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) string key for the level's (localised) name. Corresponds to an entry in strings.lua.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.scriptFile"></a>
|
||||
<strong>Level.scriptFile</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) path of the Lua file holding the level's logic script, relative to the location of the tombengine executable
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.levelFile"></a>
|
||||
<strong>Level.levelFile</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) path of the compiled level file, relative to the location of the tombengine executable
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.loadScreenFile"></a>
|
||||
<strong>Level.loadScreenFile</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) path of the level's load screen file (.png or .jpg), relative to the location of the tombengine executable
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.ambientTrack"></a>
|
||||
<strong>Level.ambientTrack</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) initial ambient sound track to play - this is the filename of the track <strong>without</strong> the .wav extension
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.layer1"></a>
|
||||
<strong>Level.layer1</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/SkyLayer.html#">SkyLayer</a>) Primary sky layer
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.layer2"></a>
|
||||
<strong>Level.layer2</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/SkyLayer.html#">SkyLayer</a>) Secondary sky layer <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.fog"></a>
|
||||
<strong>Level.fog</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Color.html#">Color</a>) distance fog RGB color (as seen in TR4's Desert Railroad).
|
||||
If not provided, distance fog will be black.</p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.horizon"></a>
|
||||
<strong>Level.horizon</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) if set to true, the horizon and sky layer will be drawn; if set to false; they won't.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.colAddHorizon"></a>
|
||||
<strong>Level.colAddHorizon</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) if true, the horizon graphic will transition smoothly to the sky layer.
|
||||
If set to false, there will be a black band between the two.</p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.storm"></a>
|
||||
<strong>Level.storm</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) equivalent to classic TRLE's LIGHTNING setting.
|
||||
If true, there will be a flickering lightning in the skylayer, as in the TRC Ireland levels.</p>
|
||||
|
||||
<p> <strong>(thunder sounds not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.weather"></a>
|
||||
<strong>Level.weather</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(WeatherType) Must be one of the values WeatherType.NORMAL, WeatherType.RAIN, or WeatherType.SNOW. </p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.laraType"></a>
|
||||
<strong>Level.laraType</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(LaraType) Must be one of the LaraType values.
|
||||
These are:</p>
|
||||
|
||||
<pre><code>NORMAL
|
||||
YOUNG
|
||||
BUNHEAD
|
||||
CATSUIT
|
||||
DIVESUIT
|
||||
INVISIBLE
|
||||
</code></pre>
|
||||
|
||||
<p>e.g. <code>myLevel.laraType = LaraType.DIVESUIT</code></p>
|
||||
|
||||
<p> <strong>(not yet fully implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.rumble"></a>
|
||||
<strong>Level.rumble</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) If true, an occasional screen shake effect (as seen in TRC's Sinking Submarine) will
|
||||
happen throughout the level.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.mirror"></a>
|
||||
<strong>Level.mirror</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Mirror.html#">Mirror</a>) object holding the location and size of the room's mirror, if present. </p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.UVRotate"></a>
|
||||
<strong>Level.UVRotate</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(byte) Default speed of "UVRotate" animated textures. </p>
|
||||
|
||||
<p>Must be in the range [-64, 64].</p>
|
||||
|
||||
<p>A level texture can be set in Tomb Editor to use "UVRotate" animation.
|
||||
This gives the effect of the texture looping downwards or upwards in place.
|
||||
Positive values will cause the texture to loop downwards, and negative values
|
||||
will cause an upwards loop. The higher a positive number or the lower a negative
|
||||
number, the faster the scroll will be.</p>
|
||||
|
||||
<p><strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.farView"></a>
|
||||
<strong>Level.farView</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(byte) The maximum draw distance, in sectors (blocks), of this particular level. </p>
|
||||
|
||||
<p>Must be in the range [1, 127], and equal to or less than the value passed to SetGameFarView.</p>
|
||||
|
||||
<p>This is equivalent to TRNG's LevelFarView variable.</p>
|
||||
|
||||
<p><strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.unlimitedAir"></a>
|
||||
<strong>Level.unlimitedAir</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) If true, the player will have an unlimited oxygen supply when in water. </p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Level.objects"></a>
|
||||
<strong>Level.objects</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(table of <a href="../classes/InventoryObject.html#">InventoryObject</a>s) table of inventory object overrides
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Level.new"></a>
|
||||
<strong>Level.new ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Make a new Level object.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
a Level object
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-20 01:47:29 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,207 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><strong>MeshInfo</strong></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>MeshInfo</code></h1>
|
||||
<p>Mesh info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#MeshInfo.pos">MeshInfo.pos</a></td>
|
||||
<td class="summary">(<a href="../classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#MeshInfo.yRot">MeshInfo.yRot</a></td>
|
||||
<td class="summary">(int) y-axis rotation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#MeshInfo.name">MeshInfo.name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#MeshInfo.staticNumber">MeshInfo.staticNumber</a></td>
|
||||
<td class="summary">(int) static number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#MeshInfo.color">MeshInfo.color</a></td>
|
||||
<td class="summary">(<a href="../classes/Color.html#">Color</a>) color of mesh</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#MeshInfo.HP">MeshInfo.HP</a></td>
|
||||
<td class="summary">(int) hp</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "MeshInfo.pos"></a>
|
||||
<strong>MeshInfo.pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MeshInfo.yRot"></a>
|
||||
<strong>MeshInfo.yRot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) y-axis rotation
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MeshInfo.name"></a>
|
||||
<strong>MeshInfo.name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "my_vase" or "oldrubble"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MeshInfo.staticNumber"></a>
|
||||
<strong>MeshInfo.staticNumber</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) static number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MeshInfo.color"></a>
|
||||
<strong>MeshInfo.color</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Color.html#">Color</a>) color of mesh
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "MeshInfo.HP"></a>
|
||||
<strong>MeshInfo.HP</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) hp
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-20 01:47:29 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><strong>Mirror</strong></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>Mirror</code></h1>
|
||||
<p>A mirror effect, as seen in TR4's Coastal Ruins and Sacred Lake levels.</p>
|
||||
<p><strong>Not currently implemented.</strong> </p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-16 12:53:44 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,173 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><strong>SinkInfo</strong></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>SinkInfo</code></h1>
|
||||
<p>Sink info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SinkInfo.pos">SinkInfo.pos</a></td>
|
||||
<td class="summary">(<a href="../classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SinkInfo.name">SinkInfo.name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SinkInfo.strength">SinkInfo.strength</a></td>
|
||||
<td class="summary">(int) strength.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SinkInfo.boxIndex">SinkInfo.boxIndex</a></td>
|
||||
<td class="summary">(int) box index.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SinkInfo.pos"></a>
|
||||
<strong>SinkInfo.pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SinkInfo.name"></a>
|
||||
<strong>SinkInfo.name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "strong_river_current" or "propeller_death_sink"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SinkInfo.strength"></a>
|
||||
<strong>SinkInfo.strength</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) strength.
|
||||
Strength of the sink, with higher numbers providing stronger currents. Will be clamped to [1, 32].
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SinkInfo.boxIndex"></a>
|
||||
<strong>SinkInfo.boxIndex</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) box index.
|
||||
I don't know what this does and it's not actually in the engine yet
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-20 01:50:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,171 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><strong>SoundSourceInfo</strong></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>SoundSourceInfo</code></h1>
|
||||
<p>Sound source info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SoundSourceInfo.pos">SoundSourceInfo.pos</a></td>
|
||||
<td class="summary">(<a href="../classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SoundSourceInfo.name">SoundSourceInfo.name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SoundSourceInfo.soundID">SoundSourceInfo.soundID</a></td>
|
||||
<td class="summary">(int) sound ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SoundSourceInfo.flags">SoundSourceInfo.flags</a></td>
|
||||
<td class="summary">(int) flags</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SoundSourceInfo.pos"></a>
|
||||
<strong>SoundSourceInfo.pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SoundSourceInfo.name"></a>
|
||||
<strong>SoundSourceInfo.name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "machine_sound_1" or "discordant_humming"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SoundSourceInfo.soundID"></a>
|
||||
<strong>SoundSourceInfo.soundID</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) sound ID
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SoundSourceInfo.flags"></a>
|
||||
<strong>SoundSourceInfo.flags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) flags
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-20 01:50:15 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
252
doc/entity classes/AIObject.html
Normal file
252
doc/entity classes/AIObject.html
Normal file
|
|
@ -0,0 +1,252 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>AIObject</strong></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>AIObject</code></h1>
|
||||
<p>AI object</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#pos">pos</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#yRot">yRot</a></td>
|
||||
<td class="summary">(int) y-axis rotation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#name">name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#room">room</a></td>
|
||||
<td class="summary">(int) room number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#objID">objID</a></td>
|
||||
<td class="summary">(<a href="../enums/ObjID.html#">ObjID</a>) object ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#flags">flags</a></td>
|
||||
<td class="summary">(short) flags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#triggerFlags">triggerFlags</a></td>
|
||||
<td class="summary">(short) trigger flags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#boxNumber">boxNumber</a></td>
|
||||
<td class="summary">(short) box number</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "pos"></a>
|
||||
<strong>pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "yRot"></a>
|
||||
<strong>yRot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) y-axis rotation
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "name"></a>
|
||||
<strong>name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "door<em>back</em>room" or "cracked<em>greek</em>statue"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "room"></a>
|
||||
<strong>room</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) room number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "objID"></a>
|
||||
<strong>objID</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../enums/ObjID.html#">ObjID</a>) object ID
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "flags"></a>
|
||||
<strong>flags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(short) flags
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "triggerFlags"></a>
|
||||
<strong>triggerFlags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(short) trigger flags
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "boxNumber"></a>
|
||||
<strong>boxNumber</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(short) box number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
162
doc/entity classes/CameraInfo.html
Normal file
162
doc/entity classes/CameraInfo.html
Normal file
|
|
@ -0,0 +1,162 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><strong>CameraInfo</strong></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>CameraInfo</code></h1>
|
||||
<p>Camera info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#pos">pos</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#name">name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#room">room</a></td>
|
||||
<td class="summary">(string) room number</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "pos"></a>
|
||||
<strong>pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "name"></a>
|
||||
<strong>name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "flyby_start" or "big_door_hint"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "room"></a>
|
||||
<strong>room</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) room number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -37,30 +37,39 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Entity 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>
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><strong>ItemInfo</strong></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -76,114 +85,114 @@ pickups, and Lara herself.</p>
|
|||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.objectID">ItemInfo.objectID</a></td>
|
||||
<td class="summary">(<a href="../classes/ObjID.html#">ObjID</a>) object ID</td>
|
||||
<td class="name" ><a href="#objectID">objectID</a></td>
|
||||
<td class="summary">(<a href="../enums/ObjID.html#">ObjID</a>) object ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.currentAnimState">ItemInfo.currentAnimState</a></td>
|
||||
<td class="name" ><a href="#currentAnimState">currentAnimState</a></td>
|
||||
<td class="summary">(int) current animation state</p>
|
||||
|
||||
<p>The state number of the animation the object is currently doing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.requiredAnimState">ItemInfo.requiredAnimState</a></td>
|
||||
<td class="name" ><a href="#requiredAnimState">requiredAnimState</a></td>
|
||||
<td class="summary">(int) State of required animation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.goalAnimState">ItemInfo.goalAnimState</a></td>
|
||||
<td class="name" ><a href="#goalAnimState">goalAnimState</a></td>
|
||||
<td class="summary">(int) State of goal animation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.animNumber">ItemInfo.animNumber</a></td>
|
||||
<td class="name" ><a href="#animNumber">animNumber</a></td>
|
||||
<td class="summary">(int) animation number</p>
|
||||
|
||||
<p>The index of the animation the object is currently doing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.frameNumber">ItemInfo.frameNumber</a></td>
|
||||
<td class="name" ><a href="#frameNumber">frameNumber</a></td>
|
||||
<td class="summary">(int) frame number</p>
|
||||
|
||||
<p>Current fame of the animation the object is currently doing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.HP">ItemInfo.HP</a></td>
|
||||
<td class="name" ><a href="#HP">HP</a></td>
|
||||
<td class="summary">(int) HP (hit points/health points) of object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.OCB">ItemInfo.OCB</a></td>
|
||||
<td class="name" ><a href="#OCB">OCB</a></td>
|
||||
<td class="summary">(int) OCB (object code bit) of object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.itemFlags">ItemInfo.itemFlags</a></td>
|
||||
<td class="name" ><a href="#itemFlags">itemFlags</a></td>
|
||||
<td class="summary">(table) item flags of object (table of 8 ints)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.AIBits">ItemInfo.AIBits</a></td>
|
||||
<td class="name" ><a href="#AIBits">AIBits</a></td>
|
||||
<td class="summary">(int) AIBits of object.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.status">ItemInfo.status</a></td>
|
||||
<td class="name" ><a href="#status">status</a></td>
|
||||
<td class="summary">(int) status of object.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.hitStatus">ItemInfo.hitStatus</a></td>
|
||||
<td class="name" ><a href="#hitStatus">hitStatus</a></td>
|
||||
<td class="summary">(bool) hit status of object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.active">ItemInfo.active</a></td>
|
||||
<td class="name" ><a href="#active">active</a></td>
|
||||
<td class="summary">(bool) whether or not the object is active</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.room">ItemInfo.room</a></td>
|
||||
<td class="name" ><a href="#room">room</a></td>
|
||||
<td class="summary">(int) room the item is in</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.pos">ItemInfo.pos</a></td>
|
||||
<td class="summary">(<a href="../classes/Position.html#">Position</a>) position in level</td>
|
||||
<td class="name" ><a href="#pos">pos</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.rot">ItemInfo.rot</a></td>
|
||||
<td class="summary">(<a href="../classes/Rotation.html#">Rotation</a>) rotation represented as degree angles about X, Y, and Z axes</td>
|
||||
<td class="name" ><a href="#rot">rot</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Rotation.html#">Rotation</a>) rotation represented as degree angles about X, Y, and Z axes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.name">ItemInfo.name</a></td>
|
||||
<td class="name" ><a href="#name">name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.new">ItemInfo.new ()</a></td>
|
||||
<td class="name" ><a href="#ItemInfo.new">ItemInfo.new()</a></td>
|
||||
<td class="summary">If you create items with this you NEED to give a position, room,
|
||||
and object number, and then call InitialiseItem before it will work.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.newTemporary">ItemInfo.newTemporary ()</a></td>
|
||||
<td class="name" ><a href="#ItemInfo.newTemporary">ItemInfo.newTemporary()</a></td>
|
||||
<td class="summary">Like above, but the returned variable controls the
|
||||
lifetime of the object (it will be destroyed when the variable goes
|
||||
out of scope).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.new">ItemInfo.new (object, name, position, rotation, room, currentAnimState, requiredAnimState, goalAnimState, animNumber, frameNumber, hp, OCB, itemFlags, AIBits, status, active, hitStatus)</a></td>
|
||||
<td class="name" ><a href="#ItemInfo.new">ItemInfo.new(object, name, position, rotation, room, currentAnimState, requiredAnimState, goalAnimState, animNumber, frameNumber, hp, OCB, itemFlags, AIBits, status, active, hitStatus)</a></td>
|
||||
<td class="summary">For more information on each parameter, see the
|
||||
associated getters and setters.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.newTemporary">ItemInfo.newTemporary (see_above)</a></td>
|
||||
<td class="name" ><a href="#ItemInfo.newTemporary">ItemInfo.newTemporary(see_above)</a></td>
|
||||
<td class="summary">Like the above, but the returned variable controls the
|
||||
lifetime of the object (it will be destroyed when the variable goes
|
||||
out of scope).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo.Init">ItemInfo.Init ()</a></td>
|
||||
<td class="name" ><a href="#ItemInfo.Init">ItemInfo.Init()</a></td>
|
||||
<td class="summary">Initialise an item.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo:EnableItem">ItemInfo:EnableItem ()</a></td>
|
||||
<td class="name" ><a href="#ItemInfo:EnableItem">ItemInfo:EnableItem()</a></td>
|
||||
<td class="summary">Enable the item</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ItemInfo:DisableItem">ItemInfo:DisableItem ()</a></td>
|
||||
<td class="name" ><a href="#ItemInfo:DisableItem">ItemInfo:DisableItem()</a></td>
|
||||
<td class="summary">Disable the item</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -196,11 +205,11 @@ out of scope).</td>
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "ItemInfo.objectID"></a>
|
||||
<strong>ItemInfo.objectID</strong>
|
||||
<a name = "objectID"></a>
|
||||
<strong>objectID</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/ObjID.html#">ObjID</a>) object ID
|
||||
(<a href="../enums/ObjID.html#">ObjID</a>) object ID
|
||||
|
||||
|
||||
|
||||
|
|
@ -210,8 +219,8 @@ out of scope).</td>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.currentAnimState"></a>
|
||||
<strong>ItemInfo.currentAnimState</strong>
|
||||
<a name = "currentAnimState"></a>
|
||||
<strong>currentAnimState</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) current animation state</p>
|
||||
|
|
@ -227,8 +236,8 @@ This corresponds to "state" number shown in the animation editor of WadTool.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.requiredAnimState"></a>
|
||||
<strong>ItemInfo.requiredAnimState</strong>
|
||||
<a name = "requiredAnimState"></a>
|
||||
<strong>requiredAnimState</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) State of required animation
|
||||
|
|
@ -241,8 +250,8 @@ This corresponds to "state" number shown in the animation editor of WadTool.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.goalAnimState"></a>
|
||||
<strong>ItemInfo.goalAnimState</strong>
|
||||
<a name = "goalAnimState"></a>
|
||||
<strong>goalAnimState</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) State of goal animation
|
||||
|
|
@ -255,8 +264,8 @@ This corresponds to "state" number shown in the animation editor of WadTool.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.animNumber"></a>
|
||||
<strong>ItemInfo.animNumber</strong>
|
||||
<a name = "animNumber"></a>
|
||||
<strong>animNumber</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) animation number</p>
|
||||
|
|
@ -272,8 +281,8 @@ This corresponds to the number shown in the item's animation list in WadTool.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.frameNumber"></a>
|
||||
<strong>ItemInfo.frameNumber</strong>
|
||||
<a name = "frameNumber"></a>
|
||||
<strong>frameNumber</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) frame number</p>
|
||||
|
|
@ -290,8 +299,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.HP"></a>
|
||||
<strong>ItemInfo.HP</strong>
|
||||
<a name = "HP"></a>
|
||||
<strong>HP</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) HP (hit points/health points) of object
|
||||
|
|
@ -304,8 +313,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.OCB"></a>
|
||||
<strong>ItemInfo.OCB</strong>
|
||||
<a name = "OCB"></a>
|
||||
<strong>OCB</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) OCB (object code bit) of object
|
||||
|
|
@ -318,8 +327,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.itemFlags"></a>
|
||||
<strong>ItemInfo.itemFlags</strong>
|
||||
<a name = "itemFlags"></a>
|
||||
<strong>itemFlags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(table) item flags of object (table of 8 ints)
|
||||
|
|
@ -332,8 +341,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.AIBits"></a>
|
||||
<strong>ItemInfo.AIBits</strong>
|
||||
<a name = "AIBits"></a>
|
||||
<strong>AIBits</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) AIBits of object. Will be clamped to [0, 255]
|
||||
|
|
@ -346,8 +355,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.status"></a>
|
||||
<strong>ItemInfo.status</strong>
|
||||
<a name = "status"></a>
|
||||
<strong>status</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) status of object.
|
||||
|
|
@ -365,8 +374,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.hitStatus"></a>
|
||||
<strong>ItemInfo.hitStatus</strong>
|
||||
<a name = "hitStatus"></a>
|
||||
<strong>hitStatus</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) hit status of object
|
||||
|
|
@ -379,8 +388,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.active"></a>
|
||||
<strong>ItemInfo.active</strong>
|
||||
<a name = "active"></a>
|
||||
<strong>active</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) whether or not the object is active
|
||||
|
|
@ -393,8 +402,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.room"></a>
|
||||
<strong>ItemInfo.room</strong>
|
||||
<a name = "room"></a>
|
||||
<strong>room</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) room the item is in
|
||||
|
|
@ -407,11 +416,11 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.pos"></a>
|
||||
<strong>ItemInfo.pos</strong>
|
||||
<a name = "pos"></a>
|
||||
<strong>pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Position.html#">Position</a>) position in level
|
||||
(<a href="../misc classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
|
@ -421,11 +430,11 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.rot"></a>
|
||||
<strong>ItemInfo.rot</strong>
|
||||
<a name = "rot"></a>
|
||||
<strong>rot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Rotation.html#">Rotation</a>) rotation represented as degree angles about X, Y, and Z axes
|
||||
(<a href="../misc classes/Rotation.html#">Rotation</a>) rotation represented as degree angles about X, Y, and Z axes
|
||||
|
||||
|
||||
|
||||
|
|
@ -435,8 +444,8 @@ the WadTool animation editor.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.name"></a>
|
||||
<strong>ItemInfo.name</strong>
|
||||
<a name = "name"></a>
|
||||
<strong>name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
|
|
@ -451,11 +460,11 @@ the WadTool animation editor.
|
|||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "ItemInfo.new"></a>
|
||||
<strong>ItemInfo.new ()</strong>
|
||||
<strong>ItemInfo.new()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
If you create items with this you NEED to give a position, room,
|
||||
|
|
@ -470,7 +479,7 @@ and object number, and then call InitialiseItem before it will work.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.newTemporary"></a>
|
||||
<strong>ItemInfo.newTemporary ()</strong>
|
||||
<strong>ItemInfo.newTemporary()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Like above, but the returned variable controls the
|
||||
|
|
@ -486,7 +495,7 @@ out of scope).
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.new"></a>
|
||||
<strong>ItemInfo.new (object, name, position, rotation, room, currentAnimState, requiredAnimState, goalAnimState, animNumber, frameNumber, hp, OCB, itemFlags, AIBits, status, active, hitStatus)</strong>
|
||||
<strong>ItemInfo.new(object, name, position, rotation, room, currentAnimState, requiredAnimState, goalAnimState, animNumber, frameNumber, hp, OCB, itemFlags, AIBits, status, active, hitStatus)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
For more information on each parameter, see the
|
||||
|
|
@ -498,7 +507,7 @@ takes no arguments.
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">object</span>
|
||||
<span class="types"><a class="type" href="../classes/ObjID.html#">ObjID</a></span>
|
||||
<span class="types"><span class="type">ObjID</span></span>
|
||||
ID
|
||||
</li>
|
||||
<li><span class="parameter">name</span>
|
||||
|
|
@ -506,11 +515,11 @@ takes no arguments.
|
|||
Lua name of the item
|
||||
</li>
|
||||
<li><span class="parameter">position</span>
|
||||
<span class="types"><a class="type" href="../classes/Position.html#">Position</a></span>
|
||||
<span class="types"><span class="type">Position</span></span>
|
||||
position in level
|
||||
</li>
|
||||
<li><span class="parameter">rotation</span>
|
||||
<span class="types"><a class="type" href="../classes/Rotation.html#">Rotation</a></span>
|
||||
<span class="types"><span class="type">Rotation</span></span>
|
||||
rotation about x, y, and z axes
|
||||
</li>
|
||||
<li><span class="parameter">room</span>
|
||||
|
|
@ -601,7 +610,7 @@ takes no arguments.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.newTemporary"></a>
|
||||
<strong>ItemInfo.newTemporary (see_above)</strong>
|
||||
<strong>ItemInfo.newTemporary(see_above)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Like the above, but the returned variable controls the
|
||||
|
|
@ -623,7 +632,7 @@ out of scope).
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo.Init"></a>
|
||||
<strong>ItemInfo.Init ()</strong>
|
||||
<strong>ItemInfo.Init()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Initialise an item.
|
||||
|
|
@ -638,7 +647,7 @@ Use this if you called new with no arguments
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo:EnableItem"></a>
|
||||
<strong>ItemInfo:EnableItem ()</strong>
|
||||
<strong>ItemInfo:EnableItem()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Enable the item
|
||||
|
|
@ -652,7 +661,7 @@ Use this if you called new with no arguments
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "ItemInfo:DisableItem"></a>
|
||||
<strong>ItemInfo:DisableItem ()</strong>
|
||||
<strong>ItemInfo:DisableItem()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Disable the item
|
||||
|
|
@ -671,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-21 00:32:39 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
216
doc/entity classes/MeshInfo.html
Normal file
216
doc/entity classes/MeshInfo.html
Normal file
|
|
@ -0,0 +1,216 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><strong>MeshInfo</strong></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>MeshInfo</code></h1>
|
||||
<p>Mesh info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#pos">pos</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#yRot">yRot</a></td>
|
||||
<td class="summary">(int) y-axis rotation</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#name">name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#staticNumber">staticNumber</a></td>
|
||||
<td class="summary">(int) static number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#color">color</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Color.html#">Color</a>) color of mesh</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#HP">HP</a></td>
|
||||
<td class="summary">(int) hp</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "pos"></a>
|
||||
<strong>pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "yRot"></a>
|
||||
<strong>yRot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) y-axis rotation
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "name"></a>
|
||||
<strong>name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "my_vase" or "oldrubble"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "staticNumber"></a>
|
||||
<strong>staticNumber</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) static number
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "color"></a>
|
||||
<strong>color</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Color.html#">Color</a>) color of mesh
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "HP"></a>
|
||||
<strong>HP</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) hp
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
182
doc/entity classes/SinkInfo.html
Normal file
182
doc/entity classes/SinkInfo.html
Normal file
|
|
@ -0,0 +1,182 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><strong>SinkInfo</strong></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>SinkInfo</code></h1>
|
||||
<p>Sink info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#pos">pos</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#name">name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#strength">strength</a></td>
|
||||
<td class="summary">(int) strength.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#boxIndex">boxIndex</a></td>
|
||||
<td class="summary">(int) box index.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "pos"></a>
|
||||
<strong>pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "name"></a>
|
||||
<strong>name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "strong_river_current" or "propeller_death_sink"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "strength"></a>
|
||||
<strong>strength</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) strength.
|
||||
Strength of the sink, with higher numbers providing stronger currents. Will be clamped to [1, 32].
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "boxIndex"></a>
|
||||
<strong>boxIndex</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) box index.
|
||||
I don't know what this does and it's not actually in the engine yet
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
180
doc/entity classes/SoundSourceInfo.html
Normal file
180
doc/entity classes/SoundSourceInfo.html
Normal file
|
|
@ -0,0 +1,180 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><strong>SoundSourceInfo</strong></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>SoundSourceInfo</code></h1>
|
||||
<p>Sound source info</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#pos">pos</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Position.html#">Position</a>) position in level</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#name">name</a></td>
|
||||
<td class="summary">(string) unique string identifier.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#soundID">soundID</a></td>
|
||||
<td class="summary">(int) sound ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#flags">flags</a></td>
|
||||
<td class="summary">(int) flags</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "pos"></a>
|
||||
<strong>pos</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Position.html#">Position</a>) position in level
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "name"></a>
|
||||
<strong>name</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) unique string identifier.
|
||||
e.g. "machine_sound_1" or "discordant_humming"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "soundID"></a>
|
||||
<strong>soundID</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) sound ID
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "flags"></a>
|
||||
<strong>flags</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) flags
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -36,37 +36,46 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Enums</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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><strong>InvItem</strong></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>InvItem</code></h1>
|
||||
<h1>Enum <code>InvItem</code></h1>
|
||||
<p>Constants for items that can be used with GetInvItem and SetInvItem.</p>
|
||||
<p>
|
||||
|
||||
|
|
@ -76,7 +85,7 @@
|
|||
<h2><a href="#InvItem_constants">InvItem constants </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#InvItem.CONSTANT_STRING_HERE">InvItem.CONSTANT_STRING_HERE</a></td>
|
||||
<td class="name" ><a href="#CONSTANT_STRING_HERE">CONSTANT_STRING_HERE</a></td>
|
||||
<td class="summary">Table of constants to use with GetInvItem and SetInvItem.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -318,8 +327,8 @@ EXAMINE_ITEM8_COMBO2
|
|||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "InvItem.CONSTANT_STRING_HERE"></a>
|
||||
<strong>InvItem.CONSTANT_STRING_HERE</strong>
|
||||
<a name = "CONSTANT_STRING_HERE"></a>
|
||||
<strong>CONSTANT_STRING_HERE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Table of constants to use with GetInvItem and SetInvItem.
|
||||
|
|
@ -338,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
@ -36,37 +36,46 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Enums</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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><strong>ObjID</strong></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>ObjID</code></h1>
|
||||
<h1>Enum <code>ObjID</code></h1>
|
||||
<p>Constants for object IDs.</p>
|
||||
<p>
|
||||
|
||||
|
|
@ -76,7 +85,7 @@
|
|||
<h2><a href="#ObjID_constants">ObjID constants </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#ObjID.CONSTANT_STRING_HERE">ObjID.CONSTANT_STRING_HERE</a></td>
|
||||
<td class="name" ><a href="#CONSTANT_STRING_HERE">CONSTANT_STRING_HERE</a></td>
|
||||
<td class="summary">Table of constants.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -1056,8 +1065,8 @@ PANEL_MIDDLE_CORNER
|
|||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "ObjID.CONSTANT_STRING_HERE"></a>
|
||||
<strong>ObjID.CONSTANT_STRING_HERE</strong>
|
||||
<a name = "CONSTANT_STRING_HERE"></a>
|
||||
<strong>CONSTANT_STRING_HERE</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Table of constants.
|
||||
|
|
@ -1076,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
198
doc/index.html
198
doc/index.html
|
|
@ -29,30 +29,39 @@
|
|||
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<h2>Enums</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>
|
||||
<li><a href="classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="classes/Level.html">Level</a></li>
|
||||
<li><a href="classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="classes/Position.html">Position</a></li>
|
||||
<li><a href="classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="classes/Settings.html">Settings</a></li>
|
||||
<li><a href="classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="misc classes/Color.html">Color</a></li>
|
||||
<li><a href="misc classes/Position.html">Position</a></li>
|
||||
<li><a href="misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -61,96 +70,103 @@
|
|||
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="modules/gameflow.html">gameflow</a></td>
|
||||
<td class="summary">Files that will be run on game startup.</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="modules/gamelogic.html">gamelogic</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>
|
||||
<h2>Classes</h2>
|
||||
<h2>Enums</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/Color.html">Color</a></td>
|
||||
<td class="summary">An RGBA or RGB color.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="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="classes/ItemInfo.html">ItemInfo</a></td>
|
||||
<td class="summary">Represents any object inside the game world.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/Level.html">Level</a></td>
|
||||
<td class="summary">A container for level metadata - things which aren't present in the compiled
|
||||
level file itself.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/MeshInfo.html">MeshInfo</a></td>
|
||||
<td class="summary">Mesh info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/Mirror.html">Mirror</a></td>
|
||||
<td class="summary">A mirror effect, as seen in TR4's Coastal Ruins and Sacred Lake levels.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/Position.html">Position</a></td>
|
||||
<td class="summary">Represents a position in the game world.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/Rotation.html">Rotation</a></td>
|
||||
<td class="summary">Represents a rotation as a combination of individual
|
||||
angles, in degrees, about each axis.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="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="classes/SinkInfo.html">SinkInfo</a></td>
|
||||
<td class="summary">Sink info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/SkyLayer.html">SkyLayer</a></td>
|
||||
<td class="summary">Description class for moving clouds, as seen in TR4's City of the Dead.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/SoundSourceInfo.html">SoundSourceInfo</a></td>
|
||||
<td class="summary">Sound source info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/InvItem.html">InvItem</a></td>
|
||||
<td class="name" ><a href="enums/InvItem.html">InvItem</a></td>
|
||||
<td class="summary">Constants for items that can be used with GetInvItem and SetInvItem.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="classes/ObjID.html">ObjID</a></td>
|
||||
<td class="name" ><a href="enums/ObjID.html">ObjID</a></td>
|
||||
<td class="summary">Constants for object IDs.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Entity classes</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<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="summary">Camera info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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="summary">Mesh info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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="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="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="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="summary">Stores level metadata.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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="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="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="summary">An RGBA or RGB color.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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="summary">Represents a rotation.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -34,34 +34,42 @@
|
|||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Metamethods">Metamethods</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Misc 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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -76,41 +84,38 @@
|
|||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color.r">Color.r</a></td>
|
||||
<td class="name" ><a href="#r">r</a></td>
|
||||
<td class="summary">(int) red component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color.g">Color.g</a></td>
|
||||
<td class="name" ><a href="#g">g</a></td>
|
||||
<td class="summary">(int) green component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color.b">Color.b</a></td>
|
||||
<td class="name" ><a href="#b">b</a></td>
|
||||
<td class="summary">(int) blue component</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color.a">Color.a</a></td>
|
||||
<td class="name" ><a href="#a">a</a></td>
|
||||
<td class="summary">(int) alpha component (255 is opaque, 0 is invisible)</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color.new">Color.new (R, G, B)</a></td>
|
||||
<td class="name" ><a href="#Color.new">Color.new(R, G, B)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color.new">Color.new (R, G, B, A)</a></td>
|
||||
<td class="name" ><a href="#Color.new">Color.new(R, G, B, A)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Metamethods">Metamethods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Color:__tostring">Color:__tostring (color)</a></td>
|
||||
<td class="name" ><a href="#__tostring">__tostring(color)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
|
|
@ -125,8 +130,8 @@
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Color.r"></a>
|
||||
<strong>Color.r</strong>
|
||||
<a name = "r"></a>
|
||||
<strong>r</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) red component
|
||||
|
|
@ -139,8 +144,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.g"></a>
|
||||
<strong>Color.g</strong>
|
||||
<a name = "g"></a>
|
||||
<strong>g</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) green component
|
||||
|
|
@ -153,8 +158,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.b"></a>
|
||||
<strong>Color.b</strong>
|
||||
<a name = "b"></a>
|
||||
<strong>b</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) blue component
|
||||
|
|
@ -167,8 +172,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.a"></a>
|
||||
<strong>Color.a</strong>
|
||||
<a name = "a"></a>
|
||||
<strong>a</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) alpha component (255 is opaque, 0 is invisible)
|
||||
|
|
@ -182,11 +187,11 @@
|
|||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Color.new"></a>
|
||||
<strong>Color.new (R, G, B)</strong>
|
||||
<strong>Color.new(R, G, B)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -222,7 +227,7 @@
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.new"></a>
|
||||
<strong>Color.new (R, G, B, A)</strong>
|
||||
<strong>Color.new(R, G, B, A)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -260,13 +265,9 @@
|
|||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Color:__tostring"></a>
|
||||
<strong>Color:__tostring (color)</strong>
|
||||
<a name = "__tostring"></a>
|
||||
<strong>__tostring(color)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -277,7 +278,7 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="../classes/Color.html#">Color</a></span>
|
||||
<span class="types"><span class="type">Color</span></span>
|
||||
this color
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -300,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
@ -34,34 +34,42 @@
|
|||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Metamethods">Metamethods</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Misc 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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><strong>Position</strong></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -78,31 +86,28 @@
|
|||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Position.x">Position.x</a></td>
|
||||
<td class="name" ><a href="#x">x</a></td>
|
||||
<td class="summary">(int) x coordinate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Position.y">Position.y</a></td>
|
||||
<td class="name" ><a href="#y">y</a></td>
|
||||
<td class="summary">(int) y coordinate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Position.z">Position.z</a></td>
|
||||
<td class="name" ><a href="#z">z</a></td>
|
||||
<td class="summary">(int) z coordinate</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Position.new">Position.new (X, Y, Z)</a></td>
|
||||
<td class="name" ><a href="#Position.new">Position.new(X, Y, Z)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Metamethods">Metamethods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Position:__tostring">Position:__tostring (position)</a></td>
|
||||
<td class="name" ><a href="#__tostring">__tostring(position)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
|
|
@ -117,8 +122,8 @@
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Position.x"></a>
|
||||
<strong>Position.x</strong>
|
||||
<a name = "x"></a>
|
||||
<strong>x</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) x coordinate
|
||||
|
|
@ -131,8 +136,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Position.y"></a>
|
||||
<strong>Position.y</strong>
|
||||
<a name = "y"></a>
|
||||
<strong>y</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) y coordinate
|
||||
|
|
@ -145,8 +150,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Position.z"></a>
|
||||
<strong>Position.z</strong>
|
||||
<a name = "z"></a>
|
||||
<strong>z</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) z coordinate
|
||||
|
|
@ -160,11 +165,11 @@
|
|||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Position.new"></a>
|
||||
<strong>Position.new (X, Y, Z)</strong>
|
||||
<strong>Position.new(X, Y, Z)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -198,13 +203,9 @@
|
|||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Position:__tostring"></a>
|
||||
<strong>Position:__tostring (position)</strong>
|
||||
<a name = "__tostring"></a>
|
||||
<strong>__tostring(position)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -215,7 +216,7 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">position</span>
|
||||
<span class="types"><a class="type" href="../classes/Position.html#">Position</a></span>
|
||||
<span class="types"><span class="type">Position</span></span>
|
||||
this position
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -238,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
@ -34,34 +34,42 @@
|
|||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Metamethods">Metamethods</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Misc 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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><strong>Rotation</strong></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -69,39 +77,37 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Class <code>Rotation</code></h1>
|
||||
<p>Represents a rotation as a combination of individual
|
||||
angles, in degrees, about each axis.</p>
|
||||
<p>All values will be clamped to [-32768, 32767].</p>
|
||||
<p>Represents a rotation.</p>
|
||||
<p>Rotations are specifed as a combination of individual
|
||||
angles, in degrees, about each axis.
|
||||
All values will be clamped to [-32768, 32767].</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Rotation.x">Rotation.x</a></td>
|
||||
<td class="name" ><a href="#x">x</a></td>
|
||||
<td class="summary">(int) rotation about x axis</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Rotation.y">Rotation.y</a></td>
|
||||
<td class="name" ><a href="#y">y</a></td>
|
||||
<td class="summary">(int) rotation about x axis</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#Rotation.z">Rotation.z</a></td>
|
||||
<td class="name" ><a href="#z">z</a></td>
|
||||
<td class="summary">(int) rotation about x axis</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Rotation.new">Rotation.new (X, Y, Z)</a></td>
|
||||
<td class="name" ><a href="#Rotation.new">Rotation.new(X, Y, Z)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Metamethods">Metamethods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Rotation:__tostring">Rotation:__tostring (rotation)</a></td>
|
||||
<td class="name" ><a href="#__tostring">__tostring(rotation)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
|
|
@ -116,8 +122,8 @@ angles, in degrees, about each axis.</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Rotation.x"></a>
|
||||
<strong>Rotation.x</strong>
|
||||
<a name = "x"></a>
|
||||
<strong>x</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) rotation about x axis
|
||||
|
|
@ -130,8 +136,8 @@ angles, in degrees, about each axis.</p>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Rotation.y"></a>
|
||||
<strong>Rotation.y</strong>
|
||||
<a name = "y"></a>
|
||||
<strong>y</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) rotation about x axis
|
||||
|
|
@ -144,8 +150,8 @@ angles, in degrees, about each axis.</p>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Rotation.z"></a>
|
||||
<strong>Rotation.z</strong>
|
||||
<a name = "z"></a>
|
||||
<strong>z</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) rotation about x axis
|
||||
|
|
@ -159,11 +165,11 @@ angles, in degrees, about each axis.</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Rotation.new"></a>
|
||||
<strong>Rotation.new (X, Y, Z)</strong>
|
||||
<strong>Rotation.new(X, Y, Z)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -197,13 +203,9 @@ angles, in degrees, about each axis.</p>
|
|||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Rotation:__tostring"></a>
|
||||
<strong>Rotation:__tostring (rotation)</strong>
|
||||
<a name = "__tostring"></a>
|
||||
<strong>__tostring(rotation)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -214,7 +216,7 @@ angles, in degrees, about each axis.</p>
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">rotation</span>
|
||||
<span class="types"><a class="type" href="../classes/Rotation.html#">Rotation</a></span>
|
||||
<span class="types"><span class="type">Rotation</span></span>
|
||||
this rotation
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -237,7 +239,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
94
doc/pre-game script classes/AudioTrack.html
Normal file
94
doc/pre-game script classes/AudioTrack.html
Normal file
|
|
@ -0,0 +1,94 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>AudioTrack</strong></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>AudioTrack</code></h1>
|
||||
<p>Metadata about audio tracks (music and ambience).</p>
|
||||
<p><strong>In progress</strong> </p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -37,30 +37,39 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Pre-game script 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="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><strong>InventoryObject</strong></li>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -77,46 +86,46 @@
|
|||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.nameKey">InventoryObject.nameKey</a></td>
|
||||
<td class="name" ><a href="#nameKey">nameKey</a></td>
|
||||
<td class="summary">(string) string key for the item's (localised) name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.slot">InventoryObject.slot</a></td>
|
||||
<td class="summary">(<a href="../classes/InvItem.html#">InvItem</a>) slot of item whose inventory display properties you wish to change</td>
|
||||
<td class="name" ><a href="#slot">slot</a></td>
|
||||
<td class="summary">(<a href="../enums/InvItem.html#">InvItem</a>) slot of item whose inventory display properties you wish to change</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.yOffset">InventoryObject.yOffset</a></td>
|
||||
<td class="name" ><a href="#yOffset">yOffset</a></td>
|
||||
<td class="summary">(float) y-axis offset (positive values will move the item lower).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.scale">InventoryObject.scale</a></td>
|
||||
<td class="name" ><a href="#scale">scale</a></td>
|
||||
<td class="summary">(float) Item's size when displayed in the inventory as a multiple of its "regular" size.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.rot">InventoryObject.rot</a></td>
|
||||
<td class="summary">(<a href="../classes/Rotation.html#">Rotation</a>) Item's rotation about its origin when displayed in the inventory.</td>
|
||||
<td class="name" ><a href="#rot">rot</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Rotation.html#">Rotation</a>) Item's rotation about its origin when displayed in the inventory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.rotAxisWhenCurrent">InventoryObject.rotAxisWhenCurrent</a></td>
|
||||
<td class="name" ><a href="#rotAxisWhenCurrent">rotAxisWhenCurrent</a></td>
|
||||
<td class="summary">(RotationAxis) Axis to rotate about when the item is being looked at in the inventory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.meshBits">InventoryObject.meshBits</a></td>
|
||||
<td class="name" ><a href="#meshBits">meshBits</a></td>
|
||||
<td class="summary">(int) <strong>Not currently implemented</strong> (will have no effect regardless of what you set it to)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.action">InventoryObject.action</a></td>
|
||||
<td class="name" ><a href="#action">action</a></td>
|
||||
<td class="summary">(ItemAction) What can the player do with the item?</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.new">InventoryObject.new ()</a></td>
|
||||
<td class="name" ><a href="#InventoryObject.new">InventoryObject.new()</a></td>
|
||||
<td class="summary">Create an inventoryObject item.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#InventoryObject.new">InventoryObject.new (nameKey, slot, yOffset, scale, rot, rotAxisWhenCurrent, meshBits, action)</a></td>
|
||||
<td class="name" ><a href="#InventoryObject.new">InventoryObject.new(nameKey, slot, yOffset, scale, rot, rotAxisWhenCurrent, meshBits, action)</a></td>
|
||||
<td class="summary">For more information on each parameter, see the
|
||||
associated getters and setters.</td>
|
||||
</tr>
|
||||
|
|
@ -130,8 +139,8 @@ associated getters and setters.</td>
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "InventoryObject.nameKey"></a>
|
||||
<strong>InventoryObject.nameKey</strong>
|
||||
<a name = "nameKey"></a>
|
||||
<strong>nameKey</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) string key for the item's (localised) name. Corresponds to an entry in strings.lua.
|
||||
|
|
@ -144,11 +153,11 @@ associated getters and setters.</td>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.slot"></a>
|
||||
<strong>InventoryObject.slot</strong>
|
||||
<a name = "slot"></a>
|
||||
<strong>slot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/InvItem.html#">InvItem</a>) slot of item whose inventory display properties you wish to change
|
||||
(<a href="../enums/InvItem.html#">InvItem</a>) slot of item whose inventory display properties you wish to change
|
||||
|
||||
|
||||
|
||||
|
|
@ -158,8 +167,8 @@ associated getters and setters.</td>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.yOffset"></a>
|
||||
<strong>InventoryObject.yOffset</strong>
|
||||
<a name = "yOffset"></a>
|
||||
<strong>yOffset</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(float) y-axis offset (positive values will move the item lower).
|
||||
|
|
@ -173,8 +182,8 @@ A value of about 100 will cause the item to display directly below its usual pos
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.scale"></a>
|
||||
<strong>InventoryObject.scale</strong>
|
||||
<a name = "scale"></a>
|
||||
<strong>scale</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(float) Item's size when displayed in the inventory as a multiple of its "regular" size.
|
||||
|
|
@ -189,11 +198,11 @@ and a value of 2 will cause the item to render at twice the size.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.rot"></a>
|
||||
<strong>InventoryObject.rot</strong>
|
||||
<a name = "rot"></a>
|
||||
<strong>rot</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Rotation.html#">Rotation</a>) Item's rotation about its origin when displayed in the inventory.
|
||||
(<a href="../misc classes/Rotation.html#">Rotation</a>) Item's rotation about its origin when displayed in the inventory.
|
||||
|
||||
|
||||
|
||||
|
|
@ -203,12 +212,12 @@ and a value of 2 will cause the item to render at twice the size.
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.rotAxisWhenCurrent"></a>
|
||||
<strong>InventoryObject.rotAxisWhenCurrent</strong>
|
||||
<a name = "rotAxisWhenCurrent"></a>
|
||||
<strong>rotAxisWhenCurrent</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(RotationAxis) Axis to rotate about when the item is being looked at in the inventory.
|
||||
Note that this is entirely separate from the <a href="../classes/InventoryObject.html#InventoryObject.rot">rot</a> field described above.
|
||||
Note that this is entirely separate from the <a href="../pre-game script classes/InventoryObject.html#rot">rot</a> field described above.
|
||||
Must be RotationAxis.X, RotationAxis.Y or RotationAxis.Z.
|
||||
e.g. <code>myItem.rotAxisWhenCurrent = RotationAxis.X</code>
|
||||
|
||||
|
|
@ -220,8 +229,8 @@ e.g. <code>myItem.rotAxisWhenCurrent = RotationAxis.X</code>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.meshBits"></a>
|
||||
<strong>InventoryObject.meshBits</strong>
|
||||
<a name = "meshBits"></a>
|
||||
<strong>meshBits</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) <strong>Not currently implemented</strong> (will have no effect regardless of what you set it to)
|
||||
|
|
@ -234,8 +243,8 @@ e.g. <code>myItem.rotAxisWhenCurrent = RotationAxis.X</code>
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.action"></a>
|
||||
<strong>InventoryObject.action</strong>
|
||||
<a name = "action"></a>
|
||||
<strong>action</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(ItemAction) What can the player do with the item?
|
||||
|
|
@ -255,11 +264,11 @@ EXAMINE
|
|||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "InventoryObject.new"></a>
|
||||
<strong>InventoryObject.new ()</strong>
|
||||
<strong>InventoryObject.new()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Create an inventoryObject item. Use this if you want to specify property values later later.
|
||||
|
|
@ -279,7 +288,7 @@ The default property values are not disclosed here, since at the time of writing
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "InventoryObject.new"></a>
|
||||
<strong>InventoryObject.new (nameKey, slot, yOffset, scale, rot, rotAxisWhenCurrent, meshBits, action)</strong>
|
||||
<strong>InventoryObject.new(nameKey, slot, yOffset, scale, rot, rotAxisWhenCurrent, meshBits, action)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
For more information on each parameter, see the
|
||||
|
|
@ -293,7 +302,7 @@ associated getters and setters.
|
|||
name key
|
||||
</li>
|
||||
<li><span class="parameter">slot</span>
|
||||
<span class="types"><a class="type" href="../classes/InvItem.html#">InvItem</a></span>
|
||||
<span class="types"><span class="type">InvItem</span></span>
|
||||
slot of inventory object to change
|
||||
</li>
|
||||
<li><span class="parameter">yOffset</span>
|
||||
|
|
@ -305,7 +314,7 @@ associated getters and setters.
|
|||
item size (1 being standard size)
|
||||
</li>
|
||||
<li><span class="parameter">rot</span>
|
||||
<span class="types"><a class="type" href="../classes/Rotation.html#">Rotation</a></span>
|
||||
<span class="types"><span class="type">Rotation</span></span>
|
||||
rotation about x, y, and z axes
|
||||
</li>
|
||||
<li><span class="parameter">rotAxisWhenCurrent</span>
|
||||
|
|
@ -339,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
511
doc/pre-game script classes/Level.html
Normal file
511
doc/pre-game script classes/Level.html
Normal file
|
|
@ -0,0 +1,511 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Members">Members</a></li>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><strong>Level</strong></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>Level</code></h1>
|
||||
<p>Stores level metadata.</p>
|
||||
<p>These are things things which aren't present in the compiled level file itself.</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#nameKey">nameKey</a></td>
|
||||
<td class="summary">(string) string key for the level's (localised) name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#scriptFile">scriptFile</a></td>
|
||||
<td class="summary">(string) Level-specific Lua script file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#levelFile">levelFile</a></td>
|
||||
<td class="summary">(string) Compiled file path.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#loadScreenFile">loadScreenFile</a></td>
|
||||
<td class="summary">(string) Load screen image.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#ambientTrack">ambientTrack</a></td>
|
||||
<td class="summary">(string) initial ambient sound track to play.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#layer1">layer1</a></td>
|
||||
<td class="summary">(<a href="../pre-game script classes/SkyLayer.html#">SkyLayer</a>) Primary sky layer</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#layer2">layer2</a></td>
|
||||
<td class="summary">(<a href="../pre-game script classes/SkyLayer.html#">SkyLayer</a>) Secondary sky layer
|
||||
<strong>(not yet implemented)</strong></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#fog">fog</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Color.html#">Color</a>) distance fog RGB color.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#horizon">horizon</a></td>
|
||||
<td class="summary">(bool) Draw sky layer?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#colAddHorizon">colAddHorizon</a></td>
|
||||
<td class="summary">(bool) Enable smooth transition from horizon graphic to sky layer.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#weather">weather</a></td>
|
||||
<td class="summary">(WeatherType) Choose weather effect.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#laraType">laraType</a></td>
|
||||
<td class="summary">(LaraType) Must be one of the LaraType values.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#rumble">rumble</a></td>
|
||||
<td class="summary">(bool) Enable occasional screen shake effect.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#mirror">mirror</a></td>
|
||||
<td class="summary">(<a href="../pre-game script classes/Mirror.html#">Mirror</a>) Location and size of the level's mirror, if present.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#UVRotate">UVRotate</a></td>
|
||||
<td class="summary">(byte) Default speed of "UVRotate" animated textures.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#farView">farView</a></td>
|
||||
<td class="summary">(byte) The maximum draw distance for level.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#unlimitedAir">unlimitedAir</a></td>
|
||||
<td class="summary">(bool) Enable unlimited oxygen supply when in water.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#objects">objects</a></td>
|
||||
<td class="summary">(table of <a href="../pre-game script classes/InventoryObject.html#">InventoryObject</a>s) table of inventory object overrides</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Level.new">Level.new()</a></td>
|
||||
<td class="summary">Make a new Level object.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Members"></a>Members</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "nameKey"></a>
|
||||
<strong>nameKey</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) string key for the level's (localised) name.
|
||||
Corresponds to an entry in strings.lua.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "scriptFile"></a>
|
||||
<strong>scriptFile</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) Level-specific Lua script file.
|
||||
Path of the Lua file holding the level's logic script, relative to the location of the tombengine executable
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "levelFile"></a>
|
||||
<strong>levelFile</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) Compiled file path.
|
||||
This path is relative to the location of the TombEngine executable.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "loadScreenFile"></a>
|
||||
<strong>loadScreenFile</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) Load screen image.
|
||||
Path of the level's load screen file (.png or .jpg), relative to the location of the tombengine executable
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ambientTrack"></a>
|
||||
<strong>ambientTrack</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(string) initial ambient sound track to play.
|
||||
This is the filename of the track <strong>without</strong> the .wav extension.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "layer1"></a>
|
||||
<strong>layer1</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../pre-game script classes/SkyLayer.html#">SkyLayer</a>) Primary sky layer
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "layer2"></a>
|
||||
<strong>layer2</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../pre-game script classes/SkyLayer.html#">SkyLayer</a>) Secondary sky layer
|
||||
<strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "fog"></a>
|
||||
<strong>fog</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../misc classes/Color.html#">Color</a>) distance fog RGB color.
|
||||
As seen in TR4's Desert Railroad.
|
||||
If not provided, distance fog will be black.</p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "horizon"></a>
|
||||
<strong>horizon</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) Draw sky layer? (default: false)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "colAddHorizon"></a>
|
||||
<strong>colAddHorizon</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) Enable smooth transition from horizon graphic to sky layer.
|
||||
If set to false, there will be a black band between the two.</p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "weather"></a>
|
||||
<strong>weather</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(WeatherType) Choose weather effect.
|
||||
Must be one of the values <code>WeatherType.NORMAL</code>, <code>WeatherType.RAIN</code>, or <code>WeatherType.SNOW</code>.</p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "laraType"></a>
|
||||
<strong>laraType</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(LaraType) Must be one of the LaraType values.
|
||||
These are:</p>
|
||||
|
||||
<pre><code>NORMAL
|
||||
YOUNG
|
||||
BUNHEAD
|
||||
CATSUIT
|
||||
DIVESUIT
|
||||
INVISIBLE
|
||||
</code></pre>
|
||||
|
||||
<p>e.g. <code>myLevel.laraType = LaraType.DIVESUIT</code></p>
|
||||
|
||||
<p> <strong>(not yet fully implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "rumble"></a>
|
||||
<strong>rumble</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) Enable occasional screen shake effect.
|
||||
As seen in TRC's Sinking Submarine.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "mirror"></a>
|
||||
<strong>mirror</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../pre-game script classes/Mirror.html#">Mirror</a>) Location and size of the level's mirror, if present. </p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "UVRotate"></a>
|
||||
<strong>UVRotate</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(byte) Default speed of "UVRotate" animated textures. </p>
|
||||
|
||||
<p>Must be in the range [-64, 64].</p>
|
||||
|
||||
<p>A level texture can be set in Tomb Editor to use "UVRotate" animation.
|
||||
This gives the effect of the texture looping downwards or upwards in place.
|
||||
Positive values will cause the texture to loop downwards, and negative values
|
||||
will cause an upwards loop. The higher a positive number or the lower a negative
|
||||
number, the faster the scroll will be.</p>
|
||||
|
||||
<p><strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "farView"></a>
|
||||
<strong>farView</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(byte) The maximum draw distance for level.
|
||||
Given in sectors (blocks).
|
||||
Must be in the range [1, 127], and equal to or less than the value passed to SetGameFarView.</p>
|
||||
|
||||
<p>This is equivalent to TRNG's LevelFarView variable.</p>
|
||||
|
||||
<p><strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "unlimitedAir"></a>
|
||||
<strong>unlimitedAir</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(bool) Enable unlimited oxygen supply when in water. </p>
|
||||
|
||||
<p> <strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "objects"></a>
|
||||
<strong>objects</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(table of <a href="../pre-game script classes/InventoryObject.html#">InventoryObject</a>s) table of inventory object overrides
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Level.new"></a>
|
||||
<strong>Level.new()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Make a new Level object.
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
a Level object
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
96
doc/pre-game script classes/Mirror.html
Normal file
96
doc/pre-game script classes/Mirror.html
Normal file
|
|
@ -0,0 +1,96 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>TombEngine</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><strong>Mirror</strong></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Class <code>Mirror</code></h1>
|
||||
<p>A mirror effect.</p>
|
||||
<p>As seen in TR4's Coastal Ruins and Sacred Lake levels.</p>
|
||||
|
||||
<p><strong>Not currently implemented.</strong> </p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</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>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -36,30 +36,39 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Pre-game script 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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><strong>Settings</strong></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -76,7 +85,7 @@
|
|||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Settings.errorMode">Settings.errorMode</a></td>
|
||||
<td class="name" ><a href="#errorMode">errorMode</a></td>
|
||||
<td class="summary">How should the application respond to script errors?</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -89,8 +98,8 @@
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Settings.errorMode"></a>
|
||||
<strong>Settings.errorMode</strong>
|
||||
<a name = "errorMode"></a>
|
||||
<strong>errorMode</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
How should the application respond to script errors?
|
||||
|
|
@ -123,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
@ -37,30 +37,39 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<h2>Pre-game script 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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><strong>SkyLayer</strong></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Enums</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
@ -68,27 +77,25 @@
|
|||
<div id="content">
|
||||
|
||||
<h1>Class <code>SkyLayer</code></h1>
|
||||
<p>Description class for moving clouds, as seen in TR4's City of the Dead.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
<p>Describes a layer of moving clouds.</p>
|
||||
<p>As seen in TR4's City of the Dead.</p>
|
||||
|
||||
|
||||
<h2><a href="#Members">Members</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SkyLayer.color">SkyLayer.color</a></td>
|
||||
<td class="summary">(<a href="../classes/Color.html#">Color</a>) RGB sky color</td>
|
||||
<td class="name" ><a href="#color">color</a></td>
|
||||
<td class="summary">(<a href="../misc classes/Color.html#">Color</a>) RGB sky color</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SkyLayer.speed">SkyLayer.speed</a></td>
|
||||
<td class="name" ><a href="#speed">speed</a></td>
|
||||
<td class="summary">(int) cloud speed.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SkyLayer.new">SkyLayer.new (color, speed)</a></td>
|
||||
<td class="name" ><a href="#SkyLayer.new">SkyLayer.new(color, speed)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
|
|
@ -103,11 +110,11 @@
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SkyLayer.color"></a>
|
||||
<strong>SkyLayer.color</strong>
|
||||
<a name = "color"></a>
|
||||
<strong>color</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(<a href="../classes/Color.html#">Color</a>) RGB sky color
|
||||
(<a href="../misc classes/Color.html#">Color</a>) RGB sky color
|
||||
|
||||
|
||||
|
||||
|
|
@ -117,8 +124,8 @@
|
|||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "SkyLayer.speed"></a>
|
||||
<strong>SkyLayer.speed</strong>
|
||||
<a name = "speed"></a>
|
||||
<strong>speed</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
(int) cloud speed. </p>
|
||||
|
|
@ -140,11 +147,11 @@ Less is more. City of The Dead, for example, uses a speed value of 16.
|
|||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SkyLayer.new"></a>
|
||||
<strong>SkyLayer.new (color, speed)</strong>
|
||||
<strong>SkyLayer.new(color, speed)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -155,7 +162,7 @@ Less is more. City of The Dead, for example, uses a speed value of 16.
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="../classes/Color.html#">Color</a></span>
|
||||
<span class="types"><span class="type">Color</span></span>
|
||||
RGB color
|
||||
</li>
|
||||
<li><span class="parameter">speed</span>
|
||||
|
|
@ -181,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
@ -40,37 +40,46 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/gameflow.html">gameflow</a></li>
|
||||
<li><strong>gamelogic</strong></li>
|
||||
<li><a href="../script files/Pre-game.html">Pre-game scripts</a></li>
|
||||
<li><strong>Level-specific scripts</strong></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<h2>Enums</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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>gamelogic</code></h1>
|
||||
<h1>Level-specific files</code></h1>
|
||||
<p>Functions and callbacks for level-specific logic scripts.</p>
|
||||
<p>
|
||||
|
||||
|
|
@ -80,61 +89,61 @@
|
|||
<h2><a href="#Ambience_and_music">Ambience and music </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetAmbientTrack">SetAmbientTrack (name)</a></td>
|
||||
<td class="summary">Set the named track as the ambient track, and start playing it</td>
|
||||
<td class="name" ><a href="#SetAmbientTrack">SetAmbientTrack(name)</a></td>
|
||||
<td class="summary">Set and play an ambient track</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#PlayAudioTrack">PlayAudioTrack (name, loop)</a></td>
|
||||
<td class="summary">Start playing the named track.</td>
|
||||
<td class="name" ><a href="#PlayAudioTrack">PlayAudioTrack(name, loop)</a></td>
|
||||
<td class="summary">Play an audio track</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Player_inventory_management">Player inventory management </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#GiveInvItem">GiveInvItem (item, count)</a></td>
|
||||
<td class="summary">Add x of a certain item to the inventory.</td>
|
||||
<td class="name" ><a href="#GiveInvItem">GiveInvItem(item, count)</a></td>
|
||||
<td class="summary">Add x of an item to the inventory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#TakeInvItem">TakeInvItem (item, count)</a></td>
|
||||
<td class="name" ><a href="#TakeInvItem">TakeInvItem(item, count)</a></td>
|
||||
<td class="summary">Remove x of a certain item from the inventory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetInvItemCount">GetInvItemCount (item)</a></td>
|
||||
<td class="name" ><a href="#GetInvItemCount">GetInvItemCount(item)</a></td>
|
||||
<td class="summary">Get the amount the player holds of an item.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetInvItemCount">SetInvItemCount (item, count)</a></td>
|
||||
<td class="name" ><a href="#SetInvItemCount">SetInvItemCount(item, count)</a></td>
|
||||
<td class="summary">Set the amount of a certain item the player has in the inventory.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Game_entity_getters">Game entity getters </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetItemByName">GetItemByName (name)</a></td>
|
||||
<td class="name" ><a href="#GetItemByName">GetItemByName(name)</a></td>
|
||||
<td class="summary">Get an ItemInfo by its name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetMeshByName">GetMeshByName (name)</a></td>
|
||||
<td class="name" ><a href="#GetMeshByName">GetMeshByName(name)</a></td>
|
||||
<td class="summary">Get a MeshInfo by its name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetCameraByName">GetCameraByName (name)</a></td>
|
||||
<td class="name" ><a href="#GetCameraByName">GetCameraByName(name)</a></td>
|
||||
<td class="summary">Get a CameraInfo by its name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetSinkByName">GetSinkByName (name)</a></td>
|
||||
<td class="name" ><a href="#GetSinkByName">GetSinkByName(name)</a></td>
|
||||
<td class="summary">Get a SinkInfo by its name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#GetSoundSourceByName">GetSoundSourceByName (name)</a></td>
|
||||
<td class="name" ><a href="#GetSoundSourceByName">GetSoundSourceByName(name)</a></td>
|
||||
<td class="summary">Get a SoundSourceInfo by its name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#CalculateDistance">CalculateDistance (posA, posB)</a></td>
|
||||
<td class="name" ><a href="#CalculateDistance">CalculateDistance(posA, posB)</a></td>
|
||||
<td class="summary">Calculate the distance between two positions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#CalculateHorizontalDistance">CalculateHorizontalDistance (posA, posB)</a></td>
|
||||
<td class="name" ><a href="#CalculateHorizontalDistance">CalculateHorizontalDistance(posA, posB)</a></td>
|
||||
<td class="summary">Calculate the horizontal distance between two positions.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -142,7 +151,7 @@
|
|||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#Lara">Lara</a></td>
|
||||
<td class="summary">An <a href="../classes/ItemInfo.html#">ItemInfo</a> representing Lara herself.</td>
|
||||
<td class="summary">An <a href="../entity classes/ItemInfo.html#">ItemInfo</a> representing Lara herself.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Special_tables">Special tables </a></h2>
|
||||
|
|
@ -170,10 +179,10 @@
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetAmbientTrack"></a>
|
||||
<strong>SetAmbientTrack (name)</strong>
|
||||
<strong>SetAmbientTrack(name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set the named track as the ambient track, and start playing it
|
||||
Set and play an ambient track
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
|
@ -191,10 +200,10 @@
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "PlayAudioTrack"></a>
|
||||
<strong>PlayAudioTrack (name, loop)</strong>
|
||||
<strong>PlayAudioTrack(name, loop)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Start playing the named track.
|
||||
Play an audio track
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
|
@ -220,10 +229,10 @@
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "GiveInvItem"></a>
|
||||
<strong>GiveInvItem (item, count)</strong>
|
||||
<strong>GiveInvItem(item, count)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add x of a certain item to the inventory.
|
||||
Add x of an item to the inventory.
|
||||
A count of 0 will add the "default" amount of that item
|
||||
(i.e. the amount the player would get from a pickup of that type).
|
||||
For example, giving "zero" crossbow ammo would give the player
|
||||
|
|
@ -233,7 +242,7 @@ For example, giving "zero" crossbow ammo would give the player
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">item</span>
|
||||
<span class="types"><a class="type" href="../classes/InvItem.html#">InvItem</a></span>
|
||||
<span class="types"><span class="type">InvItem</span></span>
|
||||
the item to be added
|
||||
</li>
|
||||
<li><span class="parameter">count</span>
|
||||
|
|
@ -249,17 +258,17 @@ For example, giving "zero" crossbow ammo would give the player
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "TakeInvItem"></a>
|
||||
<strong>TakeInvItem (item, count)</strong>
|
||||
<strong>TakeInvItem(item, count)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Remove x of a certain item from the inventory.
|
||||
As in <a href="../modules/gamelogic.html#GiveInvItem">GiveInvItem</a>, a count of 0 will remove the "default" amount of that item.
|
||||
As in <a href="../script files/Level-specific.html#GiveInvItem">GiveInvItem</a>, a count of 0 will remove the "default" amount of that item.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">item</span>
|
||||
<span class="types"><a class="type" href="../classes/InvItem.html#">InvItem</a></span>
|
||||
<span class="types"><span class="type">InvItem</span></span>
|
||||
the item to be removed
|
||||
</li>
|
||||
<li><span class="parameter">count</span>
|
||||
|
|
@ -275,7 +284,7 @@ As in <a href="../modules/gamelogic.html#GiveInvItem">GiveInvItem</a>, a count o
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "GetInvItemCount"></a>
|
||||
<strong>GetInvItemCount (item)</strong>
|
||||
<strong>GetInvItemCount(item)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get the amount the player holds of an item.
|
||||
|
|
@ -284,7 +293,7 @@ As in <a href="../modules/gamelogic.html#GiveInvItem">GiveInvItem</a>, a count o
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">item</span>
|
||||
<span class="types"><a class="type" href="../classes/InvItem.html#">InvItem</a></span>
|
||||
<span class="types"><span class="type">InvItem</span></span>
|
||||
the item to check
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -302,11 +311,11 @@ As in <a href="../modules/gamelogic.html#GiveInvItem">GiveInvItem</a>, a count o
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "SetInvItemCount"></a>
|
||||
<strong>SetInvItemCount (item, count)</strong>
|
||||
<strong>SetInvItemCount(item, count)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set the amount of a certain item the player has in the inventory.
|
||||
Similar to <a href="../modules/gamelogic.html#GiveInvItem">GiveInvItem</a> but replaces with the new amount instead of adding it.
|
||||
Similar to <a href="../script files/Level-specific.html#GiveInvItem">GiveInvItem</a> but replaces with the new amount instead of adding it.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
|
@ -337,7 +346,7 @@ or is destroyed in some other way.
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "GetItemByName"></a>
|
||||
<strong>GetItemByName (name)</strong>
|
||||
<strong>GetItemByName(name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get an ItemInfo by its name.
|
||||
|
|
@ -354,7 +363,7 @@ or is destroyed in some other way.
|
|||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/ItemInfo.html#">ItemInfo</a></span>
|
||||
<span class="types"><span class="type">ItemInfo</span></span>
|
||||
a non-owning ItemInfo referencing the item.
|
||||
</ol>
|
||||
|
||||
|
|
@ -364,7 +373,7 @@ or is destroyed in some other way.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "GetMeshByName"></a>
|
||||
<strong>GetMeshByName (name)</strong>
|
||||
<strong>GetMeshByName(name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get a MeshInfo by its name.
|
||||
|
|
@ -381,7 +390,7 @@ or is destroyed in some other way.
|
|||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/MeshInfo.html#">MeshInfo</a></span>
|
||||
<span class="types"><span class="type">MeshInfo</span></span>
|
||||
a non-owning MeshInfo referencing the mesh.
|
||||
</ol>
|
||||
|
||||
|
|
@ -391,7 +400,7 @@ or is destroyed in some other way.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "GetCameraByName"></a>
|
||||
<strong>GetCameraByName (name)</strong>
|
||||
<strong>GetCameraByName(name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get a CameraInfo by its name.
|
||||
|
|
@ -408,7 +417,7 @@ or is destroyed in some other way.
|
|||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/CameraInfo.html#">CameraInfo</a></span>
|
||||
<span class="types"><span class="type">CameraInfo</span></span>
|
||||
a non-owning CameraInfo referencing the camera.
|
||||
</ol>
|
||||
|
||||
|
|
@ -418,7 +427,7 @@ or is destroyed in some other way.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "GetSinkByName"></a>
|
||||
<strong>GetSinkByName (name)</strong>
|
||||
<strong>GetSinkByName(name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get a SinkInfo by its name.
|
||||
|
|
@ -435,7 +444,7 @@ or is destroyed in some other way.
|
|||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SinkInfo.html#">SinkInfo</a></span>
|
||||
<span class="types"><span class="type">SinkInfo</span></span>
|
||||
a non-owning SinkInfo referencing the sink.
|
||||
</ol>
|
||||
|
||||
|
|
@ -445,7 +454,7 @@ or is destroyed in some other way.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "GetSoundSourceByName"></a>
|
||||
<strong>GetSoundSourceByName (name)</strong>
|
||||
<strong>GetSoundSourceByName(name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get a SoundSourceInfo by its name.
|
||||
|
|
@ -462,7 +471,7 @@ or is destroyed in some other way.
|
|||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/SoundSourceInfo.html#">SoundSourceInfo</a></span>
|
||||
<span class="types"><span class="type">SoundSourceInfo</span></span>
|
||||
a non-owning SoundSourceInfo referencing the sink.
|
||||
</ol>
|
||||
|
||||
|
|
@ -472,7 +481,7 @@ or is destroyed in some other way.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "CalculateDistance"></a>
|
||||
<strong>CalculateDistance (posA, posB)</strong>
|
||||
<strong>CalculateDistance(posA, posB)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Calculate the distance between two positions.
|
||||
|
|
@ -481,11 +490,11 @@ or is destroyed in some other way.
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">posA</span>
|
||||
<span class="types"><a class="type" href="../classes/Position.html#">Position</a></span>
|
||||
<span class="types"><span class="type">Position</span></span>
|
||||
first position
|
||||
</li>
|
||||
<li><span class="parameter">posB</span>
|
||||
<span class="types"><a class="type" href="../classes/Position.html#">Position</a></span>
|
||||
<span class="types"><span class="type">Position</span></span>
|
||||
second position
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -503,7 +512,7 @@ or is destroyed in some other way.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "CalculateHorizontalDistance"></a>
|
||||
<strong>CalculateHorizontalDistance (posA, posB)</strong>
|
||||
<strong>CalculateHorizontalDistance(posA, posB)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Calculate the horizontal distance between two positions.
|
||||
|
|
@ -512,11 +521,11 @@ or is destroyed in some other way.
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">posA</span>
|
||||
<span class="types"><a class="type" href="../classes/Position.html#">Position</a></span>
|
||||
<span class="types"><span class="type">Position</span></span>
|
||||
first position
|
||||
</li>
|
||||
<li><span class="parameter">posB</span>
|
||||
<span class="types"><a class="type" href="../classes/Position.html#">Position</a></span>
|
||||
<span class="types"><span class="type">Position</span></span>
|
||||
second position
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -541,7 +550,7 @@ or is destroyed in some other way.
|
|||
<strong>Lara</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
An <a href="../classes/ItemInfo.html#">ItemInfo</a> representing Lara herself.
|
||||
An <a href="../entity classes/ItemInfo.html#">ItemInfo</a> representing Lara herself.
|
||||
|
||||
|
||||
|
||||
|
|
@ -577,7 +586,7 @@ some time later, the values <code>3</code> will be put back into <code>LevelVars
|
|||
|
||||
<p><strong>This table is emptied when a level is finished.</strong> If the player needs to be able
|
||||
to return to the level (like in the Karnak and Alexandria levels in <em>The Last Revelation</em>),
|
||||
you will need to use the <a href="../modules/gamelogic.html#GameVars">GameVars</a> table, below.
|
||||
you will need to use the <a href="../script files/Level-specific.html#GameVars">GameVars</a> table, below.
|
||||
|
||||
|
||||
|
||||
|
|
@ -609,7 +618,7 @@ write:</p>
|
|||
end
|
||||
</code></pre>
|
||||
|
||||
<p>Unlike <a href="../modules/gamelogic.html#LevelVars">LevelVars</a>, this table will remain intact for the entirety of the game.
|
||||
<p>Unlike <a href="../script files/Level-specific.html#LevelVars">LevelVars</a>, this table will remain intact for the entirety of the game.
|
||||
|
||||
|
||||
|
||||
|
|
@ -678,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-16 12:53:44 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
@ -39,38 +39,47 @@
|
|||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<h2>Script Files</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>gameflow</strong></li>
|
||||
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
|
||||
<li><strong>Pre-game scripts</strong></li>
|
||||
<li><a href="../script files/Level-specific.html">Level-specific scripts</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<h2>Enums</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>
|
||||
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../classes/Level.html">Level</a></li>
|
||||
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../classes/Position.html">Position</a></li>
|
||||
<li><a href="../classes/Rotation.html">Rotation</a></li>
|
||||
<li><a href="../classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
|
||||
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
<li><a href="../classes/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../classes/ObjID.html">ObjID</a></li>
|
||||
<li><a href="../enums/InvItem.html">InvItem</a></li>
|
||||
<li><a href="../enums/ObjID.html">ObjID</a></li>
|
||||
</ul>
|
||||
<h2>Entity classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../entity classes/AIObject.html">AIObject</a></li>
|
||||
<li><a href="../entity classes/CameraInfo.html">CameraInfo</a></li>
|
||||
<li><a href="../entity classes/ItemInfo.html">ItemInfo</a></li>
|
||||
<li><a href="../entity classes/MeshInfo.html">MeshInfo</a></li>
|
||||
<li><a href="../entity classes/SinkInfo.html">SinkInfo</a></li>
|
||||
<li><a href="../entity classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
|
||||
</ul>
|
||||
<h2>Pre-game script classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../pre-game script classes/AudioTrack.html">AudioTrack</a></li>
|
||||
<li><a href="../pre-game script classes/InventoryObject.html">InventoryObject</a></li>
|
||||
<li><a href="../pre-game script classes/Level.html">Level</a></li>
|
||||
<li><a href="../pre-game script classes/Mirror.html">Mirror</a></li>
|
||||
<li><a href="../pre-game script classes/Settings.html">Settings</a></li>
|
||||
<li><a href="../pre-game script classes/SkyLayer.html">SkyLayer</a></li>
|
||||
</ul>
|
||||
<h2>Misc classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../misc classes/Color.html">Color</a></li>
|
||||
<li><a href="../misc classes/Position.html">Position</a></li>
|
||||
<li><a href="../misc classes/Rotation.html">Rotation</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>gameflow</code></h1>
|
||||
<p>Files that will be run on game startup.</p>
|
||||
<h1>Pre-game files</code></h1>
|
||||
<p>Scripts that will be run on game startup.</p>
|
||||
<p>
|
||||
|
||||
</p>
|
||||
|
|
@ -79,26 +88,26 @@
|
|||
<h2><a href="#gameflow_lua">gameflow.lua </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" ><a href="#AddLevel">AddLevel (level)</a></td>
|
||||
<td class="name" ><a href="#AddLevel">AddLevel(level)</a></td>
|
||||
<td class="summary">Add a level to the gameflow.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetIntroImagePath">SetIntroImagePath (path)</a></td>
|
||||
<td class="summary">The path of the .jpg or .png image to show when loading the game.</td>
|
||||
<td class="name" ><a href="#SetIntroImagePath">SetIntroImagePath(path)</a></td>
|
||||
<td class="summary">Image to show when loading the game.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
<td class="name" ><a href="#SetTitleScreenImagePath">SetTitleScreenImagePath(path)</a></td>
|
||||
<td class="summary">Image to show in the background of the title screen.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" ><a href="#SetGameFarView">SetGameFarView (farview)</a></td>
|
||||
<td class="summary">The maximum draw distance, in sectors (blocks), of any level in the game.</td>
|
||||
<td class="name" ><a href="#SetGameFarView">SetGameFarView(farview)</a></td>
|
||||
<td class="summary">Maximum draw distance.</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="name" ><a href="#SetSettings">SetSettings(settings)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
|
|
@ -107,7 +116,7 @@
|
|||
<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="name" ><a href="#SetAudioTracks">SetAudioTracks(table)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
|
|
@ -116,12 +125,12 @@
|
|||
<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="name" ><a href="#SetStrings">SetStrings(table)</a></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">Specify which translations in the strings table correspond to which languages.</td>
|
||||
<td class="name" ><a href="#SetLanguageNames">SetLanguageNames(table)</a></td>
|
||||
<td class="summary">Set language names for translations.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -139,7 +148,7 @@ ambient tracks.
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "AddLevel"></a>
|
||||
<strong>AddLevel (level)</strong>
|
||||
<strong>AddLevel(level)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Add a level to the gameflow.
|
||||
|
|
@ -148,7 +157,7 @@ ambient tracks.
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">level</span>
|
||||
<span class="types"><a class="type" href="../classes/Level.html#">Level</a></span>
|
||||
<span class="types"><span class="type">Level</span></span>
|
||||
a level object
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -160,10 +169,11 @@ ambient tracks.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "SetIntroImagePath"></a>
|
||||
<strong>SetIntroImagePath (path)</strong>
|
||||
<strong>SetIntroImagePath(path)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The path of the .jpg or .png image to show when loading the game.
|
||||
Image to show when loading the game.
|
||||
Must be a .jpg or .png image.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
|
|
@ -181,10 +191,11 @@ ambient tracks.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "SetTitleScreenImagePath"></a>
|
||||
<strong>SetTitleScreenImagePath (path)</strong>
|
||||
<strong>SetTitleScreenImagePath(path)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The path of the .jpg or .png image to show in the background of the title screen.
|
||||
Image to show in the background of the title screen.
|
||||
Must be a .jpg or .png image.
|
||||
<strong>(not yet implemented)</strong>
|
||||
|
||||
|
||||
|
|
@ -203,10 +214,11 @@ ambient tracks.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "SetGameFarView"></a>
|
||||
<strong>SetGameFarView (farview)</strong>
|
||||
<strong>SetGameFarView(farview)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The maximum draw distance, in sectors (blocks), of any level in the game.
|
||||
Maximum draw distance.
|
||||
The maximum draw distance, in sectors (blocks), of any level in the game.
|
||||
This is equivalent to TRNG's WorldFarView variable.
|
||||
<strong>(not yet implemented)</strong>
|
||||
|
||||
|
|
@ -234,7 +246,7 @@ settings.lua shouldn't be bundled with any finished levels/games.
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetSettings"></a>
|
||||
<strong>SetSettings (settings)</strong>
|
||||
<strong>SetSettings(settings)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -245,7 +257,7 @@ settings.lua shouldn't be bundled with any finished levels/games.
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">settings</span>
|
||||
<span class="types"><a class="type" href="../classes/Settings.html#">Settings</a></span>
|
||||
<span class="types"><span class="type">Settings</span></span>
|
||||
a settings object
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -264,7 +276,7 @@ settings.lua shouldn't be bundled with any finished levels/games.
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetAudioTracks"></a>
|
||||
<strong>SetAudioTracks (table)</strong>
|
||||
<strong>SetAudioTracks(table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
|
@ -276,7 +288,7 @@ settings.lua shouldn't be bundled with any finished levels/games.
|
|||
<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 <a href="../classes/AudioTrack.html#">AudioTrack</a> objects
|
||||
array-style table with <a href="../pre-game script classes/AudioTrack.html#">AudioTrack</a> objects
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -296,7 +308,7 @@ You will not need to call them manually.
|
|||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "SetStrings"></a>
|
||||
<strong>SetStrings (table)</strong>
|
||||
<strong>SetStrings(table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set string variable keys and their translations.
|
||||
|
|
@ -305,7 +317,7 @@ You will not need to call them manually.
|
|||
<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>
|
||||
<span class="types"><span class="type">tab</span></span>
|
||||
array-style table with strings
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -317,16 +329,17 @@ You will not need to call them manually.
|
|||
</dd>
|
||||
<dt>
|
||||
<a name = "SetLanguageNames"></a>
|
||||
<strong>SetLanguageNames (table)</strong>
|
||||
<strong>SetLanguageNames(table)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Specify which translations in the strings table correspond to which languages.
|
||||
Set language names for translations.
|
||||
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>
|
||||
<span class="types"><span class="type">tab</span></span>
|
||||
array-style table with language names
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -343,7 +356,7 @@ You will not need to call them manually.
|
|||
</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-17 03:39:52 </i>
|
||||
<i style="float:right;">Last updated 2021-08-23 19:18:19 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
Loading…
Add table
Add a link
Reference in a new issue