modcleaner/reference/topics/commands.html

315 lines
6 KiB
HTML
Raw Normal View History

<!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:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>