mirror of
https://codeberg.org/AntumLuanti/mod-cleaner.git
synced 2025-03-15 04:41:22 +00:00
deploy: b261dda15c
This commit is contained in:
AntumDeluge
parent
bb73ed928b
commit
854c576ca5
41 changed files with 6963 additions and 91 deletions
|
Before Width: | Height: | Size: 255 B After Width: | Height: | Size: 255 B |
82
reference/current/index.html
Normal file
82
reference/current/index.html
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
<!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" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="topics/api.html">api</a></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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<table class="module_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
||||||
|
<td class="summary">Cleaner Settings</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||||
|
<td class="summary">Cleaner API</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
||||||
|
<td class="summary">Cleaner Chat Commands</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/tools.html">tools</a></td>
|
||||||
|
<td class="summary">Cleaner Tools</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/config.html">config</a></td>
|
||||||
|
<td class="summary">World Path Configuration</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
</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>
|
||||||
439
reference/current/topics/api.html
Normal file
439
reference/current/topics/api.html
Normal file
|
|
@ -0,0 +1,439 @@
|
||||||
|
<!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>
|
||||||
470
reference/current/topics/commands.html
Normal file
470
reference/current/topics/commands.html
Normal file
|
|
@ -0,0 +1,470 @@
|
||||||
|
<!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="#Chat_Commands">Chat Commands</a></li>
|
||||||
|
<li><a href="#Unsafe_Commands">Unsafe Commands </a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><strong>commands</strong></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>commands</code></h1>
|
||||||
|
<p>Cleaner Chat Commands</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Chat_Commands">Chat Commands</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_entities">remove_entities <entity> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby entities.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_nodes">remove_nodes <node> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_items">replace_items <old_item> <new_item></a></td>
|
||||||
|
<td class="summary">Replaces an item.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_nodes">replace_nodes <old_node> <new_node> [radius]</a></td>
|
||||||
|
<td class="summary">Replaces nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_unknown_nodes">find_unknown_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Checks for nearby unknown nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_nearby_nodes">find_nearby_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Finds names of nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#ctool">ctool <action> <value></a></td>
|
||||||
|
<td class="summary">Manages settings for wielded <a href="tools.html">cleaner tool</a>.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Unsafe_Commands">Unsafe Commands </a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_ores">remove_ores <ore></a></td>
|
||||||
|
<td class="summary">Registers an ore to be removed.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Chat_Commands"></a>Chat Commands</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_entities <entity> [radius]"></a>
|
||||||
|
<strong>remove_entities <entity> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby entities. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">entity</span> Entity technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all mobs:horse entities within a radius of <span class="number">10</span> nodes
|
||||||
|
/remove_entities mobs:horse <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_nodes <node> [radius]"></a>
|
||||||
|
<strong>remove_nodes <node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span> Node technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all default:dirt nodes within a radius of <span class="number">10</span>
|
||||||
|
/remove_nodes default:dirt <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_items <old_item> <new_item>"></a>
|
||||||
|
<strong>replace_items <old_item> <new_item></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces an item. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_item</span> Technical name of item to replace.</li>
|
||||||
|
<li><span class="parameter">new_item</span> Technical name of item to be used in place.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace default:sword_wood with default:sword_mese
|
||||||
|
/replace_items default:sword_wood default:sword_mese</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_nodes <old_node> <new_node> [radius]"></a>
|
||||||
|
<strong>replace_nodes <old_node> <new_node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_node</span> Technical name of node to replace.</li>
|
||||||
|
<li><span class="parameter">new_node</span> Technical name of node to be used in place.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace all default:dirt nodes with default:cobble within a radius of <span class="number">10</span>
|
||||||
|
/replace_nodes default:dirt default:cobble <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_unknown_nodes [radius]"></a>
|
||||||
|
<strong>find_unknown_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Checks for nearby unknown nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all unknown nodes within radius of <span class="number">10</span>
|
||||||
|
/find_unknown_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_nearby_nodes [radius]"></a>
|
||||||
|
<strong>find_nearby_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Finds names of nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all node types found within radius of <span class="number">10</span>
|
||||||
|
/find_nearby_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "ctool <action> <value>"></a>
|
||||||
|
<strong>ctool <action> <value></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Manages settings for wielded <a href="tools.html">cleaner tool</a>. </p>
|
||||||
|
|
||||||
|
<p> <h3>Required Privileges:</h3></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action</span> Action to execute. Can be "status", "setmode", or "setnode".</li>
|
||||||
|
<li><span class="parameter">value</span> Mode or node to be set for tool (not required for "status" action).</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="keyword">while</span> cleaner:pencil is wielded, configure to place default:dirt node when used
|
||||||
|
/ctool setmode write
|
||||||
|
/ctool setnode default:dirt</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header has-description"><a name="Unsafe_Commands"></a>Unsafe Commands </h2>
|
||||||
|
|
||||||
|
<div class="section-description">
|
||||||
|
Enabled with <a href="settings.html#cleaner.unsafe">cleaner.unsafe</a> setting.
|
||||||
|
</div>
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_ores <ore>"></a>
|
||||||
|
<strong>remove_ores <ore></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Registers an ore to be removed. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">ore</span> Ore technical name.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Notes:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><em>This action is reverted after server restart. To make changes permanent,
|
||||||
|
use the <a href="config.html#cleaner.json">cleaner.json</a> config.</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all registered ores that add default:stone_with_iron to world
|
||||||
|
/remove_ores default:stone_with_iron</pre>
|
||||||
|
</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>
|
||||||
159
reference/current/topics/config.html
Normal file
159
reference/current/topics/config.html
Normal file
|
|
@ -0,0 +1,159 @@
|
||||||
|
<!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="#JSON_Configurations">JSON Configurations</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><a href="../topics/tools.html">tools</a></li>
|
||||||
|
<li><strong>config</strong></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>config</code></h1>
|
||||||
|
<p>World Path Configuration</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#JSON_Configurations">JSON Configurations</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.json">cleaner.json</a></td>
|
||||||
|
<td class="summary">Main configuration file.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="JSON_Configurations"></a>JSON Configurations</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.json"></a>
|
||||||
|
<strong>cleaner.json</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Main configuration file. </p>
|
||||||
|
|
||||||
|
<p> Registering items, entities, etc. for cleaning can be done in <strong><em>cleaner.json</em></strong>
|
||||||
|
in the world directory (<code><world_path>/cleaner.json</code>). If it does not exist
|
||||||
|
it will be created automatically when the server is started.</p>
|
||||||
|
|
||||||
|
<p> It is formatted as follows:</p>
|
||||||
|
|
||||||
|
<pre><code>{
|
||||||
|
"entities" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
},
|
||||||
|
"items" :
|
||||||
|
{
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"nodes" :
|
||||||
|
{
|
||||||
|
"remove" : [],
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"ores" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p> <code>remove</code> key works for nodes, entities, & ores. <code>replace</code> key works for
|
||||||
|
nodes & items. Their functions are self-explanatory.
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">Cleaning nodes example:
|
||||||
|
{
|
||||||
|
<span class="string">"nodes"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"remove"</span> :
|
||||||
|
[
|
||||||
|
<span class="string">"old:node_1"</span>,
|
||||||
|
<span class="string">"old:node_2"</span>,
|
||||||
|
],
|
||||||
|
<span class="string">"replace"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"old:node_3"</span> : <span class="string">"new:node_1"</span>,
|
||||||
|
<span class="string">"old:node_4"</span> : <span class="string">"new:node_2"</span>,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}</pre>
|
||||||
|
</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>
|
||||||
125
reference/current/topics/settings.html
Normal file
125
reference/current/topics/settings.html
Normal file
|
|
@ -0,0 +1,125 @@
|
||||||
|
<!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="#Settings">Settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><strong>settings</strong></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></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>settings</code></h1>
|
||||||
|
<p>Cleaner Settings</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Settings">Settings</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.unsafe">cleaner.unsafe</a></td>
|
||||||
|
<td class="summary">Enables unsafe methods & chat commands.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Settings"></a>Settings</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.unsafe"></a>
|
||||||
|
<strong>cleaner.unsafe</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Enables unsafe methods & chat commands. </p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><code>cleaner.remove_ore</code></li>
|
||||||
|
<li><code>/remove_ores</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p><strong>Definition:</strong></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span style="font-size:80%;"><code>type:</code></span> <code>bool</code></li>
|
||||||
|
<li><span style="font-size:80%;"><code>default:</code></span> <code>false</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
133
reference/current/topics/tools.html
Normal file
133
reference/current/topics/tools.html
Normal file
|
|
@ -0,0 +1,133 @@
|
||||||
|
<!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="#Tools">Tools</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><strong>tools</strong></li>
|
||||||
|
<li><a href="../topics/config.html">config</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>tools</code></h1>
|
||||||
|
<p>Cleaner Tools</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Tools">Tools</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner:pencil">cleaner:pencil</a></td>
|
||||||
|
<td class="summary">Master Pencil</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Tools"></a>Tools</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner:pencil"></a>
|
||||||
|
<strong>cleaner:pencil</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Master Pencil </p>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
<h3>Image:</h3>
|
||||||
|
<ul>
|
||||||
|
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">place (right-click):
|
||||||
|
- when <span class="keyword">not</span> pointing at a node, changes modes
|
||||||
|
- when pointing at a node, sets node to be used
|
||||||
|
|
||||||
|
use (left-click):
|
||||||
|
- executes action <span class="keyword">for</span> current mode:
|
||||||
|
- erase: erases pointed node
|
||||||
|
- write: adds node
|
||||||
|
- swap: replaces pointed node</pre>
|
||||||
|
</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>
|
||||||
|
|
@ -1,82 +1,14 @@
|
||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
||||||
<html>
|
<html>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
<head></head>
|
||||||
<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>
|
<body>
|
||||||
|
|
||||||
<div id="container">
|
<ul>
|
||||||
|
<li><a href="current/">current</a></li>
|
||||||
<div id="product">
|
<li><a href="latest/">latest</a></li>
|
||||||
<div id="product_logo"></div>
|
<li><a href="v1.3-dev/">v1.3-dev</a></li>
|
||||||
<div id="product_name"><big><b></b></big></div>
|
<li><a href="v1.2.1/">v1.2.1</a></li>
|
||||||
<div id="product_description"></div>
|
<li><a href="v1.2/">v1.2</a></li>
|
||||||
</div> <!-- id="product" -->
|
|
||||||
|
|
||||||
|
|
||||||
<div id="main">
|
|
||||||
|
|
||||||
|
|
||||||
<!-- Menu -->
|
|
||||||
|
|
||||||
<div id="navigation">
|
|
||||||
<br/>
|
|
||||||
<h1>Cleaner</h1>
|
|
||||||
|
|
||||||
<img src="data/cleaner_pencil.png" />
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Topics</h2>
|
|
||||||
<ul class="">
|
|
||||||
<li><a href="topics/settings.html">settings</a></li>
|
|
||||||
<li><a href="topics/api.html">api</a></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>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</body></html>
|
||||||
|
|
||||||
<div id="content">
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h2>Topics</h2>
|
|
||||||
<table class="module_list">
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
|
||||||
<td class="summary">Cleaner Settings</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
|
||||||
<td class="summary">Cleaner API</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
|
||||||
<td class="summary">Cleaner Chat Commands</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="topics/tools.html">tools</a></td>
|
|
||||||
<td class="summary">Cleaner Tools</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td class="name" nowrap><a href="topics/config.html">config</a></td>
|
|
||||||
<td class="summary">World Path Configuration</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
</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-15 05:02:04 </i>
|
|
||||||
</div> <!-- id="about" -->
|
|
||||||
</div> <!-- id="container" -->
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
|
||||||
BIN
reference/latest/data/cleaner_pencil.png
Normal file
BIN
reference/latest/data/cleaner_pencil.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 255 B |
82
reference/latest/index.html
Normal file
82
reference/latest/index.html
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
<!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" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="topics/api.html">api</a></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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<table class="module_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
||||||
|
<td class="summary">Cleaner Settings</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||||
|
<td class="summary">Cleaner API</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
||||||
|
<td class="summary">Cleaner Chat Commands</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/tools.html">tools</a></td>
|
||||||
|
<td class="summary">Cleaner Tools</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/config.html">config</a></td>
|
||||||
|
<td class="summary">World Path Configuration</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
</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>
|
||||||
307
reference/latest/ldoc.css
Normal file
307
reference/latest/ldoc.css
Normal file
|
|
@ -0,0 +1,307 @@
|
||||||
|
/* BEGIN RESET
|
||||||
|
|
||||||
|
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||||
|
Code licensed under the BSD License:
|
||||||
|
http://developer.yahoo.com/yui/license.html
|
||||||
|
version: 2.8.2r1
|
||||||
|
*/
|
||||||
|
html {
|
||||||
|
color: #000;
|
||||||
|
background: #FFF;
|
||||||
|
}
|
||||||
|
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0;
|
||||||
|
}
|
||||||
|
fieldset,img {
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
del,ins {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
li {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
caption,th {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
h1,h2,h3,h4,h5,h6 {
|
||||||
|
font-size: 100%;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
q:before,q:after {
|
||||||
|
content: '';
|
||||||
|
}
|
||||||
|
abbr,acronym {
|
||||||
|
border: 0;
|
||||||
|
font-variant: normal;
|
||||||
|
}
|
||||||
|
sup {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
sub {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
legend {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
input,button,textarea,select,optgroup,option {
|
||||||
|
font-family: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
input,button,textarea,select {*font-size:100%;
|
||||||
|
}
|
||||||
|
/* END RESET */
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
font-family: arial, helvetica, geneva, sans-serif;
|
||||||
|
background-color: #ffffff; margin: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||||
|
span.parameter { font-family:monospace; }
|
||||||
|
span.parameter:after { content:":"; }
|
||||||
|
span.types:before { content:"("; }
|
||||||
|
span.types:after { content:")"; }
|
||||||
|
.type { font-weight: bold; font-style:italic }
|
||||||
|
|
||||||
|
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||||
|
|
||||||
|
p, ul { margin: 10px 0 0 0px;}
|
||||||
|
|
||||||
|
strong { font-weight: bold;}
|
||||||
|
|
||||||
|
em { font-style: italic;}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 1.5em;
|
||||||
|
margin: 20px 0 20px 0;
|
||||||
|
}
|
||||||
|
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||||
|
h2 { font-size: 1.25em; }
|
||||||
|
h3 { font-size: 1.15em; }
|
||||||
|
h4 { font-size: 1.06em; }
|
||||||
|
|
||||||
|
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||||
|
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||||
|
a:link:hover { text-decoration: underline; }
|
||||||
|
|
||||||
|
hr {
|
||||||
|
color:#cccccc;
|
||||||
|
background: #00007f;
|
||||||
|
height: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote { margin-left: 3em; }
|
||||||
|
|
||||||
|
ul { list-style-type: disc; }
|
||||||
|
|
||||||
|
p.name {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
padding-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
background-color: rgb(245, 245, 245);
|
||||||
|
border: 1px solid #C0C0C0; /* silver */
|
||||||
|
padding: 10px;
|
||||||
|
margin: 10px 0 10px 0;
|
||||||
|
overflow: auto;
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.example {
|
||||||
|
font-size: .85em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.index { border: 1px #00007f; }
|
||||||
|
table.index td { text-align: left; vertical-align: top; }
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product {
|
||||||
|
text-align: center;
|
||||||
|
border-bottom: 1px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product big {
|
||||||
|
font-size: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
float: left;
|
||||||
|
width: 14em;
|
||||||
|
max-height: 96.7%;
|
||||||
|
position: fixed;
|
||||||
|
vertical-align: top;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
overflow-x: hidden;
|
||||||
|
overflow-y: scroll;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation h2 {
|
||||||
|
background-color:#e7e7e7;
|
||||||
|
font-size:1.1em;
|
||||||
|
color:#000000;
|
||||||
|
text-align: left;
|
||||||
|
padding:0.2em;
|
||||||
|
border-top:1px solid #dddddd;
|
||||||
|
border-bottom:1px solid #dddddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation ul
|
||||||
|
{
|
||||||
|
font-size:1em;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 1px 1px 10px 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li {
|
||||||
|
text-indent: -1em;
|
||||||
|
display: block;
|
||||||
|
margin: 3px 0px 0px 22px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li li a {
|
||||||
|
margin: 0px 3px 0px -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
margin-left: 14em;
|
||||||
|
padding: 1em;
|
||||||
|
width: 700px;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
border-right: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
min-height: 425px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#about {
|
||||||
|
clear: both;
|
||||||
|
padding: 5px;
|
||||||
|
border-top: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
body {
|
||||||
|
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||||
|
}
|
||||||
|
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #ffffff;
|
||||||
|
border-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 2%;
|
||||||
|
margin-right: 2%;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
padding: 1em;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
pre.example {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
font-size: 10pt;
|
||||||
|
page-break-inside: avoid;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
table.module_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.module_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.module_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
|
||||||
|
table.function_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.function_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.function_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
ul.nowrap {
|
||||||
|
overflow:auto;
|
||||||
|
white-space:nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||||
|
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||||
|
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||||
|
|
||||||
|
/* stop sublists from having initial vertical space */
|
||||||
|
ul ul { margin-top: 0px; }
|
||||||
|
ol ul { margin-top: 0px; }
|
||||||
|
ol ol { margin-top: 0px; }
|
||||||
|
ul ol { margin-top: 0px; }
|
||||||
|
|
||||||
|
/* make the target distinct; helps when we're navigating to a function */
|
||||||
|
a:target + * {
|
||||||
|
background-color: #FF9;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* styles for prettification of source */
|
||||||
|
pre .comment { color: #558817; }
|
||||||
|
pre .constant { color: #a8660d; }
|
||||||
|
pre .escape { color: #844631; }
|
||||||
|
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||||
|
pre .library { color: #0e7c6b; }
|
||||||
|
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||||
|
pre .string { color: #8080ff; }
|
||||||
|
pre .number { color: #f8660d; }
|
||||||
|
pre .operator { color: #2239a8; font-weight: bold; }
|
||||||
|
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||||
|
pre .global { color: #800080; }
|
||||||
|
pre .user-keyword { color: #800080; }
|
||||||
|
pre .prompt { color: #558817; }
|
||||||
|
pre .url { color: #272fc2; text-decoration: underline; }
|
||||||
|
|
||||||
439
reference/latest/topics/api.html
Normal file
439
reference/latest/topics/api.html
Normal file
|
|
@ -0,0 +1,439 @@
|
||||||
|
<!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>
|
||||||
470
reference/latest/topics/commands.html
Normal file
470
reference/latest/topics/commands.html
Normal file
|
|
@ -0,0 +1,470 @@
|
||||||
|
<!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="#Chat_Commands">Chat Commands</a></li>
|
||||||
|
<li><a href="#Unsafe_Commands">Unsafe Commands </a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><strong>commands</strong></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>commands</code></h1>
|
||||||
|
<p>Cleaner Chat Commands</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Chat_Commands">Chat Commands</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_entities">remove_entities <entity> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby entities.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_nodes">remove_nodes <node> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_items">replace_items <old_item> <new_item></a></td>
|
||||||
|
<td class="summary">Replaces an item.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_nodes">replace_nodes <old_node> <new_node> [radius]</a></td>
|
||||||
|
<td class="summary">Replaces nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_unknown_nodes">find_unknown_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Checks for nearby unknown nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_nearby_nodes">find_nearby_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Finds names of nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#ctool">ctool <action> <value></a></td>
|
||||||
|
<td class="summary">Manages settings for wielded <a href="tools.html">cleaner tool</a>.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Unsafe_Commands">Unsafe Commands </a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_ores">remove_ores <ore></a></td>
|
||||||
|
<td class="summary">Registers an ore to be removed.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Chat_Commands"></a>Chat Commands</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_entities <entity> [radius]"></a>
|
||||||
|
<strong>remove_entities <entity> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby entities. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">entity</span> Entity technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all mobs:horse entities within a radius of <span class="number">10</span> nodes
|
||||||
|
/remove_entities mobs:horse <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_nodes <node> [radius]"></a>
|
||||||
|
<strong>remove_nodes <node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span> Node technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all default:dirt nodes within a radius of <span class="number">10</span>
|
||||||
|
/remove_nodes default:dirt <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_items <old_item> <new_item>"></a>
|
||||||
|
<strong>replace_items <old_item> <new_item></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces an item. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_item</span> Technical name of item to replace.</li>
|
||||||
|
<li><span class="parameter">new_item</span> Technical name of item to be used in place.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace default:sword_wood with default:sword_mese
|
||||||
|
/replace_items default:sword_wood default:sword_mese</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_nodes <old_node> <new_node> [radius]"></a>
|
||||||
|
<strong>replace_nodes <old_node> <new_node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_node</span> Technical name of node to replace.</li>
|
||||||
|
<li><span class="parameter">new_node</span> Technical name of node to be used in place.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace all default:dirt nodes with default:cobble within a radius of <span class="number">10</span>
|
||||||
|
/replace_nodes default:dirt default:cobble <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_unknown_nodes [radius]"></a>
|
||||||
|
<strong>find_unknown_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Checks for nearby unknown nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all unknown nodes within radius of <span class="number">10</span>
|
||||||
|
/find_unknown_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_nearby_nodes [radius]"></a>
|
||||||
|
<strong>find_nearby_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Finds names of nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all node types found within radius of <span class="number">10</span>
|
||||||
|
/find_nearby_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "ctool <action> <value>"></a>
|
||||||
|
<strong>ctool <action> <value></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Manages settings for wielded <a href="tools.html">cleaner tool</a>. </p>
|
||||||
|
|
||||||
|
<p> <h3>Required Privileges:</h3></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action</span> Action to execute. Can be "status", "setmode", or "setnode".</li>
|
||||||
|
<li><span class="parameter">value</span> Mode or node to be set for tool (not required for "status" action).</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="keyword">while</span> cleaner:pencil is wielded, configure to place default:dirt node when used
|
||||||
|
/ctool setmode write
|
||||||
|
/ctool setnode default:dirt</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header has-description"><a name="Unsafe_Commands"></a>Unsafe Commands </h2>
|
||||||
|
|
||||||
|
<div class="section-description">
|
||||||
|
Enabled with <a href="settings.html#cleaner.unsafe">cleaner.unsafe</a> setting.
|
||||||
|
</div>
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_ores <ore>"></a>
|
||||||
|
<strong>remove_ores <ore></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Registers an ore to be removed. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">ore</span> Ore technical name.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Notes:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><em>This action is reverted after server restart. To make changes permanent,
|
||||||
|
use the <a href="config.html#cleaner.json">cleaner.json</a> config.</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all registered ores that add default:stone_with_iron to world
|
||||||
|
/remove_ores default:stone_with_iron</pre>
|
||||||
|
</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>
|
||||||
159
reference/latest/topics/config.html
Normal file
159
reference/latest/topics/config.html
Normal file
|
|
@ -0,0 +1,159 @@
|
||||||
|
<!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="#JSON_Configurations">JSON Configurations</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><a href="../topics/tools.html">tools</a></li>
|
||||||
|
<li><strong>config</strong></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>config</code></h1>
|
||||||
|
<p>World Path Configuration</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#JSON_Configurations">JSON Configurations</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.json">cleaner.json</a></td>
|
||||||
|
<td class="summary">Main configuration file.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="JSON_Configurations"></a>JSON Configurations</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.json"></a>
|
||||||
|
<strong>cleaner.json</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Main configuration file. </p>
|
||||||
|
|
||||||
|
<p> Registering items, entities, etc. for cleaning can be done in <strong><em>cleaner.json</em></strong>
|
||||||
|
in the world directory (<code><world_path>/cleaner.json</code>). If it does not exist
|
||||||
|
it will be created automatically when the server is started.</p>
|
||||||
|
|
||||||
|
<p> It is formatted as follows:</p>
|
||||||
|
|
||||||
|
<pre><code>{
|
||||||
|
"entities" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
},
|
||||||
|
"items" :
|
||||||
|
{
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"nodes" :
|
||||||
|
{
|
||||||
|
"remove" : [],
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"ores" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p> <code>remove</code> key works for nodes, entities, & ores. <code>replace</code> key works for
|
||||||
|
nodes & items. Their functions are self-explanatory.
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">Cleaning nodes example:
|
||||||
|
{
|
||||||
|
<span class="string">"nodes"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"remove"</span> :
|
||||||
|
[
|
||||||
|
<span class="string">"old:node_1"</span>,
|
||||||
|
<span class="string">"old:node_2"</span>,
|
||||||
|
],
|
||||||
|
<span class="string">"replace"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"old:node_3"</span> : <span class="string">"new:node_1"</span>,
|
||||||
|
<span class="string">"old:node_4"</span> : <span class="string">"new:node_2"</span>,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}</pre>
|
||||||
|
</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>
|
||||||
125
reference/latest/topics/settings.html
Normal file
125
reference/latest/topics/settings.html
Normal file
|
|
@ -0,0 +1,125 @@
|
||||||
|
<!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="#Settings">Settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><strong>settings</strong></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></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>settings</code></h1>
|
||||||
|
<p>Cleaner Settings</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Settings">Settings</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.unsafe">cleaner.unsafe</a></td>
|
||||||
|
<td class="summary">Enables unsafe methods & chat commands.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Settings"></a>Settings</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.unsafe"></a>
|
||||||
|
<strong>cleaner.unsafe</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Enables unsafe methods & chat commands. </p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><code>cleaner.remove_ore</code></li>
|
||||||
|
<li><code>/remove_ores</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p><strong>Definition:</strong></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span style="font-size:80%;"><code>type:</code></span> <code>bool</code></li>
|
||||||
|
<li><span style="font-size:80%;"><code>default:</code></span> <code>false</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
133
reference/latest/topics/tools.html
Normal file
133
reference/latest/topics/tools.html
Normal file
|
|
@ -0,0 +1,133 @@
|
||||||
|
<!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="#Tools">Tools</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><strong>tools</strong></li>
|
||||||
|
<li><a href="../topics/config.html">config</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>tools</code></h1>
|
||||||
|
<p>Cleaner Tools</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Tools">Tools</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner:pencil">cleaner:pencil</a></td>
|
||||||
|
<td class="summary">Master Pencil</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Tools"></a>Tools</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner:pencil"></a>
|
||||||
|
<strong>cleaner:pencil</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Master Pencil </p>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
<h3>Image:</h3>
|
||||||
|
<ul>
|
||||||
|
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">place (right-click):
|
||||||
|
- when <span class="keyword">not</span> pointing at a node, changes modes
|
||||||
|
- when pointing at a node, sets node to be used
|
||||||
|
|
||||||
|
use (left-click):
|
||||||
|
- executes action <span class="keyword">for</span> current mode:
|
||||||
|
- erase: erases pointed node
|
||||||
|
- write: adds node
|
||||||
|
- swap: replaces pointed node</pre>
|
||||||
|
</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>
|
||||||
BIN
reference/v1.2.1/data/cleaner_pencil.png
Normal file
BIN
reference/v1.2.1/data/cleaner_pencil.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 255 B |
82
reference/v1.2.1/index.html
Normal file
82
reference/v1.2.1/index.html
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
<!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.2.1)</span></h1>
|
||||||
|
|
||||||
|
<img src="data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="topics/api.html">api</a></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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<table class="module_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
||||||
|
<td class="summary">Cleaner Settings</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||||
|
<td class="summary">Cleaner API</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
||||||
|
<td class="summary">Cleaner Chat Commands</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/tools.html">tools</a></td>
|
||||||
|
<td class="summary">Cleaner Tools</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/config.html">config</a></td>
|
||||||
|
<td class="summary">World Path Configuration</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
307
reference/v1.2.1/ldoc.css
Normal file
307
reference/v1.2.1/ldoc.css
Normal file
|
|
@ -0,0 +1,307 @@
|
||||||
|
/* BEGIN RESET
|
||||||
|
|
||||||
|
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||||
|
Code licensed under the BSD License:
|
||||||
|
http://developer.yahoo.com/yui/license.html
|
||||||
|
version: 2.8.2r1
|
||||||
|
*/
|
||||||
|
html {
|
||||||
|
color: #000;
|
||||||
|
background: #FFF;
|
||||||
|
}
|
||||||
|
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0;
|
||||||
|
}
|
||||||
|
fieldset,img {
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
del,ins {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
li {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
caption,th {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
h1,h2,h3,h4,h5,h6 {
|
||||||
|
font-size: 100%;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
q:before,q:after {
|
||||||
|
content: '';
|
||||||
|
}
|
||||||
|
abbr,acronym {
|
||||||
|
border: 0;
|
||||||
|
font-variant: normal;
|
||||||
|
}
|
||||||
|
sup {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
sub {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
legend {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
input,button,textarea,select,optgroup,option {
|
||||||
|
font-family: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
input,button,textarea,select {*font-size:100%;
|
||||||
|
}
|
||||||
|
/* END RESET */
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
font-family: arial, helvetica, geneva, sans-serif;
|
||||||
|
background-color: #ffffff; margin: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||||
|
span.parameter { font-family:monospace; }
|
||||||
|
span.parameter:after { content:":"; }
|
||||||
|
span.types:before { content:"("; }
|
||||||
|
span.types:after { content:")"; }
|
||||||
|
.type { font-weight: bold; font-style:italic }
|
||||||
|
|
||||||
|
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||||
|
|
||||||
|
p, ul { margin: 10px 0 0 0px;}
|
||||||
|
|
||||||
|
strong { font-weight: bold;}
|
||||||
|
|
||||||
|
em { font-style: italic;}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 1.5em;
|
||||||
|
margin: 20px 0 20px 0;
|
||||||
|
}
|
||||||
|
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||||
|
h2 { font-size: 1.25em; }
|
||||||
|
h3 { font-size: 1.15em; }
|
||||||
|
h4 { font-size: 1.06em; }
|
||||||
|
|
||||||
|
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||||
|
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||||
|
a:link:hover { text-decoration: underline; }
|
||||||
|
|
||||||
|
hr {
|
||||||
|
color:#cccccc;
|
||||||
|
background: #00007f;
|
||||||
|
height: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote { margin-left: 3em; }
|
||||||
|
|
||||||
|
ul { list-style-type: disc; }
|
||||||
|
|
||||||
|
p.name {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
padding-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
background-color: rgb(245, 245, 245);
|
||||||
|
border: 1px solid #C0C0C0; /* silver */
|
||||||
|
padding: 10px;
|
||||||
|
margin: 10px 0 10px 0;
|
||||||
|
overflow: auto;
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.example {
|
||||||
|
font-size: .85em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.index { border: 1px #00007f; }
|
||||||
|
table.index td { text-align: left; vertical-align: top; }
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product {
|
||||||
|
text-align: center;
|
||||||
|
border-bottom: 1px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product big {
|
||||||
|
font-size: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
float: left;
|
||||||
|
width: 14em;
|
||||||
|
max-height: 96.7%;
|
||||||
|
position: fixed;
|
||||||
|
vertical-align: top;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
overflow-x: hidden;
|
||||||
|
overflow-y: scroll;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation h2 {
|
||||||
|
background-color:#e7e7e7;
|
||||||
|
font-size:1.1em;
|
||||||
|
color:#000000;
|
||||||
|
text-align: left;
|
||||||
|
padding:0.2em;
|
||||||
|
border-top:1px solid #dddddd;
|
||||||
|
border-bottom:1px solid #dddddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation ul
|
||||||
|
{
|
||||||
|
font-size:1em;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 1px 1px 10px 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li {
|
||||||
|
text-indent: -1em;
|
||||||
|
display: block;
|
||||||
|
margin: 3px 0px 0px 22px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li li a {
|
||||||
|
margin: 0px 3px 0px -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
margin-left: 14em;
|
||||||
|
padding: 1em;
|
||||||
|
width: 700px;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
border-right: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
min-height: 425px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#about {
|
||||||
|
clear: both;
|
||||||
|
padding: 5px;
|
||||||
|
border-top: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
body {
|
||||||
|
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||||
|
}
|
||||||
|
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #ffffff;
|
||||||
|
border-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 2%;
|
||||||
|
margin-right: 2%;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
padding: 1em;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
pre.example {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
font-size: 10pt;
|
||||||
|
page-break-inside: avoid;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
table.module_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.module_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.module_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
|
||||||
|
table.function_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.function_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.function_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
ul.nowrap {
|
||||||
|
overflow:auto;
|
||||||
|
white-space:nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||||
|
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||||
|
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||||
|
|
||||||
|
/* stop sublists from having initial vertical space */
|
||||||
|
ul ul { margin-top: 0px; }
|
||||||
|
ol ul { margin-top: 0px; }
|
||||||
|
ol ol { margin-top: 0px; }
|
||||||
|
ul ol { margin-top: 0px; }
|
||||||
|
|
||||||
|
/* make the target distinct; helps when we're navigating to a function */
|
||||||
|
a:target + * {
|
||||||
|
background-color: #FF9;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* styles for prettification of source */
|
||||||
|
pre .comment { color: #558817; }
|
||||||
|
pre .constant { color: #a8660d; }
|
||||||
|
pre .escape { color: #844631; }
|
||||||
|
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||||
|
pre .library { color: #0e7c6b; }
|
||||||
|
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||||
|
pre .string { color: #8080ff; }
|
||||||
|
pre .number { color: #f8660d; }
|
||||||
|
pre .operator { color: #2239a8; font-weight: bold; }
|
||||||
|
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||||
|
pre .global { color: #800080; }
|
||||||
|
pre .user-keyword { color: #800080; }
|
||||||
|
pre .prompt { color: #558817; }
|
||||||
|
pre .url { color: #272fc2; text-decoration: underline; }
|
||||||
|
|
||||||
439
reference/v1.2.1/topics/api.html
Normal file
439
reference/v1.2.1/topics/api.html
Normal file
|
|
@ -0,0 +1,439 @@
|
||||||
|
<!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.2.1)</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
470
reference/v1.2.1/topics/commands.html
Normal file
470
reference/v1.2.1/topics/commands.html
Normal file
|
|
@ -0,0 +1,470 @@
|
||||||
|
<!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.2.1)</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="#Chat_Commands">Chat Commands</a></li>
|
||||||
|
<li><a href="#Unsafe_Commands">Unsafe Commands </a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><strong>commands</strong></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>commands</code></h1>
|
||||||
|
<p>Cleaner Chat Commands</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Chat_Commands">Chat Commands</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_entities">remove_entities <entity> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby entities.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_nodes">remove_nodes <node> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_items">replace_items <old_item> <new_item></a></td>
|
||||||
|
<td class="summary">Replaces an item.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_nodes">replace_nodes <old_node> <new_node> [radius]</a></td>
|
||||||
|
<td class="summary">Replaces nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_unknown_nodes">find_unknown_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Checks for nearby unknown nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_nearby_nodes">find_nearby_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Finds names of nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#ctool">ctool <action> <value></a></td>
|
||||||
|
<td class="summary">Manages settings for wielded <a href="tools.html">cleaner tool</a>.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Unsafe_Commands">Unsafe Commands </a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_ores">remove_ores <ore></a></td>
|
||||||
|
<td class="summary">Registers an ore to be removed.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Chat_Commands"></a>Chat Commands</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_entities <entity> [radius]"></a>
|
||||||
|
<strong>remove_entities <entity> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby entities. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">entity</span> Entity technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all mobs:horse entities within a radius of <span class="number">10</span> nodes
|
||||||
|
/remove_entities mobs:horse <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_nodes <node> [radius]"></a>
|
||||||
|
<strong>remove_nodes <node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span> Node technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all default:dirt nodes within a radius of <span class="number">10</span>
|
||||||
|
/remove_nodes default:dirt <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_items <old_item> <new_item>"></a>
|
||||||
|
<strong>replace_items <old_item> <new_item></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces an item. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_item</span> Technical name of item to replace.</li>
|
||||||
|
<li><span class="parameter">new_item</span> Technical name of item to be used in place.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace default:sword_wood with default:sword_mese
|
||||||
|
/replace_items default:sword_wood default:sword_mese</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_nodes <old_node> <new_node> [radius]"></a>
|
||||||
|
<strong>replace_nodes <old_node> <new_node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_node</span> Technical name of node to replace.</li>
|
||||||
|
<li><span class="parameter">new_node</span> Technical name of node to be used in place.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace all default:dirt nodes with default:cobble within a radius of <span class="number">10</span>
|
||||||
|
/replace_nodes default:dirt default:cobble <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_unknown_nodes [radius]"></a>
|
||||||
|
<strong>find_unknown_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Checks for nearby unknown nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all unknown nodes within radius of <span class="number">10</span>
|
||||||
|
/find_unknown_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_nearby_nodes [radius]"></a>
|
||||||
|
<strong>find_nearby_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Finds names of nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all node types found within radius of <span class="number">10</span>
|
||||||
|
/find_nearby_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "ctool <action> <value>"></a>
|
||||||
|
<strong>ctool <action> <value></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Manages settings for wielded <a href="tools.html">cleaner tool</a>. </p>
|
||||||
|
|
||||||
|
<p> <h3>Required Privileges:</h3></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action</span> Action to execute. Can be "status", "setmode", or "setnode".</li>
|
||||||
|
<li><span class="parameter">value</span> Mode or node to be set for tool (not required for "status" action).</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="keyword">while</span> cleaner:pencil is wielded, configure to place default:dirt node when used
|
||||||
|
/ctool setmode write
|
||||||
|
/ctool setnode default:dirt</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header has-description"><a name="Unsafe_Commands"></a>Unsafe Commands </h2>
|
||||||
|
|
||||||
|
<div class="section-description">
|
||||||
|
Enabled with <a href="settings.html#cleaner.unsafe">cleaner.unsafe</a> setting.
|
||||||
|
</div>
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_ores <ore>"></a>
|
||||||
|
<strong>remove_ores <ore></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Registers an ore to be removed. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">ore</span> Ore technical name.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Notes:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><em>This action is reverted after server restart. To make changes permanent,
|
||||||
|
use the <a href="config.html#cleaner.json">cleaner.json</a> config.</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all registered ores that add default:stone_with_iron to world
|
||||||
|
/remove_ores default:stone_with_iron</pre>
|
||||||
|
</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
159
reference/v1.2.1/topics/config.html
Normal file
159
reference/v1.2.1/topics/config.html
Normal file
|
|
@ -0,0 +1,159 @@
|
||||||
|
<!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.2.1)</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="#JSON_Configurations">JSON Configurations</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><a href="../topics/tools.html">tools</a></li>
|
||||||
|
<li><strong>config</strong></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>config</code></h1>
|
||||||
|
<p>World Path Configuration</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#JSON_Configurations">JSON Configurations</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.json">cleaner.json</a></td>
|
||||||
|
<td class="summary">Main configuration file.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="JSON_Configurations"></a>JSON Configurations</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.json"></a>
|
||||||
|
<strong>cleaner.json</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Main configuration file. </p>
|
||||||
|
|
||||||
|
<p> Registering items, entities, etc. for cleaning can be done in <strong><em>cleaner.json</em></strong>
|
||||||
|
in the world directory (<code><world_path>/cleaner.json</code>). If it does not exist
|
||||||
|
it will be created automatically when the server is started.</p>
|
||||||
|
|
||||||
|
<p> It is formatted as follows:</p>
|
||||||
|
|
||||||
|
<pre><code>{
|
||||||
|
"entities" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
},
|
||||||
|
"items" :
|
||||||
|
{
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"nodes" :
|
||||||
|
{
|
||||||
|
"remove" : [],
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"ores" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p> <code>remove</code> key works for nodes, entities, & ores. <code>replace</code> key works for
|
||||||
|
nodes & items. Their functions are self-explanatory.
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">Cleaning nodes example:
|
||||||
|
{
|
||||||
|
<span class="string">"nodes"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"remove"</span> :
|
||||||
|
[
|
||||||
|
<span class="string">"old:node_1"</span>,
|
||||||
|
<span class="string">"old:node_2"</span>,
|
||||||
|
],
|
||||||
|
<span class="string">"replace"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"old:node_3"</span> : <span class="string">"new:node_1"</span>,
|
||||||
|
<span class="string">"old:node_4"</span> : <span class="string">"new:node_2"</span>,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}</pre>
|
||||||
|
</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
125
reference/v1.2.1/topics/settings.html
Normal file
125
reference/v1.2.1/topics/settings.html
Normal file
|
|
@ -0,0 +1,125 @@
|
||||||
|
<!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.2.1)</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="#Settings">Settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><strong>settings</strong></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></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>settings</code></h1>
|
||||||
|
<p>Cleaner Settings</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Settings">Settings</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.unsafe">cleaner.unsafe</a></td>
|
||||||
|
<td class="summary">Enables unsafe methods & chat commands.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Settings"></a>Settings</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.unsafe"></a>
|
||||||
|
<strong>cleaner.unsafe</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Enables unsafe methods & chat commands. </p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><code>cleaner.remove_ore</code></li>
|
||||||
|
<li><code>/remove_ores</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p><strong>Definition:</strong></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span style="font-size:80%;"><code>type:</code></span> <code>bool</code></li>
|
||||||
|
<li><span style="font-size:80%;"><code>default:</code></span> <code>false</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
133
reference/v1.2.1/topics/tools.html
Normal file
133
reference/v1.2.1/topics/tools.html
Normal file
|
|
@ -0,0 +1,133 @@
|
||||||
|
<!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.2.1)</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="#Tools">Tools</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><strong>tools</strong></li>
|
||||||
|
<li><a href="../topics/config.html">config</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>tools</code></h1>
|
||||||
|
<p>Cleaner Tools</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Tools">Tools</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner:pencil">cleaner:pencil</a></td>
|
||||||
|
<td class="summary">Master Pencil</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Tools"></a>Tools</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner:pencil"></a>
|
||||||
|
<strong>cleaner:pencil</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Master Pencil </p>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
<h3>Image:</h3>
|
||||||
|
<ul>
|
||||||
|
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">place (right-click):
|
||||||
|
- when <span class="keyword">not</span> pointing at a node, changes modes
|
||||||
|
- when pointing at a node, sets node to be used
|
||||||
|
|
||||||
|
use (left-click):
|
||||||
|
- executes action <span class="keyword">for</span> current mode:
|
||||||
|
- erase: erases pointed node
|
||||||
|
- write: adds node
|
||||||
|
- swap: replaces pointed node</pre>
|
||||||
|
</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
BIN
reference/v1.2/data/cleaner_pencil.png
Normal file
BIN
reference/v1.2/data/cleaner_pencil.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 255 B |
82
reference/v1.2/index.html
Normal file
82
reference/v1.2/index.html
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
<!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.2)</span></h1>
|
||||||
|
|
||||||
|
<img src="data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="topics/api.html">api</a></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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<table class="module_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
||||||
|
<td class="summary">Cleaner Settings</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||||
|
<td class="summary">Cleaner API</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
||||||
|
<td class="summary">Cleaner Chat Commands</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/tools.html">tools</a></td>
|
||||||
|
<td class="summary">Cleaner Tools</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/config.html">config</a></td>
|
||||||
|
<td class="summary">World Path Configuration</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
</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:18 </i>
|
||||||
|
</div> <!-- id="about" -->
|
||||||
|
</div> <!-- id="container" -->
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
305
reference/v1.2/ldoc.css
Normal file
305
reference/v1.2/ldoc.css
Normal file
|
|
@ -0,0 +1,305 @@
|
||||||
|
/* BEGIN RESET
|
||||||
|
|
||||||
|
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||||
|
Code licensed under the BSD License:
|
||||||
|
http://developer.yahoo.com/yui/license.html
|
||||||
|
version: 2.8.2r1
|
||||||
|
*/
|
||||||
|
html {
|
||||||
|
color: #000;
|
||||||
|
background: #FFF;
|
||||||
|
}
|
||||||
|
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0;
|
||||||
|
}
|
||||||
|
fieldset,img {
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
del,ins {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
li {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
caption,th {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
h1,h2,h3,h4,h5,h6 {
|
||||||
|
font-size: 100%;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
q:before,q:after {
|
||||||
|
content: '';
|
||||||
|
}
|
||||||
|
abbr,acronym {
|
||||||
|
border: 0;
|
||||||
|
font-variant: normal;
|
||||||
|
}
|
||||||
|
sup {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
sub {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
legend {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
input,button,textarea,select,optgroup,option {
|
||||||
|
font-family: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
input,button,textarea,select {*font-size:100%;
|
||||||
|
}
|
||||||
|
/* END RESET */
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
font-family: arial, helvetica, geneva, sans-serif;
|
||||||
|
background-color: #ffffff; margin: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||||
|
span.parameter { font-family:monospace; }
|
||||||
|
span.parameter:after { content:":"; }
|
||||||
|
span.types:before { content:"("; }
|
||||||
|
span.types:after { content:")"; }
|
||||||
|
.type { font-weight: bold; font-style:italic }
|
||||||
|
|
||||||
|
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||||
|
|
||||||
|
p, ul { margin: 10px 0 0 0px;}
|
||||||
|
|
||||||
|
strong { font-weight: bold;}
|
||||||
|
|
||||||
|
em { font-style: italic;}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 1.5em;
|
||||||
|
margin: 20px 0 20px 0;
|
||||||
|
}
|
||||||
|
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||||
|
h2 { font-size: 1.25em; }
|
||||||
|
h3 { font-size: 1.15em; }
|
||||||
|
h4 { font-size: 1.06em; }
|
||||||
|
|
||||||
|
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||||
|
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||||
|
a:link:hover { text-decoration: underline; }
|
||||||
|
|
||||||
|
hr {
|
||||||
|
color:#cccccc;
|
||||||
|
background: #00007f;
|
||||||
|
height: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote { margin-left: 3em; }
|
||||||
|
|
||||||
|
ul { list-style-type: disc; }
|
||||||
|
|
||||||
|
p.name {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
padding-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
background-color: rgb(245, 245, 245);
|
||||||
|
border: 1px solid #C0C0C0; /* silver */
|
||||||
|
padding: 10px;
|
||||||
|
margin: 10px 0 10px 0;
|
||||||
|
overflow: auto;
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.example {
|
||||||
|
font-size: .85em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.index { border: 1px #00007f; }
|
||||||
|
table.index td { text-align: left; vertical-align: top; }
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product {
|
||||||
|
text-align: center;
|
||||||
|
border-bottom: 1px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product big {
|
||||||
|
font-size: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
float: left;
|
||||||
|
width: 14em;
|
||||||
|
vertical-align: top;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
overflow: visible;
|
||||||
|
position: fixed;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation h2 {
|
||||||
|
background-color:#e7e7e7;
|
||||||
|
font-size:1.1em;
|
||||||
|
color:#000000;
|
||||||
|
text-align: left;
|
||||||
|
padding:0.2em;
|
||||||
|
border-top:1px solid #dddddd;
|
||||||
|
border-bottom:1px solid #dddddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation ul
|
||||||
|
{
|
||||||
|
font-size:1em;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 1px 1px 10px 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li {
|
||||||
|
text-indent: -1em;
|
||||||
|
display: block;
|
||||||
|
margin: 3px 0px 0px 22px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li li a {
|
||||||
|
margin: 0px 3px 0px -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
margin-left: 14em;
|
||||||
|
padding: 1em;
|
||||||
|
width: 700px;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
border-right: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
min-height: 425px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#about {
|
||||||
|
clear: both;
|
||||||
|
padding: 5px;
|
||||||
|
border-top: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
body {
|
||||||
|
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||||
|
}
|
||||||
|
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #ffffff;
|
||||||
|
border-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 2%;
|
||||||
|
margin-right: 2%;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
padding: 1em;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
pre.example {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
font-size: 10pt;
|
||||||
|
page-break-inside: avoid;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
table.module_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.module_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.module_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
|
||||||
|
table.function_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.function_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.function_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
ul.nowrap {
|
||||||
|
overflow:auto;
|
||||||
|
white-space:nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||||
|
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||||
|
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||||
|
|
||||||
|
/* stop sublists from having initial vertical space */
|
||||||
|
ul ul { margin-top: 0px; }
|
||||||
|
ol ul { margin-top: 0px; }
|
||||||
|
ol ol { margin-top: 0px; }
|
||||||
|
ul ol { margin-top: 0px; }
|
||||||
|
|
||||||
|
/* make the target distinct; helps when we're navigating to a function */
|
||||||
|
a:target + * {
|
||||||
|
background-color: #FF9;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* styles for prettification of source */
|
||||||
|
pre .comment { color: #558817; }
|
||||||
|
pre .constant { color: #a8660d; }
|
||||||
|
pre .escape { color: #844631; }
|
||||||
|
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||||
|
pre .library { color: #0e7c6b; }
|
||||||
|
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||||
|
pre .string { color: #8080ff; }
|
||||||
|
pre .number { color: #f8660d; }
|
||||||
|
pre .operator { color: #2239a8; font-weight: bold; }
|
||||||
|
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||||
|
pre .global { color: #800080; }
|
||||||
|
pre .user-keyword { color: #800080; }
|
||||||
|
pre .prompt { color: #558817; }
|
||||||
|
pre .url { color: #272fc2; text-decoration: underline; }
|
||||||
|
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
<div id="navigation">
|
<div id="navigation">
|
||||||
<br/>
|
<br/>
|
||||||
<h1>Cleaner</h1>
|
<h1>Cleaner <span style="font-size:12pt;">(v1.2)</span></h1>
|
||||||
|
|
||||||
<img src="../data/cleaner_pencil.png" />
|
<img src="../data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
@ -432,7 +432,7 @@
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
<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-15 05:02:04 </i>
|
<i style="float:right;">Last updated 2021-08-16 09:32:18 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
<div id="navigation">
|
<div id="navigation">
|
||||||
<br/>
|
<br/>
|
||||||
<h1>Cleaner</h1>
|
<h1>Cleaner <span style="font-size:12pt;">(v1.2)</span></h1>
|
||||||
|
|
||||||
<img src="../data/cleaner_pencil.png" />
|
<img src="../data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
@ -463,7 +463,7 @@
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
<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-15 05:02:04 </i>
|
<i style="float:right;">Last updated 2021-08-16 09:32:18 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
<div id="navigation">
|
<div id="navigation">
|
||||||
<br/>
|
<br/>
|
||||||
<h1>Cleaner</h1>
|
<h1>Cleaner <span style="font-size:12pt;">(v1.2)</span></h1>
|
||||||
|
|
||||||
<img src="../data/cleaner_pencil.png" />
|
<img src="../data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
@ -152,7 +152,7 @@
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
<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-15 05:02:04 </i>
|
<i style="float:right;">Last updated 2021-08-16 09:32:18 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
<div id="navigation">
|
<div id="navigation">
|
||||||
<br/>
|
<br/>
|
||||||
<h1>Cleaner</h1>
|
<h1>Cleaner <span style="font-size:12pt;">(v1.2)</span></h1>
|
||||||
|
|
||||||
<img src="../data/cleaner_pencil.png" />
|
<img src="../data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
@ -118,7 +118,7 @@
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
<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-15 05:02:04 </i>
|
<i style="float:right;">Last updated 2021-08-16 09:32:18 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
<div id="navigation">
|
<div id="navigation">
|
||||||
<br/>
|
<br/>
|
||||||
<h1>Cleaner</h1>
|
<h1>Cleaner <span style="font-size:12pt;">(v1.2)</span></h1>
|
||||||
|
|
||||||
<img src="../data/cleaner_pencil.png" />
|
<img src="../data/cleaner_pencil.png" />
|
||||||
|
|
||||||
|
|
@ -89,10 +89,6 @@
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</ul>
|
|
||||||
</ul>
|
|
||||||
</ul>
|
|
||||||
<h3>Image:</h3>
|
<h3>Image:</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
||||||
|
|
@ -100,6 +96,10 @@
|
||||||
</ul>
|
</ul>
|
||||||
</ul>
|
</ul>
|
||||||
</ul>
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -126,7 +126,7 @@ use (left-click):
|
||||||
</div> <!-- id="main" -->
|
</div> <!-- id="main" -->
|
||||||
<div id="about">
|
<div id="about">
|
||||||
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
|
<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-15 05:02:04 </i>
|
<i style="float:right;">Last updated 2021-08-16 09:32:18 </i>
|
||||||
</div> <!-- id="about" -->
|
</div> <!-- id="about" -->
|
||||||
</div> <!-- id="container" -->
|
</div> <!-- id="container" -->
|
||||||
</body>
|
</body>
|
||||||
BIN
reference/v1.3-dev/data/cleaner_pencil.png
Normal file
BIN
reference/v1.3-dev/data/cleaner_pencil.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 255 B |
82
reference/v1.3-dev/index.html
Normal file
82
reference/v1.3-dev/index.html
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
<!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" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="topics/api.html">api</a></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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<table class="module_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/settings.html">settings</a></td>
|
||||||
|
<td class="summary">Cleaner Settings</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/api.html">api</a></td>
|
||||||
|
<td class="summary">Cleaner API</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/commands.html">commands</a></td>
|
||||||
|
<td class="summary">Cleaner Chat Commands</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/tools.html">tools</a></td>
|
||||||
|
<td class="summary">Cleaner Tools</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="topics/config.html">config</a></td>
|
||||||
|
<td class="summary">World Path Configuration</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
</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>
|
||||||
307
reference/v1.3-dev/ldoc.css
Normal file
307
reference/v1.3-dev/ldoc.css
Normal file
|
|
@ -0,0 +1,307 @@
|
||||||
|
/* BEGIN RESET
|
||||||
|
|
||||||
|
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||||
|
Code licensed under the BSD License:
|
||||||
|
http://developer.yahoo.com/yui/license.html
|
||||||
|
version: 2.8.2r1
|
||||||
|
*/
|
||||||
|
html {
|
||||||
|
color: #000;
|
||||||
|
background: #FFF;
|
||||||
|
}
|
||||||
|
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0;
|
||||||
|
}
|
||||||
|
fieldset,img {
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
del,ins {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
li {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
caption,th {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
h1,h2,h3,h4,h5,h6 {
|
||||||
|
font-size: 100%;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
q:before,q:after {
|
||||||
|
content: '';
|
||||||
|
}
|
||||||
|
abbr,acronym {
|
||||||
|
border: 0;
|
||||||
|
font-variant: normal;
|
||||||
|
}
|
||||||
|
sup {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
sub {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
legend {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
input,button,textarea,select,optgroup,option {
|
||||||
|
font-family: inherit;
|
||||||
|
font-size: inherit;
|
||||||
|
font-style: inherit;
|
||||||
|
font-weight: inherit;
|
||||||
|
}
|
||||||
|
input,button,textarea,select {*font-size:100%;
|
||||||
|
}
|
||||||
|
/* END RESET */
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
font-family: arial, helvetica, geneva, sans-serif;
|
||||||
|
background-color: #ffffff; margin: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||||
|
span.parameter { font-family:monospace; }
|
||||||
|
span.parameter:after { content:":"; }
|
||||||
|
span.types:before { content:"("; }
|
||||||
|
span.types:after { content:")"; }
|
||||||
|
.type { font-weight: bold; font-style:italic }
|
||||||
|
|
||||||
|
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||||
|
|
||||||
|
p, ul { margin: 10px 0 0 0px;}
|
||||||
|
|
||||||
|
strong { font-weight: bold;}
|
||||||
|
|
||||||
|
em { font-style: italic;}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 1.5em;
|
||||||
|
margin: 20px 0 20px 0;
|
||||||
|
}
|
||||||
|
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||||
|
h2 { font-size: 1.25em; }
|
||||||
|
h3 { font-size: 1.15em; }
|
||||||
|
h4 { font-size: 1.06em; }
|
||||||
|
|
||||||
|
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||||
|
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||||
|
a:link:hover { text-decoration: underline; }
|
||||||
|
|
||||||
|
hr {
|
||||||
|
color:#cccccc;
|
||||||
|
background: #00007f;
|
||||||
|
height: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote { margin-left: 3em; }
|
||||||
|
|
||||||
|
ul { list-style-type: disc; }
|
||||||
|
|
||||||
|
p.name {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
padding-top: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
background-color: rgb(245, 245, 245);
|
||||||
|
border: 1px solid #C0C0C0; /* silver */
|
||||||
|
padding: 10px;
|
||||||
|
margin: 10px 0 10px 0;
|
||||||
|
overflow: auto;
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.example {
|
||||||
|
font-size: .85em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.index { border: 1px #00007f; }
|
||||||
|
table.index td { text-align: left; vertical-align: top; }
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 1em;
|
||||||
|
margin-right: 1em;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product {
|
||||||
|
text-align: center;
|
||||||
|
border-bottom: 1px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#product big {
|
||||||
|
font-size: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
float: left;
|
||||||
|
width: 14em;
|
||||||
|
max-height: 96.7%;
|
||||||
|
position: fixed;
|
||||||
|
vertical-align: top;
|
||||||
|
background-color: #f0f0f0;
|
||||||
|
overflow-x: hidden;
|
||||||
|
overflow-y: scroll;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation h2 {
|
||||||
|
background-color:#e7e7e7;
|
||||||
|
font-size:1.1em;
|
||||||
|
color:#000000;
|
||||||
|
text-align: left;
|
||||||
|
padding:0.2em;
|
||||||
|
border-top:1px solid #dddddd;
|
||||||
|
border-bottom:1px solid #dddddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation ul
|
||||||
|
{
|
||||||
|
font-size:1em;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 1px 1px 10px 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li {
|
||||||
|
text-indent: -1em;
|
||||||
|
display: block;
|
||||||
|
margin: 3px 0px 0px 22px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation li li a {
|
||||||
|
margin: 0px 3px 0px -1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
margin-left: 14em;
|
||||||
|
padding: 1em;
|
||||||
|
width: 700px;
|
||||||
|
border-left: 2px solid #cccccc;
|
||||||
|
border-right: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
min-height: 425px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#about {
|
||||||
|
clear: both;
|
||||||
|
padding: 5px;
|
||||||
|
border-top: 2px solid #cccccc;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
body {
|
||||||
|
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||||
|
}
|
||||||
|
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||||
|
|
||||||
|
#main {
|
||||||
|
background-color: #ffffff;
|
||||||
|
border-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#container {
|
||||||
|
margin-left: 2%;
|
||||||
|
margin-right: 2%;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
padding: 1em;
|
||||||
|
background-color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#navigation {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
pre.example {
|
||||||
|
font-family: "Andale Mono", monospace;
|
||||||
|
font-size: 10pt;
|
||||||
|
page-break-inside: avoid;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
table.module_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.module_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.module_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
|
||||||
|
table.function_list {
|
||||||
|
border-width: 1px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.function_list td {
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #cccccc;
|
||||||
|
}
|
||||||
|
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||||
|
table.function_list td.summary { width: 100%; }
|
||||||
|
|
||||||
|
ul.nowrap {
|
||||||
|
overflow:auto;
|
||||||
|
white-space:nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||||
|
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||||
|
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||||
|
|
||||||
|
/* stop sublists from having initial vertical space */
|
||||||
|
ul ul { margin-top: 0px; }
|
||||||
|
ol ul { margin-top: 0px; }
|
||||||
|
ol ol { margin-top: 0px; }
|
||||||
|
ul ol { margin-top: 0px; }
|
||||||
|
|
||||||
|
/* make the target distinct; helps when we're navigating to a function */
|
||||||
|
a:target + * {
|
||||||
|
background-color: #FF9;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* styles for prettification of source */
|
||||||
|
pre .comment { color: #558817; }
|
||||||
|
pre .constant { color: #a8660d; }
|
||||||
|
pre .escape { color: #844631; }
|
||||||
|
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||||
|
pre .library { color: #0e7c6b; }
|
||||||
|
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||||
|
pre .string { color: #8080ff; }
|
||||||
|
pre .number { color: #f8660d; }
|
||||||
|
pre .operator { color: #2239a8; font-weight: bold; }
|
||||||
|
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||||
|
pre .global { color: #800080; }
|
||||||
|
pre .user-keyword { color: #800080; }
|
||||||
|
pre .prompt { color: #558817; }
|
||||||
|
pre .url { color: #272fc2; text-decoration: underline; }
|
||||||
|
|
||||||
439
reference/v1.3-dev/topics/api.html
Normal file
439
reference/v1.3-dev/topics/api.html
Normal file
|
|
@ -0,0 +1,439 @@
|
||||||
|
<!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>
|
||||||
470
reference/v1.3-dev/topics/commands.html
Normal file
470
reference/v1.3-dev/topics/commands.html
Normal file
|
|
@ -0,0 +1,470 @@
|
||||||
|
<!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="#Chat_Commands">Chat Commands</a></li>
|
||||||
|
<li><a href="#Unsafe_Commands">Unsafe Commands </a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><strong>commands</strong></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>commands</code></h1>
|
||||||
|
<p>Cleaner Chat Commands</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Chat_Commands">Chat Commands</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_entities">remove_entities <entity> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby entities.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_nodes">remove_nodes <node> [radius]</a></td>
|
||||||
|
<td class="summary">Removes nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_items">replace_items <old_item> <new_item></a></td>
|
||||||
|
<td class="summary">Replaces an item.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#replace_nodes">replace_nodes <old_node> <new_node> [radius]</a></td>
|
||||||
|
<td class="summary">Replaces nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_unknown_nodes">find_unknown_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Checks for nearby unknown nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#find_nearby_nodes">find_nearby_nodes [radius]</a></td>
|
||||||
|
<td class="summary">Finds names of nearby nodes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#ctool">ctool <action> <value></a></td>
|
||||||
|
<td class="summary">Manages settings for wielded <a href="tools.html">cleaner tool</a>.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<h2><a href="#Unsafe_Commands">Unsafe Commands </a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#remove_ores">remove_ores <ore></a></td>
|
||||||
|
<td class="summary">Registers an ore to be removed.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Chat_Commands"></a>Chat Commands</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_entities <entity> [radius]"></a>
|
||||||
|
<strong>remove_entities <entity> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby entities. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">entity</span> Entity technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all mobs:horse entities within a radius of <span class="number">10</span> nodes
|
||||||
|
/remove_entities mobs:horse <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_nodes <node> [radius]"></a>
|
||||||
|
<strong>remove_nodes <node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Removes nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">node</span> Node technical name.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all default:dirt nodes within a radius of <span class="number">10</span>
|
||||||
|
/remove_nodes default:dirt <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_items <old_item> <new_item>"></a>
|
||||||
|
<strong>replace_items <old_item> <new_item></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces an item. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_item</span> Technical name of item to replace.</li>
|
||||||
|
<li><span class="parameter">new_item</span> Technical name of item to be used in place.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace default:sword_wood with default:sword_mese
|
||||||
|
/replace_items default:sword_wood default:sword_mese</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "replace_nodes <old_node> <new_node> [radius]"></a>
|
||||||
|
<strong>replace_nodes <old_node> <new_node> [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Replaces nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">old_node</span> Technical name of node to replace.</li>
|
||||||
|
<li><span class="parameter">new_node</span> Technical name of node to be used in place.</li>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># replace all default:dirt nodes with default:cobble within a radius of <span class="number">10</span>
|
||||||
|
/replace_nodes default:dirt default:cobble <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_unknown_nodes [radius]"></a>
|
||||||
|
<strong>find_unknown_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Checks for nearby unknown nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 100). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all unknown nodes within radius of <span class="number">10</span>
|
||||||
|
/find_unknown_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "find_nearby_nodes [radius]"></a>
|
||||||
|
<strong>find_nearby_nodes [radius]</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Finds names of nearby nodes. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">radius</span> <span class="types"><span class="type"><code>int</code></span></span> Search radius (default: 5). <em>(optional)</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="global">print</span> names of all node types found within radius of <span class="number">10</span>
|
||||||
|
/find_nearby_nodes <span class="number">10</span></pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<a name = "ctool <action> <value>"></a>
|
||||||
|
<strong>ctool <action> <value></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Manages settings for wielded <a href="tools.html">cleaner tool</a>. </p>
|
||||||
|
|
||||||
|
<p> <h3>Required Privileges:</h3></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">action</span> Action to execute. Can be "status", "setmode", or "setnode".</li>
|
||||||
|
<li><span class="parameter">value</span> Mode or node to be set for tool (not required for "status" action).</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># <span class="keyword">while</span> cleaner:pencil is wielded, configure to place default:dirt node when used
|
||||||
|
/ctool setmode write
|
||||||
|
/ctool setnode default:dirt</pre>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<h2 class="section-header has-description"><a name="Unsafe_Commands"></a>Unsafe Commands </h2>
|
||||||
|
|
||||||
|
<div class="section-description">
|
||||||
|
Enabled with <a href="settings.html#cleaner.unsafe">cleaner.unsafe</a> setting.
|
||||||
|
</div>
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "remove_ores <ore>"></a>
|
||||||
|
<strong>remove_ores <ore></strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Registers an ore to be removed. </p>
|
||||||
|
|
||||||
|
<h3>Parameters:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span class="parameter">ore</span> Ore technical name.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h3>Notes:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><em>This action is reverted after server restart. To make changes permanent,
|
||||||
|
use the <a href="config.html#cleaner.json">cleaner.json</a> config.</em></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example"># remove all registered ores that add default:stone_with_iron to world
|
||||||
|
/remove_ores default:stone_with_iron</pre>
|
||||||
|
</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>
|
||||||
159
reference/v1.3-dev/topics/config.html
Normal file
159
reference/v1.3-dev/topics/config.html
Normal file
|
|
@ -0,0 +1,159 @@
|
||||||
|
<!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="#JSON_Configurations">JSON Configurations</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><a href="../topics/tools.html">tools</a></li>
|
||||||
|
<li><strong>config</strong></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>config</code></h1>
|
||||||
|
<p>World Path Configuration</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#JSON_Configurations">JSON Configurations</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.json">cleaner.json</a></td>
|
||||||
|
<td class="summary">Main configuration file.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="JSON_Configurations"></a>JSON Configurations</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.json"></a>
|
||||||
|
<strong>cleaner.json</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
Main configuration file. </p>
|
||||||
|
|
||||||
|
<p> Registering items, entities, etc. for cleaning can be done in <strong><em>cleaner.json</em></strong>
|
||||||
|
in the world directory (<code><world_path>/cleaner.json</code>). If it does not exist
|
||||||
|
it will be created automatically when the server is started.</p>
|
||||||
|
|
||||||
|
<p> It is formatted as follows:</p>
|
||||||
|
|
||||||
|
<pre><code>{
|
||||||
|
"entities" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
},
|
||||||
|
"items" :
|
||||||
|
{
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"nodes" :
|
||||||
|
{
|
||||||
|
"remove" : [],
|
||||||
|
"replace" : {}
|
||||||
|
},
|
||||||
|
"ores" :
|
||||||
|
{
|
||||||
|
"remove" : []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p> <code>remove</code> key works for nodes, entities, & ores. <code>replace</code> key works for
|
||||||
|
nodes & items. Their functions are self-explanatory.
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">Cleaning nodes example:
|
||||||
|
{
|
||||||
|
<span class="string">"nodes"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"remove"</span> :
|
||||||
|
[
|
||||||
|
<span class="string">"old:node_1"</span>,
|
||||||
|
<span class="string">"old:node_2"</span>,
|
||||||
|
],
|
||||||
|
<span class="string">"replace"</span> :
|
||||||
|
{
|
||||||
|
<span class="string">"old:node_3"</span> : <span class="string">"new:node_1"</span>,
|
||||||
|
<span class="string">"old:node_4"</span> : <span class="string">"new:node_2"</span>,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}</pre>
|
||||||
|
</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>
|
||||||
125
reference/v1.3-dev/topics/settings.html
Normal file
125
reference/v1.3-dev/topics/settings.html
Normal file
|
|
@ -0,0 +1,125 @@
|
||||||
|
<!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="#Settings">Settings</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><strong>settings</strong></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></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>settings</code></h1>
|
||||||
|
<p>Cleaner Settings</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Settings">Settings</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner.unsafe">cleaner.unsafe</a></td>
|
||||||
|
<td class="summary">Enables unsafe methods & chat commands.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Settings"></a>Settings</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner.unsafe"></a>
|
||||||
|
<strong>cleaner.unsafe</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Enables unsafe methods & chat commands. </p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><code>cleaner.remove_ore</code></li>
|
||||||
|
<li><code>/remove_ores</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p><strong>Definition:</strong></p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><span style="font-size:80%;"><code>type:</code></span> <code>bool</code></li>
|
||||||
|
<li><span style="font-size:80%;"><code>default:</code></span> <code>false</code></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</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>
|
||||||
133
reference/v1.3-dev/topics/tools.html
Normal file
133
reference/v1.3-dev/topics/tools.html
Normal file
|
|
@ -0,0 +1,133 @@
|
||||||
|
<!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="#Tools">Tools</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Topics</h2>
|
||||||
|
<ul class="">
|
||||||
|
<li><a href="../topics/settings.html">settings</a></li>
|
||||||
|
<li><a href="../topics/api.html">api</a></li>
|
||||||
|
<li><a href="../topics/commands.html">commands</a></li>
|
||||||
|
<li><strong>tools</strong></li>
|
||||||
|
<li><a href="../topics/config.html">config</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
|
||||||
|
<h1>Topic <code>tools</code></h1>
|
||||||
|
<p>Cleaner Tools</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2><a href="#Tools">Tools</a></h2>
|
||||||
|
<table class="function_list">
|
||||||
|
<tr>
|
||||||
|
<td class="name" nowrap><a href="#cleaner:pencil">cleaner:pencil</a></td>
|
||||||
|
<td class="summary">Master Pencil</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<br/>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
<h2 class="section-header "><a name="Tools"></a>Tools</h2>
|
||||||
|
|
||||||
|
<dl class="function">
|
||||||
|
<dt>
|
||||||
|
<a name = "cleaner:pencil"></a>
|
||||||
|
<strong>cleaner:pencil</strong>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
|
||||||
|
<p>Master Pencil </p>
|
||||||
|
|
||||||
|
<h3>Required Privileges:</h3>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>server</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
<h3>Image:</h3>
|
||||||
|
<ul>
|
||||||
|
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h3>Usage:</h3>
|
||||||
|
<ul>
|
||||||
|
<pre class="example">place (right-click):
|
||||||
|
- when <span class="keyword">not</span> pointing at a node, changes modes
|
||||||
|
- when pointing at a node, sets node to be used
|
||||||
|
|
||||||
|
use (left-click):
|
||||||
|
- executes action <span class="keyword">for</span> current mode:
|
||||||
|
- erase: erases pointed node
|
||||||
|
- write: adds node
|
||||||
|
- swap: replaces pointed node</pre>
|
||||||
|
</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>
|
||||||
Loading…
Add table
Reference in a new issue