<!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>Cleaner mod for Minetest</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
<link rel="icon" href="https://www.minetest.net/media/icon.svg" type="image/png" />
</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>Cleaner <span style="font-size:12pt;">(v1.3-dev)</span></h1>
<img src="../data/cleaner_pencil.png" />
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Unsafe_Methods">Unsafe Methods </a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="../topics/settings.html">settings</a></li>
<li><strong>api</strong></li>
<li><a href="../topics/commands.html">commands</a></li>
<li><a href="../topics/tools.html">tools</a></li>
<li><a href="../topics/config.html">config</a></li>
</ul>
</div>
<div id="content">
<h1>Topic <code>api</code></h1>
<p>Cleaner API</p>
<p>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#cleaner.get_replace_items">cleaner.get_replace_items ()</a></td>
<td class="summary">Retrieves list of items to be replaced.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.get_replace_nodes">cleaner.get_replace_nodes ()</a></td>
<td class="summary">Retrieves list of nodes to be replaced.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.register_entity_removal">cleaner.register_entity_removal (src)</a></td>
<td class="summary">Registers an entity to be removed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.register_node_removal">cleaner.register_node_removal (src)</a></td>
<td class="summary">Registers a node to be removed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.replace_item">cleaner.replace_item (src, tgt[, update_players])</a></td>
<td class="summary">Replaces an item with another registered item.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.register_item_replacement">cleaner.register_item_replacement (src, tgt)</a></td>
<td class="summary">Registeres an item to be replaced.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.register_node_replacement">cleaner.register_node_replacement (src, tgt)</a></td>
<td class="summary">Registers a node to be replaced.</td>
</tr>
</table>
<h2><a href="#Unsafe_Methods">Unsafe Methods </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#cleaner.get_remove_ores">cleaner.get_remove_ores ()</a></td>
<td class="summary">Retrieves list of ores to be removed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.register_ore_removal">cleaner.register_ore_removal (src)</a></td>
<td class="summary">Registers an ore to be removed after server startup.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#cleaner.remove_ore">cleaner.remove_ore (src)</a></td>
<td class="summary">Removes an ore definition.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "cleaner.get_replace_items"></a>
<strong>cleaner.get_replace_items ()</strong>
</dt>
<dd>
Retrieves list of items to be replaced.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
Items to be replaced.
</ol>
</dd>
<dt>
<a name = "cleaner.get_replace_nodes"></a>
<strong>cleaner.get_replace_nodes ()</strong>
</dt>
<dd>
Retrieves list of nodes to be replaced.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
Nodes to be replaced.
</ol>
</dd>
<dt>
<a name = "cleaner.register_entity_removal"></a>
<strong>cleaner.register_entity_removal (src)</strong>
</dt>
<dd>
Registers an entity to be removed.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Entity technical name.
</li>
</ul>
</dd>
<dt>
<a name = "cleaner.register_node_removal"></a>
<strong>cleaner.register_node_removal (src)</strong>
</dt>
<dd>
Registers a node to be removed.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Node technical name.
</li>
</ul>
</dd>
<dt>
<a name = "cleaner.replace_item"></a>
<strong>cleaner.replace_item (src, tgt[, update_players])</strong>
</dt>
<dd>
Replaces an item with another registered item.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Technical name of item to be replaced.
</li>
<li><span class="parameter">tgt</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Technical name of item to be used in place.
</li>
<li><span class="parameter">update_players</span>
<span class="types"><span class="type">bool</span></span>
<code>true</code> updates inventory lists associated with players (default: <code>false</code>).
(<em>optional</em>)
</li>
</ul>
</dd>
<dt>
<a name = "cleaner.register_item_replacement"></a>
<strong>cleaner.register_item_replacement (src, tgt)</strong>
</dt>
<dd>
Registeres an item to be replaced.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Technical name of item to be replaced.
</li>
<li><span class="parameter">tgt</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Technical name of item to be used in place.
</li>
</ul>
</dd>
<dt>
<a name = "cleaner.register_node_replacement"></a>
<strong>cleaner.register_node_replacement (src, tgt)</strong>
</dt>
<dd>
Registers a node to be replaced.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Technical name of node to be replaced.
</li>
<li><span class="parameter">tgt</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Technical name of node to be used in place.
</li>
</ul>
</dd>
</dl>
<h2 class="section-header has-description"><a name="Unsafe_Methods"></a>Unsafe Methods </h2>
<div class="section-description">
Enabled with <a href="settings.html#cleaner.unsafe">cleaner.unsafe</a> setting.
</div>
<dl class="function">
<dt>
<a name = "cleaner.get_remove_ores"></a>
<strong>cleaner.get_remove_ores ()</strong>
</dt>
<dd>
Retrieves list of ores to be removed.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
Ores to be removed.
</ol>
</dd>
<dt>
<a name = "cleaner.register_ore_removal"></a>
<strong>cleaner.register_ore_removal (src)</strong>
</dt>
<dd>
Registers an ore to be removed after server startup.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Ore technical name.
</li>
</ul>
</dd>
<dt>
<a name = "cleaner.remove_ore"></a>
<strong>cleaner.remove_ore (src)</strong>
</dt>
<dd>
Removes an ore definition.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">src</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
Ore technical name.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2021-08-16 09:32:17 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>