Rename API methods

This commit is contained in:
Jordan Irwin 2021-07-12 17:04:24 -07:00
parent d065c3f7ae
commit 37ca2b7dab
5 changed files with 8 additions and 9 deletions

View file

@ -2,5 +2,4 @@
TODO: TODO:
- add localization support - add localization support
- add support for unregistering ores via world path file - add support for unregistering ores via world path file
- change API method names to "register_[replace/remove]_*"
- use single json file for cleaning all types - use single json file for cleaning all types

View file

@ -26,7 +26,7 @@ end
--- Registers an entity to be removed. --- Registers an entity to be removed.
-- --
-- @tparam string src Entity technical name. -- @tparam string src Entity technical name.
function cleaner.remove_entity(src) function cleaner.register_entity_removal(src)
core.register_entity(":" .. src, { core.register_entity(":" .. src, {
on_activate = function(self, ...) on_activate = function(self, ...)
self.object:remove() self.object:remove()
@ -37,7 +37,7 @@ end
--- Registers a node to be removed. --- Registers a node to be removed.
-- --
-- @tparam string src Node technical name. -- @tparam string src Node technical name.
function cleaner.remove_node(src) function cleaner.register_node_removal(src)
core.register_node(":" .. src, { core.register_node(":" .. src, {
groups = {to_remove=1}, groups = {to_remove=1},
}) })
@ -47,7 +47,7 @@ end
-- --
-- @tparam string src Technical name of 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. -- @tparam string tgt Technical name of item to be used in place.
function cleaner.replace_item(src, tgt) function cleaner.register_item_replacement(src, tgt)
replace_items[src] = tgt replace_items[src] = tgt
end end
@ -55,7 +55,7 @@ end
-- --
-- @tparam string src Technical name of 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. -- @tparam string tgt Technical name of node to be used in place.
function cleaner.replace_node(src, tgt) function cleaner.register_node_replacement(src, tgt)
core.register_node(":" .. src, { core.register_node(":" .. src, {
groups = {to_replace=1}, groups = {to_replace=1},
}) })

View file

@ -46,5 +46,5 @@ end
for _, e in ipairs(e_list.remove) do for _, e in ipairs(e_list.remove) do
cleaner.log("debug", "Cleaning entity: " .. e) cleaner.log("debug", "Cleaning entity: " .. e)
cleaner.remove_entity(e) cleaner.register_entity_removal(e)
end end

View file

@ -26,7 +26,7 @@ if i_file then
end end
for i_old, i_new in pairs(i_list.replace) do for i_old, i_new in pairs(i_list.replace) do
cleaner.replace_item(i_old, i_new) cleaner.register_item_replacement(i_old, i_new)
end end
-- register actions for after server startup -- register actions for after server startup

View file

@ -50,7 +50,7 @@ end
for _, n in ipairs(n_list.remove) do for _, n in ipairs(n_list.remove) do
cleaner.log("debug", "Cleaning node: " .. n) cleaner.log("debug", "Cleaning node: " .. n)
cleaner.remove_node(n) cleaner.register_node_removal(n)
end end
core.register_lbm({ core.register_lbm({
@ -64,7 +64,7 @@ core.register_lbm({
for n_old, n_new in pairs(n_list.replace) do for n_old, n_new in pairs(n_list.replace) do
cleaner.log("debug", "Replacing node \"" .. n_old .. "\" with \"" .. n_new .. "\"") cleaner.log("debug", "Replacing node \"" .. n_old .. "\" with \"" .. n_new .. "\"")
cleaner.replace_node(n_old, n_new) cleaner.register_node_replacement(n_old, n_new)
end end
core.register_lbm({ core.register_lbm({