0siribix/mod-cleaner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Lua docstrings

Browse Source
This commit is contained in:
Jordan Irwin 2021-07-12 08:45:22 -07:00
parent 261d0ed5e7
commit e75ee0ccd8
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
api.lua
View File

@ -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},