modcleaner/init.lua

--[[ Clean Entities mod
     License: CC0
]]


cleane = {}
cleane.name = core.get_current_modname()

local debug = core.settings:get_bool('enable_debug_mods')

local function log(level, msg)
	core.log(level, '[' .. cleane.name .. '] ' .. msg)
end

local function logDebug(msg)
	if debug then
		core.log('DEBUG: [' .. cleane.name .. '] ' .. msg)
	end
end

local old_nodes = {}
local old_entities = {}

-- Old/Missing nodes that should be replaced with something currently in game
local replace_nodes = {}


-- "Replaces" an old/non-existent node
local function replace_node(old_node, new_node)
    core.register_alias(old_node, new_node)
end


for _,node_name in ipairs(old_nodes) do
    core.register_node(':' .. node_name, {
        groups = {old=1},
    })
end

core.register_abm({
    nodenames = {'group:old'},
    interval = 1,
    chance = 1,
    action = function(pos, node)
        core.remove_node(pos)
    end,
})


-- Populate entities list from file in world path
local e_list = nil
local e_path = core.get_worldpath() .. '/clean_entities.txt'
local e_file = io.open(e_path, 'r')
if e_file then
	e_list = e_file:read('*a')
	e_file:close()
else
	-- Create empty file
	e_file = io.open(e_path, 'w')
	if e_file then
		e_file:close()
	end
end

if e_list then
	logDebug('Loading entities to clean from file ...')
	
	e_list = string.split(e_list, '\n')
	for _, entity_name in ipairs(e_list) do
		table.insert(old_entities, entity_name)
	end
end

for _, entity_name in ipairs(old_entities) do
	logDebug('Cleaning entity: ' .. entity_name)
	
    core.register_entity(':' .. entity_name, {
        on_activate = function(self, staticdata)
            self.object:remove()
        end,
    })
end

-- Replace old nodes
for _, node_group in pairs(replace_nodes) do
    replace_node(node_group[1], node_group[2])
end