2022-04-10 00:38:39 +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>
|
2022-12-09 22:08:16 +00:00
|
|
|
<title>TombEngine 1.0.4 Lua API</title>
|
2022-04-10 00:38:39 +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>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="../index.html">Index</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
<h2>1 Modules</h2>
|
2022-04-10 00:38:39 +01:00
|
|
|
<ul class="nowrap">
|
2022-12-09 22:08:16 +00:00
|
|
|
<li> <a href="../1 modules/Effects.html">Effects</a></li>
|
|
|
|
|
<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> <a href="../1 modules/Objects.html">Objects</a></li>
|
|
|
|
|
<li> <a href="../1 modules/Strings.html">Strings</a></li>
|
2022-04-10 00:38:39 +01:00
|
|
|
</ul>
|
2022-12-09 22:08:16 +00:00
|
|
|
<h2>2 Classes</h2>
|
2022-04-10 00:38:39 +01:00
|
|
|
<ul class="nowrap">
|
2022-12-09 22:08:16 +00:00
|
|
|
<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.LaraObject.html">Objects.LaraObject</a></li>
|
|
|
|
|
<li> <a href="../2 classes/Objects.Moveable.html">Objects.Moveable</a></li>
|
|
|
|
|
<li> <here>Objects.Sink</here></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>
|
2022-12-16 18:36:42 +00:00
|
|
|
<li> <a href="../2 classes/Objects.Volume.html">Objects.Volume</a></li>
|
2022-12-09 22:08:16 +00:00
|
|
|
<li> <a href="../2 classes/Strings.DisplayString.html">Strings.DisplayString</a></li>
|
2022-04-10 00:38:39 +01:00
|
|
|
</ul>
|
|
|
|
|
<h2>3 Primitive Classes</h2>
|
|
|
|
|
<ul class="nowrap">
|
2022-12-09 22:08:16 +00:00
|
|
|
<li> <a href="../3 primitive classes/Color.html">Color</a></li>
|
|
|
|
|
<li> <a href="../3 primitive classes/Rotation.html">Rotation</a></li>
|
|
|
|
|
<li> <a href="../3 primitive classes/Vec3.html">Vec3</a></li>
|
2022-04-10 00:38:39 +01:00
|
|
|
</ul>
|
|
|
|
|
<h2>4 Enums</h2>
|
|
|
|
|
<ul class="nowrap">
|
2022-12-09 22:08:16 +00:00
|
|
|
<li> <a href="../4 enums/Effects.BlendID.html">Effects.BlendID</a></li>
|
|
|
|
|
<li> <a href="../4 enums/Effects.EffectID.html">Effects.EffectID</a></li>
|
|
|
|
|
<li> <a href="../4 enums/Misc.ActionID.html">Misc.ActionID</a></li>
|
|
|
|
|
<li> <a href="../4 enums/Objects.ObjID.html">Objects.ObjID</a></li>
|
2022-04-10 00:38:39 +01:00
|
|
|
</ul>
|
2022-07-29 21:12:54 +01:00
|
|
|
<h2>5 Lua utility modules</h2>
|
|
|
|
|
<ul class="nowrap">
|
2022-12-09 22:08:16 +00:00
|
|
|
<li> <a href="../5 lua utility modules/EventSequence.html">EventSequence</a></li>
|
|
|
|
|
<li> <a href="../5 lua utility modules/Timer.html">Timer</a></li>
|
2022-07-29 21:12:54 +01:00
|
|
|
</ul>
|
2022-04-10 00:38:39 +01:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="content">
|
|
|
|
|
|
|
|
|
|
<h1>Class <code>Objects.Sink</code></h1>
|
|
|
|
|
<p>Sink</p>
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
|
|
|
<table class="function_list">
|
|
|
|
|
<tr>
|
2022-05-23 21:27:05 +01:00
|
|
|
<td class="name" ><a href="#Sink:GetPosition">Sink:GetPosition()</a></td>
|
2022-04-10 00:38:39 +01:00
|
|
|
<td class="summary">Get the sink's position</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2022-05-23 21:27:05 +01:00
|
|
|
<td class="name" ><a href="#Sink:SetPosition">Sink:SetPosition(position)</a></td>
|
2022-04-10 00:38:39 +01:00
|
|
|
<td class="summary">Set the sink's position</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2022-05-23 21:27:05 +01:00
|
|
|
<td class="name" ><a href="#Sink:GetName">Sink:GetName()</a></td>
|
2022-04-10 00:38:39 +01:00
|
|
|
<td class="summary">Get the sink's unique string identifier
|
|
|
|
|
e.g.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2022-05-23 21:27:05 +01:00
|
|
|
<td class="name" ><a href="#Sink:SetName">Sink:SetName(name)</a></td>
|
2022-04-10 00:38:39 +01:00
|
|
|
<td class="summary">Set the sink's name (its unique string identifier)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2022-05-23 21:27:05 +01:00
|
|
|
<td class="name" ><a href="#Sink:GetStrength">Sink:GetStrength()</a></td>
|
2022-04-10 00:38:39 +01:00
|
|
|
<td class="summary">Get the sink's strength</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2022-05-23 21:27:05 +01:00
|
|
|
<td class="name" ><a href="#Sink:SetStrength">Sink:SetStrength(strength)</a></td>
|
2022-04-10 00:38:39 +01:00
|
|
|
<td class="summary">Set the strength of the sink
|
|
|
|
|
Higher numbers provide stronger currents.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
|
|
|
|
|
|
|
|
|
<dl class="function">
|
|
|
|
|
<dt>
|
2022-05-23 21:27:05 +01:00
|
|
|
<a name = "Sink:GetPosition"></a>
|
|
|
|
|
<strong>Sink:GetPosition()</strong>
|
2022-04-10 00:38:39 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Get the sink's position
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
|
2022-04-10 00:38:39 +01:00
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
2022-12-11 18:40:31 +00:00
|
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
2022-04-10 00:38:39 +01:00
|
|
|
a copy of the sink's position
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2022-05-23 21:27:05 +01:00
|
|
|
<a name = "Sink:SetPosition"></a>
|
|
|
|
|
<strong>Sink:SetPosition(position)</strong>
|
2022-04-10 00:38:39 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Set the sink's position
|
|
|
|
|
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
|
2022-04-10 00:38:39 +01:00
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">position</span>
|
2022-12-11 18:40:31 +00:00
|
|
|
<span class="types"><a class="type" href="../3 primitive classes/Vec3.html#">Vec3</a></span>
|
2022-04-10 00:38:39 +01:00
|
|
|
the new position of the sink
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2022-05-23 21:27:05 +01:00
|
|
|
<a name = "Sink:GetName"></a>
|
|
|
|
|
<strong>Sink:GetName()</strong>
|
2022-04-10 00:38:39 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Get the sink's unique string identifier
|
|
|
|
|
e.g. "strong_river_current" or "propeller_death_sink"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
|
2022-04-10 00:38:39 +01:00
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
2022-11-18 15:34:45 +00:00
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
2022-04-10 00:38:39 +01:00
|
|
|
the sink's name
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2022-05-23 21:27:05 +01:00
|
|
|
<a name = "Sink:SetName"></a>
|
|
|
|
|
<strong>Sink:SetName(name)</strong>
|
2022-04-10 00:38:39 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Set the sink's name (its unique string identifier)
|
|
|
|
|
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
|
2022-04-10 00:38:39 +01:00
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">name</span>
|
2022-11-18 15:34:45 +00:00
|
|
|
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
|
2022-04-10 00:38:39 +01:00
|
|
|
The sink's new name
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2022-05-23 21:27:05 +01:00
|
|
|
<a name = "Sink:GetStrength"></a>
|
|
|
|
|
<strong>Sink:GetStrength()</strong>
|
2022-04-10 00:38:39 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Get the sink's strength
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
|
2022-04-10 00:38:39 +01:00
|
|
|
<h3>Returns:</h3>
|
|
|
|
|
<ol>
|
|
|
|
|
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
the sink's current strength
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
<dt>
|
2022-05-23 21:27:05 +01:00
|
|
|
<a name = "Sink:SetStrength"></a>
|
|
|
|
|
<strong>Sink:SetStrength(strength)</strong>
|
2022-04-10 00:38:39 +01:00
|
|
|
</dt>
|
|
|
|
|
<dd>
|
|
|
|
|
Set the strength of the sink
|
|
|
|
|
Higher numbers provide stronger currents. Will be clamped to [1, 32].
|
|
|
|
|
|
|
|
|
|
|
2022-12-09 22:08:16 +00:00
|
|
|
|
2022-04-10 00:38:39 +01:00
|
|
|
<h3>Parameters:</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><span class="parameter">strength</span>
|
|
|
|
|
<span class="types"><span class="type">int</span></span>
|
|
|
|
|
The sink's new strength
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
|
|
|
</div> <!-- id="main" -->
|
|
|
|
|
<div id="about">
|
2022-08-08 23:31:09 +01:00
|
|
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
2022-12-16 18:36:42 +00:00
|
|
|
<i style="float:right;">Last updated 2022-12-16 18:35:53 </i>
|
2022-04-10 00:38:39 +01:00
|
|
|
</div> <!-- id="about" -->
|
|
|
|
|
</div> <!-- id="container" -->
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
