mirror of
https://codeberg.org/AntumLuanti/mod-cleaner.git
synced 2025-09-03 23:25:49 -04:00
deploy: c41f6e8a0a
This commit is contained in:
AntumDeluge
commit
55cf4bdfc9
9 changed files with 1487 additions and 0 deletions
397
reference/topics/api.html
Normal file
397
reference/topics/api.html
Normal file
|
|
@ -0,0 +1,397 @@
|
|||
<!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" />
|
||||
</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</h1>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#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>
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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 <code>cleaner.unsafe</code> 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>
|
||||
|
||||
|
||||
<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 replaced.
|
||||
</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>
|
||||
|
||||
<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>
|
||||
|
||||
<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-07-31 00:58:03 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
314
reference/topics/commands.html
Normal file
314
reference/topics/commands.html
Normal file
|
|
@ -0,0 +1,314 @@
|
|||
<!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" />
|
||||
</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</h1>
|
||||
|
||||
|
||||
<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</a></td>
|
||||
<td class="summary">Removes nearby entities.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#remove_nodes">remove_nodes</a></td>
|
||||
<td class="summary">Removes nearby nodes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#replace_items">replace_items</a></td>
|
||||
<td class="summary">Replaces an item.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#replace_nodes">replace_nodes</a></td>
|
||||
<td class="summary">Replaces nearby nodes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#find_unknown_nodes">find_unknown_nodes</a></td>
|
||||
<td class="summary">Checks for nearby unknown nodes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ctool">ctool</a></td>
|
||||
<td class="summary">Manages settings for wielded cleaner tool.</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</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"></a>
|
||||
<strong>remove_entities</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes nearby entities.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">entity</span>
|
||||
Entity technical name.
|
||||
</li>
|
||||
<li><span class="parameter">radius</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
|
||||
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "remove_nodes"></a>
|
||||
<strong>remove_nodes</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes nearby nodes.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">node</span>
|
||||
Node technical name.
|
||||
</li>
|
||||
<li><span class="parameter">radius</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
|
||||
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "replace_items"></a>
|
||||
<strong>replace_items</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Replaces an item.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "replace_nodes"></a>
|
||||
<strong>replace_nodes</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Replaces nearby nodes.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<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">int</span></span>
|
||||
|
||||
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "find_unknown_nodes"></a>
|
||||
<strong>find_unknown_nodes</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks for nearby unknown nodes.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">radius</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
Search radius.
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ctool"></a>
|
||||
<strong>ctool</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Manages settings for wielded cleaner tool.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<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.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header has-description"><a name="Unsafe_commands"></a>Unsafe commands </h2>
|
||||
|
||||
<div class="section-description">
|
||||
Enabled with <code>cleaner.unsafe</code> setting.
|
||||
</div>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "remove_ores"></a>
|
||||
<strong>remove_ores</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers an ore to be removed.
|
||||
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">ore</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-07-31 00:58:03 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
151
reference/topics/config.html
Normal file
151
reference/topics/config.html
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<!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" />
|
||||
</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</h1>
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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-07-31 00:58:03 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
119
reference/topics/settings.html
Normal file
119
reference/topics/settings.html
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
<!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" />
|
||||
</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</h1>
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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-07-31 00:58:03 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
122
reference/topics/tools.html
Normal file
122
reference/topics/tools.html
Normal file
|
|
@ -0,0 +1,122 @@
|
|||
<!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" />
|
||||
</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</h1>
|
||||
|
||||
|
||||
<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>
|
||||
Master Pencil
|
||||
|
||||
<h3>Required Privileges:</h3>
|
||||
<ul>
|
||||
server
|
||||
</ul>
|
||||
</ul>
|
||||
</ul>
|
||||
<h3>Image:</h3>
|
||||
<ul>
|
||||
<img src="../data/cleaner_pencil.png" style="width:32px; height:32px;" />
|
||||
</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-07-31 00:58:03 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue