diff --git a/docs/reference/index.html b/docs/reference/index.html deleted file mode 100644 index fb7f023..0000000 --- a/docs/reference/index.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - Cleaner mod for Minetest - - - - -
- -
- -
-
-
- - -
- - - - - - -
- - - -

Topics

- - - - - - - - - - - - - - - - - - - - - -
settingsCleaner Settings
apiCleaner API
commandsCleaner Chat Commands
toolsCleaner Tools
configWorld Path Configuration
- -
-
-
-generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-30 16:16:51 -
-
- - diff --git a/docs/reference/ldoc.css b/docs/reference/ldoc.css deleted file mode 100644 index 1fa3a99..0000000 --- a/docs/reference/ldoc.css +++ /dev/null @@ -1,304 +0,0 @@ -/* 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; -} - -#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; } - diff --git a/docs/reference/topics/api.html b/docs/reference/topics/api.html deleted file mode 100644 index 27d26cc..0000000 --- a/docs/reference/topics/api.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - Cleaner mod for Minetest - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Topic api

-

Cleaner API

-

- -

- - -

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
cleaner.get_replace_items ()Retrieves list of items to be replaced.
cleaner.get_replace_nodes ()Retrieves list of nodes to be replaced.
cleaner.register_entity_removal (src)Registers an entity to be removed.
cleaner.register_node_removal (src)Registers a node to be removed.
cleaner.replace_item (src, tgt[, update_players])Replaces an item with another registered item.
cleaner.register_item_replacement (src, tgt)Registeres an item to be replaced.
cleaner.register_node_replacement (src, tgt)Registers a node to be replaced.
-

Unsafe methods

- - - - - - - - - - - - - -
cleaner.get_remove_ores ()Retrieves list of ores to be removed.
cleaner.register_ore_removal (src)Registers an ore to be removed after server startup.
cleaner.remove_ore (src)Removes an ore definition.
- -
-
- - -

Functions

- -
-
- - cleaner.get_replace_items () -
-
- Retrieves list of items to be replaced. - - - - - - - -

Returns:

-
    - - table - Items to be replaced. -
- - - - -
-
- - cleaner.get_replace_nodes () -
-
- Retrieves list of nodes to be replaced. - - - - - - - -

Returns:

-
    - - table - Nodes to be replaced. -
- - - - -
-
- - cleaner.register_entity_removal (src) -
-
- Registers an entity to be removed. - - - - - - -

Parameters:

-
    -
  • src - string - Entity technical name. -
    • -
- - - - - -
-
- - cleaner.register_node_removal (src) -
-
- Registers a node to be removed. - - - - - - -

Parameters:

-
    -
  • src - string - Node technical name. -
    • -
- - - - - -
-
- - cleaner.replace_item (src, tgt[, update_players]) -
-
- Replaces an item with another registered item. - - - - - - -

Parameters:

-
    -
  • src - string - Technical name of item to be replaced. -
    • -
  • tgt - string - Technical name of item to be used in place. -
    • -
  • update_players - bool - true updates inventory lists associated with players (default: false). - (optional) -
    • -
- - - - - -
-
- - cleaner.register_item_replacement (src, tgt) -
-
- Registeres an item to be replaced. - - - - - - -

Parameters:

-
    -
  • src - string - Technical name of item to be replaced. -
    • -
  • tgt - string - Technical name of item to be used in place. -
    • -
- - - - - -
-
- - cleaner.register_node_replacement (src, tgt) -
-
- Registers a node to be replaced. - - - - - - -

Parameters:

-
    -
  • src - string - Technical name of node to be replaced. -
    • -
  • tgt - string - Technical name of node to be used in place. -
    • -
- - - - - -
-
-

Unsafe methods

- -
- Enabled with cleaner.unsafe setting. -
-
-
- - cleaner.get_remove_ores () -
-
- Retrieves list of ores to be removed. - - - - - - - -

Returns:

-
    - - table - Ores to be replaced. -
- - - - -
-
- - cleaner.register_ore_removal (src) -
-
- Registers an ore to be removed after server startup. - - - - - - -

Parameters:

-
    -
  • src - string - Ore technical name. -
    • -
- - - - - -
-
- - cleaner.remove_ore (src) -
-
- Removes an ore definition. - - - - - - -

Parameters:

-
    -
  • src - string - Ore technical name. -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-30 16:16:51 -
-
- - diff --git a/docs/reference/topics/commands.html b/docs/reference/topics/commands.html deleted file mode 100644 index d94b775..0000000 --- a/docs/reference/topics/commands.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - Cleaner mod for Minetest - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Topic commands

-

Cleaner Chat Commands

-

- -

- - -

Chat Commands

- - - - - - - - - - - - - - - - - - - - - - - - - -
remove_entitiesRemoves nearby entities.
remove_nodesRemoves nearby nodes.
replace_itemsReplaces an item.
replace_nodesReplaces nearby nodes.
find_unknown_nodesChecks for nearby unknown nodes.
cleanerManages settings for wielded cleaner tool.
-

Unsafe commands

- - - - - -
remove_oresRegisters an ore to be removed.
- -
-
- - -

Chat Commands

- -
-
- - remove_entities -
-
- Removes nearby entities. - - - - - - -
    -
  • entity - Entity technical name. -
    • -
  • radius - int - - - - (optional) -
    • -
- - - - - -
-
- - remove_nodes -
-
- Removes nearby nodes. - - - - - - -
    -
  • node - Node technical name. -
    • -
  • radius - int - - - - (optional) -
    • -
- - - - - -
-
- - replace_items -
-
- Replaces an item. - - - - - - -
    -
  • old_item - Technical name of item to replace. -
    • -
  • new_item - Technical name of item to be used in place. -
    • -
- - - - - -
-
- - replace_nodes -
-
- Replaces nearby nodes. - - - - - - -
    -
  • old_node - Technical name of node to replace. -
    • -
  • new_node - Technical name of node to be used in place. -
    • -
  • radius - int - - - - (optional) -
    • -
- - - - - -
-
- - find_unknown_nodes -
-
- Checks for nearby unknown nodes. - - - - - - -
    -
  • radius - int - Search radius. - (optional) -
    • -
- - - - - -
-
- - cleaner -
-
- Manages settings for wielded cleaner tool. - - - - - - -
    -
  • action - Action to execute. Can be "status", "setmode", or "setnode". -
    • -
  • value - Mode or node to be set for tool. -
    • -
- - - - - -
-
-

Unsafe commands

- -
- Enabled with cleaner.unsafe setting. -
-
-
- - remove_ores -
-
- Registers an ore to be removed. - - - - - - -
    -
  • ore - Ore technical name. -
    • -
- - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-30 16:16:51 -
-
- - diff --git a/docs/reference/topics/config.html b/docs/reference/topics/config.html deleted file mode 100644 index 76b2e6b..0000000 --- a/docs/reference/topics/config.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - Cleaner mod for Minetest - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Topic config

-

World Path Configuration

-

- -

- - -

JSON Configurations

- - - - - -
cleaner.jsonMain configuration file.
- -
-
- - -

JSON Configurations

- -
-
- - cleaner.json -
-
- Main configuration file.

- -

Registering items, entities, etc. for cleaning can be done in cleaner.json - in the world directory (<world_path>/cleaner.json). If it does not exist - it will be created automatically when the server is started.

- -

It is formatted as follows:

- -
{
-  "entities" :
-  {
-    "remove" : []
-  },
-  "items" :
-  {
-    "replace" : {}
-  },
-  "nodes" :
-  {
-    "remove" : [],
-    "replace" : {}
-  },
-  "ores" :
-  {
-    "remove" : []
-  }
-}
-
- -

remove key works for nodes, entities, & ores. replace key works for - nodes & items. Their functions are self-explanatory. - - - - - - - - - - -

Usage:

-
    - 
    Cleaning nodes example:
-{
-  "nodes" :
-  {
-    "remove" : [
-      "old:node_1",
-      "old:node_2",
-    ],
-    "replace" : {
-      "old:node_3" : "new:node_1",
-      "old:node_4" : "new:node_2",
-    }
-  },
-}
    -
- -
-
- - -
-
-
-generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-30 16:16:51 -
-
- - diff --git a/docs/reference/topics/settings.html b/docs/reference/topics/settings.html deleted file mode 100644 index 823da59..0000000 --- a/docs/reference/topics/settings.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Cleaner mod for Minetest - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Topic settings

-

Cleaner Settings

-

- -

- - -

Settings

- - - - - -
cleaner.unsafeEnables unsafe methods & chat commands.
- -
-
- - -

Settings

- -
-
- - cleaner.unsafe -
-
- -

Enables unsafe methods & chat commands.

- -
    -
  • cleaner.remove_ore
    • -
  • /remove_ores
    • -
- - -

Definition:

- -
    -
  • type: bool
    • -
  • default: false
    • -
- - - - - - - - - - - - -
-
- - -
-
-
-generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-30 16:16:51 -
-
- - diff --git a/docs/reference/topics/tools.html b/docs/reference/topics/tools.html deleted file mode 100644 index 40f9e99..0000000 --- a/docs/reference/topics/tools.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Cleaner mod for Minetest - - - - -
- -
- -
-
-
- - -
- - - - - - -
- -

Topic tools

-

Cleaner Tools

-

- -

- - -

Tools

- - - - - -
cleaner:pencilMaster Pencil
- -
-
- - -

Tools

- -
-
- - cleaner:pencil -
-
- Master Pencil - -

Required Privileges:

-
    - server -
- - -

Image:

-
    - -
- - - - - -

Usage:

-
    - 
    place (right-click):
-- when not pointing at a node, changes modes
-- when pointing at a node, sets node to be used
-
-use (left-click):
-- executes action for current mode:
-  - erase: erases pointed node
-  - write: adds node
-  - swap:  replaces pointed node
    -
- -
-
- - -
-
-
-generated by LDoc 1.4.6-antum-dev -Last updated 2021-07-30 16:16:51 -
-
- -