From 02489ec53077d44730b60ef16bc8f74263fad956 Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Mon, 12 Jul 2021 18:12:00 -0700 Subject: [PATCH] Re-generate HTML docs --- docs/reference/index.html | 2 +- docs/reference/topics/api.html | 79 ++++++++++++++++++++++++----- docs/reference/topics/commands.html | 2 +- docs/reference/topics/settings.html | 2 +- 4 files changed, 69 insertions(+), 16 deletions(-) diff --git a/docs/reference/index.html b/docs/reference/index.html index b84274e..ba30a7e 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -63,7 +63,7 @@
generated by LDoc 1.4.6 -Last updated 2021-07-12 15:47:16 +Last updated 2021-07-12 18:11:46
diff --git a/docs/reference/topics/api.html b/docs/reference/topics/api.html index c0db53e..f79fc2f 100644 --- a/docs/reference/topics/api.html +++ b/docs/reference/topics/api.html @@ -67,24 +67,32 @@ Retrieves list of nodes to be replaced. - cleaner.remove_entity (src) + cleaner.register_entity_removal (src) Registers an entity to be removed. - cleaner.remove_node (src) + cleaner.register_node_removal (src) Registers a node to be removed. - cleaner.replace_item (src, tgt) + cleaner.register_item_replacement (src, tgt) Registeres an item to be replaced. - cleaner.replace_node (src, tgt) + cleaner.register_node_replacement (src, tgt) Registers a node to be replaced.

Unsafe methods

+ + + + + + + + @@ -143,8 +151,8 @@
- - cleaner.remove_entity (src) + + cleaner.register_entity_removal (src)
Registers an entity to be removed. @@ -166,8 +174,8 @@
- - cleaner.remove_node (src) + + cleaner.register_node_removal (src)
Registers a node to be removed. @@ -189,8 +197,8 @@
- - cleaner.replace_item (src, tgt) + + cleaner.register_item_replacement (src, tgt)
Registeres an item to be replaced. @@ -216,8 +224,8 @@
- - cleaner.replace_node (src, tgt) + + cleaner.register_node_replacement (src, tgt)
Registers a node to be replaced. @@ -249,6 +257,51 @@ 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) @@ -279,7 +332,7 @@
generated by LDoc 1.4.6 -Last updated 2021-07-12 15:47:16 +Last updated 2021-07-12 18:11:46
diff --git a/docs/reference/topics/commands.html b/docs/reference/topics/commands.html index 666d769..b8c3133 100644 --- a/docs/reference/topics/commands.html +++ b/docs/reference/topics/commands.html @@ -244,7 +244,7 @@
generated by LDoc 1.4.6 -Last updated 2021-07-12 15:47:16 +Last updated 2021-07-12 18:11:46
diff --git a/docs/reference/topics/settings.html b/docs/reference/topics/settings.html index 978a430..a0c3011 100644 --- a/docs/reference/topics/settings.html +++ b/docs/reference/topics/settings.html @@ -101,7 +101,7 @@
generated by LDoc 1.4.6 -Last updated 2021-07-12 15:47:16 +Last updated 2021-07-12 18:11:46
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.