modcleaner/reference/latest/topics/commands.html
2021-08-16 09:32:18 +00:00

470 lines
10 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>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 &lt;entity&gt; [radius]</a></td>
<td class="summary">Removes nearby entities.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#remove_nodes">remove_nodes &lt;node&gt; [radius]</a></td>
<td class="summary">Removes nearby nodes.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#replace_items">replace_items &lt;old_item&gt; &lt;new_item&gt;</a></td>
<td class="summary">Replaces an item.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#replace_nodes">replace_nodes &lt;old_node&gt; &lt;new_node&gt; [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 &lt;action&gt; &lt;value&gt;</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 &lt;ore&gt;</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 &lt;entity&gt; [radius]"></a>
<strong>remove_entities &lt;entity&gt; [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 &lt;node&gt; [radius]"></a>
<strong>remove_nodes &lt;node&gt; [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 &lt;old_item&gt; &lt;new_item&gt;"></a>
<strong>replace_items &lt;old_item&gt; &lt;new_item&gt;</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 &lt;old_node&gt; &lt;new_node&gt; [radius]"></a>
<strong>replace_nodes &lt;old_node&gt; &lt;new_node&gt; [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 &lt;action&gt; &lt;value&gt;"></a>
<strong>ctool &lt;action&gt; &lt;value&gt;</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 &lt;ore&gt;"></a>
<strong>remove_ores &lt;ore&gt;</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>