mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-02 09:47:58 +03:00
297 lines
7.7 KiB
HTML
297 lines
7.7 KiB
HTML
|
<!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>TombEngine Lua API</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="#Functions">Functions</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
<h2>1 Modules</h2>
|
||
|
|
<ul class="nowrap">
|
||
|
|
<li><a href="../1 modules/Flow.html">Flow</a></li>
|
||
|
|
<li><a href="../1 modules/Inventory.html">Inventory</a></li>
|
||
|
|
<li><a href="../1 modules/Logic.html">Logic</a></li>
|
||
|
|
<li><a href="../1 modules/Misc.html">Misc</a></li>
|
||
|
|
<li><strong>Objects</strong></li>
|
||
|
|
<li><a href="../1 modules/Strings.html">Strings</a></li>
|
||
|
|
</ul>
|
||
|
|
<h2>2 Classes</h2>
|
||
|
|
<ul class="nowrap">
|
||
|
|
<li><a href="../2 classes/Flow.Animations.html">Flow.Animations</a></li>
|
||
|
|
<li><a href="../2 classes/Flow.Fog.html">Flow.Fog</a></li>
|
||
|
|
<li><a href="../2 classes/Flow.InventoryItem.html">Flow.InventoryItem</a></li>
|
||
|
|
<li><a href="../2 classes/Flow.Level.html">Flow.Level</a></li>
|
||
|
|
<li><a href="../2 classes/Flow.Mirror.html">Flow.Mirror</a></li>
|
||
|
|
<li><a href="../2 classes/Flow.Settings.html">Flow.Settings</a></li>
|
||
|
|
<li><a href="../2 classes/Flow.SkyLayer.html">Flow.SkyLayer</a></li>
|
||
|
|
<li><a href="../2 classes/Objects.AIObject.html">Objects.AIObject</a></li>
|
||
|
|
<li><a href="../2 classes/Objects.Camera.html">Objects.Camera</a></li>
|
||
|
|
<li><a href="../2 classes/Objects.Moveable.html">Objects.Moveable</a></li>
|
||
|
|
<li><a href="../2 classes/Objects.Sink.html">Objects.Sink</a></li>
|
||
|
|
<li><a href="../2 classes/Objects.SoundSource.html">Objects.SoundSource</a></li>
|
||
|
|
<li><a href="../2 classes/Objects.Static.html">Objects.Static</a></li>
|
||
|
|
<li><a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
|
||
|
|
</ul>
|
||
|
|
<h2>3 Primitive Classes</h2>
|
||
|
|
<ul class="nowrap">
|
||
|
|
<li><a href="../3 primitive classes/Color.html">Color</a></li>
|
||
|
|
<li><a href="../3 primitive classes/Position.html">Position</a></li>
|
||
|
|
<li><a href="../3 primitive classes/Rotation.html">Rotation</a></li>
|
||
|
|
</ul>
|
||
|
|
<h2>4 Enums</h2>
|
||
|
|
<ul class="nowrap">
|
||
|
|
<li><a href="../4 enums/Flow.InvID.html">Flow.InvID</a></li>
|
||
|
|
<li><a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="content">
|
||
|
|
|
||
|
|
<h1>Table <code>Objects</code></h1>
|
||
|
|
<p>Scripts that will be run on game startup.</p>
|
||
|
|
<p>
|
||
|
|
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
<h2><a href="#Functions">Functions</a></h2>
|
||
|
|
<table class="function_list">
|
||
|
|
<tr>
|
||
|
|
<td class="name" ><a href="#GetMoveableByName">GetMoveableByName(name)</a></td>
|
||
|
|
<td class="summary">Get a moveable by its name.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="name" ><a href="#GetStaticByName">GetStaticByName(name)</a></td>
|
||
|
|
<td class="summary">Get a Static by its name.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="name" ><a href="#GetCameraByName">GetCameraByName(name)</a></td>
|
||
|
|
<td class="summary">Get a Camera by its name.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="name" ><a href="#GetSinkByName">GetSinkByName(name)</a></td>
|
||
|
|
<td class="summary">Get a Sink by its name.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="name" ><a href="#GetSoundSourceByName">GetSoundSourceByName(name)</a></td>
|
||
|
|
<td class="summary">Get a SoundSource by its name.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="name" ><a href="#GetAIObjectByName">GetAIObjectByName(name)</a></td>
|
||
|
|
<td class="summary">Get an AIObject by its name.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br/>
|
||
|
|
<br/>
|
||
|
|
|
||
|
|
|
||
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt>
|
||
|
|
<a name = "GetMoveableByName"></a>
|
||
|
|
<strong>GetMoveableByName(name)</strong>
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
Get a moveable by its name.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters:</h3>
|
||
|
|
<ul>
|
||
|
|
<li><span class="parameter">name</span>
|
||
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||
|
|
the unique name of the Moveable as set in, or generated by, Tomb Editor
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Returns:</h3>
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<span class="types"><span class="type">Moveable</span></span>
|
||
|
|
a non-owning Moveable referencing the item.
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt>
|
||
|
|
<a name = "GetStaticByName"></a>
|
||
|
|
<strong>GetStaticByName(name)</strong>
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
Get a Static by its name.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters:</h3>
|
||
|
|
<ul>
|
||
|
|
<li><span class="parameter">name</span>
|
||
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||
|
|
the unique name of the mesh as set in, or generated by, Tomb Editor
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Returns:</h3>
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<span class="types"><span class="type">Static</span></span>
|
||
|
|
a non-owning Static referencing the mesh.
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt>
|
||
|
|
<a name = "GetCameraByName"></a>
|
||
|
|
<strong>GetCameraByName(name)</strong>
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
Get a Camera by its name.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters:</h3>
|
||
|
|
<ul>
|
||
|
|
<li><span class="parameter">name</span>
|
||
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||
|
|
the unique name of the camera as set in, or generated by, Tomb Editor
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Returns:</h3>
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<span class="types"><span class="type">Camera</span></span>
|
||
|
|
a non-owning Camera referencing the camera.
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt>
|
||
|
|
<a name = "GetSinkByName"></a>
|
||
|
|
<strong>GetSinkByName(name)</strong>
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
Get a Sink by its name.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters:</h3>
|
||
|
|
<ul>
|
||
|
|
<li><span class="parameter">name</span>
|
||
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||
|
|
the unique name of the sink as set in, or generated by, Tomb Editor
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Returns:</h3>
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<span class="types"><span class="type">Sink</span></span>
|
||
|
|
a non-owning Sink referencing the sink.
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt>
|
||
|
|
<a name = "GetSoundSourceByName"></a>
|
||
|
|
<strong>GetSoundSourceByName(name)</strong>
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
Get a SoundSource by its name.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters:</h3>
|
||
|
|
<ul>
|
||
|
|
<li><span class="parameter">name</span>
|
||
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||
|
|
the unique name of the sound source as set in, or generated by, Tomb Editor
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Returns:</h3>
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<span class="types"><span class="type">SoundSource</span></span>
|
||
|
|
a non-owning SoundSource referencing the sound source.
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt>
|
||
|
|
<a name = "GetAIObjectByName"></a>
|
||
|
|
<strong>GetAIObjectByName(name)</strong>
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
Get an AIObject by its name.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters:</h3>
|
||
|
|
<ul>
|
||
|
|
<li><span class="parameter">name</span>
|
||
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||
|
|
the unique name of the AIObject as set in, or generated by, Tomb Editor
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Returns:</h3>
|
||
|
|
<ol>
|
||
|
|
|
||
|
|
<span class="types"><span class="type">AIObject</span></span>
|
||
|
|
a non-owning SoundSource referencing the AI moveable.
|
||
|
|
</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 2022-04-10 00:37:11 </i>
|
||
|
|
</div> <!-- id="about" -->
|
||
|
|
</div> <!-- id="container" -->
|
||
|
|
</body>
|
||
|
|
</html>
|