501 lines
11 KiB
HTML
501 lines
11 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>utils</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>utils</h1>
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Functions">Functions</a></li>
|
|
<li><a href="#Tables">Tables</a></li>
|
|
<li><a href="#Fields">Fields</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Modules</h2>
|
|
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
|
<li><a href="../modules/stringutil.html">stringutil</a></li>
|
|
<li><a href="../modules/random.html">random</a></li>
|
|
<li><a href="../modules/noisemanager.html">noisemanager</a></li>
|
|
<li><a href="../modules/nodeutil.html">nodeutil</a></li>
|
|
<li><a href="../modules/posutil.html">posutil</a></li>
|
|
<li><a href="../modules/objectrefutil.html">objectrefutil</a></li>
|
|
<li><a href="../modules/nodeboxutil.html">nodeboxutil</a></li>
|
|
<li><a href="../modules/mapmanipulator.html">mapmanipulator</a></li>
|
|
<li><a href="../modules/fisheryates.html">fisheryates</a></li>
|
|
<li><a href="../modules/textureutil.html">textureutil</a></li>
|
|
<li><a href="../modules/blockutil.html">blockutil</a></li>
|
|
<li><a href="../modules/tango.html">tango</a></li>
|
|
<li><a href="../modules/arraymanipulator.html">arraymanipulator</a></li>
|
|
<li><a href="../modules/inventoryutil.html">inventoryutil</a></li>
|
|
<li><a href="../modules/entityutil.html">entityutil</a></li>
|
|
<li><a href="../modules/scheduler.html">scheduler</a></li>
|
|
<li><a href="../modules/blockedcache.html">blockedcache</a></li>
|
|
<li><a href="../modules/mathutil.html">mathutil</a></li>
|
|
<li><a href="../modules/log.html">log</a></li>
|
|
<li><a href="../modules/arrayutil.html">arrayutil</a></li>
|
|
<li><a href="../modules/directmapmanipulator.html">directmapmanipulator</a></li>
|
|
<li><a href="../modules/rotationutil.html">rotationutil</a></li>
|
|
<li><a href="../modules/settings.html">settings</a></li>
|
|
<li><a href="../modules/pathutil.html">pathutil</a></li>
|
|
<li><strong>wallmountedutil</strong></li>
|
|
<li><a href="../modules/interpolate.html">interpolate</a></li>
|
|
<li><a href="../modules/transform.html">transform</a></li>
|
|
<li><a href="../modules/numberutil.html">numberutil</a></li>
|
|
<li><a href="../modules/test.html">test</a></li>
|
|
<li><a href="../modules/facedirutil.html">facedirutil</a></li>
|
|
<li><a href="../modules/constants.html">constants</a></li>
|
|
<li><a href="../modules/minetestex.html">minetestex</a></li>
|
|
<li><a href="../modules/list.html">list</a></li>
|
|
<li><a href="../modules/stopwatch.html">stopwatch</a></li>
|
|
<li><a href="../modules/itemutil.html">itemutil</a></li>
|
|
<li><a href="../modules/color.html">color</a></li>
|
|
<li><a href="../modules/tableutil.html">tableutil</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Module <code>wallmountedutil</code></h1>
|
|
<p>Various functions and constants for working with the wallmounted
|
|
value.</p>
|
|
<p></p>
|
|
|
|
|
|
<h2><a href="#Functions">Functions</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#get_vector">get_vector (id)</a></td>
|
|
<td class="summary">Gets the vector for the given ID.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#is_wallmounted">is_wallmounted (node)</a></td>
|
|
<td class="summary">Checks if the given node is mounted to a wall or the ceiling.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#to_facedir">to_facedir (wallmounted_id)</a></td>
|
|
<td class="summary">Gets the corresponding facedir value for the given wallmounted value.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Tables">Tables</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#NEGATIVE_X_VECTOR">NEGATIVE_X_VECTOR</a></td>
|
|
<td class="summary">The vector for the negative x direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#NEGATIVE_Y_VECTOR">NEGATIVE_Y_VECTOR</a></td>
|
|
<td class="summary">The vector for the negative y direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#NEGATIVE_Z_VECTOR">NEGATIVE_Z_VECTOR</a></td>
|
|
<td class="summary">The vector for the negative z direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#POSITIVE_X_VECTOR">POSITIVE_X_VECTOR</a></td>
|
|
<td class="summary">The vector for the positive x direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#POSITIVE_Y_VECTOR">POSITIVE_Y_VECTOR</a></td>
|
|
<td class="summary">The vector for the positive y direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#POSITIVE_Z_VECTOR">POSITIVE_Z_VECTOR</a></td>
|
|
<td class="summary">The vector for the positive z direction.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Fields">Fields</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#NEGATIVE_X">NEGATIVE_X</a></td>
|
|
<td class="summary">Attached to the node in the negative x direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#NEGATIVE_Y">NEGATIVE_Y</a></td>
|
|
<td class="summary">Attached to the node in the negative y direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#NEGATIVE_Z">NEGATIVE_Z</a></td>
|
|
<td class="summary">Attached to the node in the negative z direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#POSITIVE_X">POSITIVE_X</a></td>
|
|
<td class="summary">Attached to the node in the positive y direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#POSITIVE_Y">POSITIVE_Y</a></td>
|
|
<td class="summary">Attached to the node in the positive y direction.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#POSITIVE_Z">POSITIVE_Z</a></td>
|
|
<td class="summary">Attached to the node in the positive y direction.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="Functions"></a>Functions</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "get_vector"></a>
|
|
<strong>get_vector (id)</strong>
|
|
</dt>
|
|
<dd>
|
|
Gets the vector for the given ID.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">id</span>
|
|
The ID for which to get the vector.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
The vector for the given ID.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "is_wallmounted"></a>
|
|
<strong>is_wallmounted (node)</strong>
|
|
</dt>
|
|
<dd>
|
|
Checks if the given node is mounted to a wall or the ceiling.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">node</span>
|
|
The node.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
true if the node is mounted at a wall or ceiling, false if it
|
|
is mounted on the floor.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "to_facedir"></a>
|
|
<strong>to_facedir (wallmounted_id)</strong>
|
|
</dt>
|
|
<dd>
|
|
Gets the corresponding facedir value for the given wallmounted value.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">wallmounted_id</span>
|
|
The wallmounted value/ID.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
The facedir value/ID.
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Tables"></a>Tables</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "NEGATIVE_X_VECTOR"></a>
|
|
<strong>NEGATIVE_X_VECTOR</strong>
|
|
</dt>
|
|
<dd>
|
|
The vector for the negative x direction.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">z</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "NEGATIVE_Y_VECTOR"></a>
|
|
<strong>NEGATIVE_Y_VECTOR</strong>
|
|
</dt>
|
|
<dd>
|
|
The vector for the negative y direction.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">z</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "NEGATIVE_Z_VECTOR"></a>
|
|
<strong>NEGATIVE_Z_VECTOR</strong>
|
|
</dt>
|
|
<dd>
|
|
The vector for the negative z direction.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">z</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "POSITIVE_X_VECTOR"></a>
|
|
<strong>POSITIVE_X_VECTOR</strong>
|
|
</dt>
|
|
<dd>
|
|
The vector for the positive x direction.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">z</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "POSITIVE_Y_VECTOR"></a>
|
|
<strong>POSITIVE_Y_VECTOR</strong>
|
|
</dt>
|
|
<dd>
|
|
The vector for the positive y direction.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">z</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "POSITIVE_Z_VECTOR"></a>
|
|
<strong>POSITIVE_Z_VECTOR</strong>
|
|
</dt>
|
|
<dd>
|
|
The vector for the positive z direction.
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">x</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">y</span>
|
|
|
|
</li>
|
|
<li><span class="parameter">z</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Fields"></a>Fields</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "NEGATIVE_X"></a>
|
|
<strong>NEGATIVE_X</strong>
|
|
</dt>
|
|
<dd>
|
|
Attached to the node in the negative x direction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "NEGATIVE_Y"></a>
|
|
<strong>NEGATIVE_Y</strong>
|
|
</dt>
|
|
<dd>
|
|
Attached to the node in the negative y direction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "NEGATIVE_Z"></a>
|
|
<strong>NEGATIVE_Z</strong>
|
|
</dt>
|
|
<dd>
|
|
Attached to the node in the negative z direction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "POSITIVE_X"></a>
|
|
<strong>POSITIVE_X</strong>
|
|
</dt>
|
|
<dd>
|
|
Attached to the node in the positive y direction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "POSITIVE_Y"></a>
|
|
<strong>POSITIVE_Y</strong>
|
|
</dt>
|
|
<dd>
|
|
Attached to the node in the positive y direction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "POSITIVE_Z"></a>
|
|
<strong>POSITIVE_Z</strong>
|
|
</dt>
|
|
<dd>
|
|
Attached to the node in the positive y direction.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|