diff --git a/docs/reference/index.html b/docs/reference/index.html index 3357883..b84274e 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -32,7 +32,9 @@

Topics

@@ -43,17 +45,25 @@

Topics

+ + + + + + + +
settingsCleaner Settings
api Cleaner API
commandsCleaner Chat Commands
generated by LDoc 1.4.6 -Last updated 2021-07-12 09:02:05 +Last updated 2021-07-12 15:47:16
diff --git a/docs/reference/topics/api.html b/docs/reference/topics/api.html index e9a4009..c0db53e 100644 --- a/docs/reference/topics/api.html +++ b/docs/reference/topics/api.html @@ -34,12 +34,15 @@

Contents

Topics

@@ -80,6 +83,13 @@ Registers a node to be replaced. +

Unsafe methods

+ + + + + +
cleaner.remove_ore (src)Removes an ore definition.


@@ -95,6 +105,8 @@
Retrieves list of items to be replaced. + +

Returns:

@@ -115,6 +127,8 @@
Retrieves list of nodes to be replaced. + +

Returns:

@@ -135,6 +149,8 @@
Registers an entity to be removed. + +

Parameters:

+

Parameters:

+

Parameters:

+

Parameters:

+ +

Unsafe methods

+ +
+ Enabled with cleaner.unsafe setting. +
+
+
+ + cleaner.remove_ore (src) +
+
+ Removes an ore definition. + + + + +

Parameters:

+ + + + + +
@@ -227,7 +279,7 @@
generated by LDoc 1.4.6 -Last updated 2021-07-12 09:02:05 +Last updated 2021-07-12 15:47:16
diff --git a/docs/reference/topics/commands.html b/docs/reference/topics/commands.html new file mode 100644 index 0000000..666d769 --- /dev/null +++ b/docs/reference/topics/commands.html @@ -0,0 +1,251 @@ + + + + + Cleaner mod for Minetest + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Topic commands

+

Cleaner Chat Commands

+

+ +

+ + +

Chat Commands

+ + + + + + + + + + + + + + + + + + + + + +
remove_entityRemoves nearby entities.
remove_nodeRemoves nearby nodes.
replace_itemReplaces an item.
replace_itemReplaces nearby nodes.
find_unknown_nodesChecks for nearby unknown nodes.
+

Unsafe commands

+ + + + + +
remove_oreRegisters an ore to be removed.
+ +
+
+ + +

Chat Commands

+ +
+
+ + remove_entity +
+
+ Removes nearby entities. + + + + +
    +
  • entity + Entity technical name. +
    • +
+ + + + + +
+
+ + remove_node +
+
+ Removes nearby nodes. + + + + +
    +
  • node + Node technical name. +
    • +
+ + + + + +
+
+ + replace_item +
+
+ Replaces an item.

+ +

FIXME: inventory icons not updated + + + + +

    +
  • old_item + Technical name of item to replace. +
    • +
  • new_item + Technical name of item to be used in place. +
    • +
+ + + + + +
+
+ + replace_item +
+
+ Replaces nearby nodes. + + + + +
    +
  • old_node + Technical name of node to replace. +
    • +
  • new_node + Technical name of node to be used in place. +
    • +
+ + + + + +
+
+ + find_unknown_nodes +
+
+ Checks for nearby unknown nodes. + + + + +
    +
  • radius + int + Search radius. + (optional) +
    • +
+ + + + + +
+
+

Unsafe commands

+ +
+ Enabled with cleaner.unsafe setting. +
+
+
+ + remove_ore +
+
+ Registers an ore to be removed. + + + + +
    +
  • ore + Ore technical name. +
    • +
+ + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2021-07-12 15:47:16 +
+
+ + diff --git a/docs/reference/topics/settings.html b/docs/reference/topics/settings.html new file mode 100644 index 0000000..978a430 --- /dev/null +++ b/docs/reference/topics/settings.html @@ -0,0 +1,108 @@ + + + + + Cleaner mod for Minetest + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Topic settings

+

Cleaner Settings

+

+ +

+ + +

Settings

+ + + + + +
cleaner.unsafeEnables unsafe methods.
+ +
+
+ + +

Settings

+ +
+
+ + cleaner.unsafe +
+
+ Enables unsafe methods.

+ +

cleaner.remove_ore + +

Setting Type:

+
    + bool +
+

Default Value:

+
    + false +
+ + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2021-07-12 15:47:16 +
+
+ +