From e75ee0ccd8c020de9ff4e819559ccf0bf114955d Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Mon, 12 Jul 2021 08:45:22 -0700 Subject: [PATCH] Add Lua docstrings --- api.lua | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/api.lua b/api.lua index 5f9bbbe..6524727 100644 --- a/api.lua +++ b/api.lua @@ -1,17 +1,31 @@ +--- Cleaner API +-- +-- @topic api + + local replace_items = {} local replace_nodes = {} +--- Retrieves list of items to be replaced. +-- +-- @treturn table Items to be replaced. function cleaner.get_replace_items() return replace_items end +--- Retrieves list of nodes to be replaced. +-- +-- @treturn table Nodes to be replaced. function cleaner.get_replace_nodes() return replace_nodes end +--- Registers an entity to be removed. +-- +-- @tparam string src Entity technical name. function cleaner.remove_entity(src) core.register_entity(":" .. src, { on_activate = function(self, staticdata) @@ -20,16 +34,27 @@ function cleaner.remove_entity(src) }) end +--- Registers a node to be removed. +-- +-- @tparam string src Node technical name. function cleaner.remove_node(src) core.register_node(":" .. src, { groups = {to_remove=1}, }) end +--- Registeres an item to be replaced. +-- +-- @tparam string src Technical name of item to be replaced. +-- @tparam string tgt Technical name of item to be used in place. function cleaner.replace_item(src, tgt) replace_items[src] = tgt end +--- Registers a node to be replaced. +-- +-- @tparam string src Technical name of node to be replaced. +-- @tparam string tgt Technical name of node to be used in place. function cleaner.replace_node(src, tgt) core.register_node(":" .. src, { groups = {to_replace=1},