2016-01-16 22:15:15 +01:00

193 lines
5.9 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>
</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><a href="../modules/wallmountedutil.html">wallmountedutil</a></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><strong>minetestex</strong></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>minetestex</code></h1>
<p>Provides various extensions to the builtin functions.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#handle_node_drops">handle_node_drops (position, drops, player)</a></td>
<td class="summary">The handler that is used for invoking the registered node drop functions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#init">init ()</a></td>
<td class="summary">Initializes the node drops system.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#register_on_nodedrops">register_on_nodedrops (handler)</a></td>
<td class="summary">Registers the given handler for node drops.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "handle_node_drops"></a>
<strong>handle_node_drops (position, drops, player)</strong>
</dt>
<dd>
The handler that is used for invoking the registered node drop functions.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">position</span>
The position at which the drop occurred.
</li>
<li><span class="parameter">drops</span>
The drops that are being dropped, a list of ItemStacks.
</li>
<li><span class="parameter">player</span>
The player which the event originated at.
</li>
</ul>
</dd>
<dt>
<a name = "init"></a>
<strong>init ()</strong>
</dt>
<dd>
Initializes the node drops system. This is an internal function and should
not be called from clients.
</dd>
<dt>
<a name = "register_on_nodedrops"></a>
<strong>register_on_nodedrops (handler)</strong>
</dt>
<dd>
Registers the given handler for node drops.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">handler</span>
The handler function. The function is assumed to take four
parameters, the position at which the drops occurred,
the drops which are dropped as list if ItemStacks, the player
with which the even originated and if the event has been
handled so far or not. Can return a boolean if the event
has been handled. The handled flag is used to indicate
wether the builtin functionality should be invoked or not.
That means that if the last handler returns true, the items
will not be added to the players inventory by default. By
default the handler should return the given handled parameter
to not change the state or return the desired state.
</li>
</ul>
</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>