2021-08-12 20:16:28 +01:00
|
|
|
<!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>
|
2021-08-23 20:16:01 +01:00
|
|
|
<title>TombEngine Lua API</title>
|
2021-08-12 20:16:28 +01:00
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Script Files</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<ul class="nowrap">
|
2021-08-23 19:19:36 +01:00
|
|
|
<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>
|
2021-08-12 20:16:28 +01:00
|
|
|
</ul>
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Enums</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<ul class="nowrap">
|
2021-08-23 19:19:36 +01:00
|
|
|
<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>
|
2021-08-30 18:46:48 +01:00
|
|
|
<li><a href="misc classes/DisplayString.html">DisplayString</a></li>
|
2021-08-23 19:19:36 +01:00
|
|
|
<li><a href="misc classes/Position.html">Position</a></li>
|
|
|
|
|
<li><a href="misc classes/Rotation.html">Rotation</a></li>
|
2021-08-12 20:16:28 +01:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="content">
|
|
|
|
|
|
|
|
|
|
|
2021-08-23 20:16:01 +01:00
|
|
|
<h2>TombEngine scripting interface</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Script Files</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<table class="module_list">
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="script files/Pre-game.html">Pre-game</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Scripts that will be run on game startup.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="script files/Level-specific.html">Level-specific</a></td>
|
2021-08-12 20:16:28 +01:00
|
|
|
<td class="summary">Functions and callbacks for level-specific logic scripts.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2021-08-23 19:19:36 +01:00
|
|
|
<h2>Enums</h2>
|
2021-08-12 20:16:28 +01:00
|
|
|
<table class="module_list">
|
|
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<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>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
2021-08-15 23:08:05 +01:00
|
|
|
<tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="name" ><a href="enums/ObjID.html">ObjID</a></td>
|
|
|
|
|
<td class="summary">Constants for object IDs.</td>
|
2021-08-15 23:08:05 +01:00
|
|
|
</tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
</table>
|
|
|
|
|
<h2>Entity classes</h2>
|
|
|
|
|
<table class="module_list">
|
2021-08-12 20:16:28 +01:00
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="entity classes/AIObject.html">AIObject</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">AI object</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="entity classes/CameraInfo.html">CameraInfo</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Camera info</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="entity classes/ItemInfo.html">ItemInfo</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Represents any object inside the game world.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="entity classes/MeshInfo.html">MeshInfo</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Mesh info</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="entity classes/SinkInfo.html">SinkInfo</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Sink info</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="entity classes/SoundSourceInfo.html">SoundSourceInfo</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Sound source info</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
</table>
|
|
|
|
|
<h2>Pre-game script classes</h2>
|
|
|
|
|
<table class="module_list">
|
2021-08-12 20:16:28 +01:00
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="pre-game script classes/AudioTrack.html">AudioTrack</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Metadata about audio tracks (music and ambience).</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="pre-game script classes/InventoryObject.html">InventoryObject</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Represents the properties of an object as it appears in the inventory.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="pre-game script classes/Level.html">Level</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Stores level metadata.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
2021-08-16 12:55:22 +01:00
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="pre-game script classes/Mirror.html">Mirror</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">A mirror effect.</td>
|
2021-08-16 12:55:22 +01:00
|
|
|
</tr>
|
2021-08-12 20:16:28 +01:00
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="pre-game script classes/Settings.html">Settings</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Settings that will be run on game startup.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="pre-game script classes/SkyLayer.html">SkyLayer</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Describes a layer of moving clouds.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
2021-08-23 19:19:36 +01:00
|
|
|
</table>
|
|
|
|
|
<h2>Misc classes</h2>
|
|
|
|
|
<table class="module_list">
|
2021-08-12 20:16:28 +01:00
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="misc classes/Color.html">Color</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">An RGBA or RGB color.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
2021-08-30 18:46:48 +01:00
|
|
|
<tr>
|
|
|
|
|
<td class="name" ><a href="misc classes/DisplayString.html">DisplayString</a></td>
|
|
|
|
|
<td class="summary">A string appearing on the screen.</td>
|
|
|
|
|
</tr>
|
2021-08-12 20:16:28 +01:00
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="misc classes/Position.html">Position</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Represents a position in the game world.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2021-08-23 20:16:01 +01:00
|
|
|
<td class="name" ><a href="misc classes/Rotation.html">Rotation</a></td>
|
2021-08-23 19:19:36 +01:00
|
|
|
<td class="summary">Represents a rotation.</td>
|
2021-08-12 20:16:28 +01:00
|
|
|
</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>
|
2021-08-30 18:46:48 +01:00
|
|
|
<i style="float:right;">Last updated 2021-08-30 18:45:10 </i>
|
2021-08-12 20:16:28 +01:00
|
|
|
</div> <!-- id="about" -->
|
|
|
|
|
</div> <!-- id="container" -->
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
