mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-13 05:57:05 +03:00
173 lines
3.8 KiB
HTML
173 lines
3.8 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>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>
|