MineClone2/mods/HUD/mcl_death_messages/init.lua

local S = minetest.get_translator(minetest.get_current_modname())

local ASSIST_TIMEOUT_SEC = 5

mcl_death_messages = {
	assist = {},
	messages = {
		in_fire = {
			_translator = S,
			plain = "@1 went up in flames",
			assist = "@1 walked into fire whilst fighting @2",
		},
		lightning_bolt = {
			_translator = S,
			plain = "@1 was struck by lightning",
			assist = "@1 was struck by lightning whilst fighting @2",
		},
		on_fire = {
			_translator = S,
			plain = "@1 burned to death",
			assist = "@1 was burnt to a crisp whilst fighting @2",
		},
		lava = {
			_translator = S,
			plain = "@1 tried to swim in lava",
			assist = "@1 tried to swim in lava to escape @2"
		},
		hot_floor = {
			_translator = S,
			plain = "@1 discovered the floor was lava",
			assist = "@1 walked into danger zone due to @2",
		},
		in_wall = {
			_translator = S,
			plain = "@1 suffocated in a wall",
			assist = "@1 suffocated in a wall whilst fighting @2",
		},
		drown = {
			_translator = S,
			plain = "@1 drowned",
			assist = "@1 drowned whilst trying to escape @2",
		},
		starve = {
			_translator = S,
			plain = "@1 starved to death",
			assist = "@1 starved to death whilst fighting @2",
		},
		cactus = {
			_translator = S,
			plain = "@1 was pricked to death",
			assist = "@1 walked into a cactus whilst trying to escape @2",
		},
		fall = {
			_translator = S,
			plain = "@1 hit the ground too hard",
			assist = "@1 hit the ground too hard whilst trying to escape @2",
			-- "@1 fell from a high place" -- for fall distance > 5 blocks
			-- "@1 fell while climbing"
			-- "@1 fell off some twisting vines"
			-- "@1 fell off some weeping vines"
			-- "@1 fell off some vines"
			-- "@1 fell off scaffolding"
			-- "@1 fell off a ladder"
		},
		fly_into_wall = {
			_translator = S,
			plain = "@1 experienced kinetic energy",
			assist = "@1 experienced kinetic energy whilst trying to escape @2",
		},
		out_of_world = {
			_translator = S,
			plain = "@1 fell out of the world",
			assist = "@1 didn't want to live in the same world as @2",
		},
		generic = {
			_translator = S,
			plain = "@1 died",
			assist = "@1 died because of @2",
		},
		magic = {
			_translator = S,
			plain = "@1 was killed by magic",
			assist = "@1 was killed by magic whilst trying to escape @2",
			killer = "@1 was killed by @2 using magic",
			item = "@1 was killed by @2 using @3",
		},
		dragon_breath = {
			_translator = S,
			plain = "@1 was roasted in dragon breath",
			killer = "@1 was roasted in dragon breath by @2",
		},
		wither = {
			_translator = S,
			plain = "@1 withered away",
			escape = "@1 withered away whilst fighting @2",
		},
		wither_skull = {
			_translator = S,
			plain = "@1 was killed by magic",
			killer = "@1 was shot by a skull from @2",
		},
		anvil = {
			_translator = S,
			plain = "@1 was squashed by a falling anvil",
			escape = "@1 was squashed by a falling anvil whilst fighting @2",
		},
		falling_node = {
			_translator = S,
			plain = "@1 was squashed by a falling block",
			assist = "@1 was squashed by a falling block whilst fighting @2",
		},
		mob = {
			_translator = S,
			killer = "@1 was slain by @2",
			item = "@1 was slain by @2 using @3",
		},
		player = {
			_translator = S,
			killer = "@1 was slain by @2",
			item = "@1 was slain by @2 using @3"
		},
		arrow = {
			_translator = S,
			killer = "@1 was shot by @2",
			item = "@1 was shot by @2 using @3",
		},
		fireball = {
			_translator = S,
			killer = "@1 was fireballed by @2",
			item = "@1 was fireballed by @2 using @3",
		},
		thorns = {
			_translator = S,
			killer = "@1 was killed trying to hurt @2",
			item = "@1 tried to hurt @2 and died by @3",
		},
		explosion = {
			_translator = S,
			plain = "@1 blew up",
			killer = "@1 was blown up by @2",
			item = "@1 was blown up by @2 using @3",
			-- "@1 was killed by [Intentional Game Design]" -- for exploding bed in nether or end
		},
		cramming = {
			_translator = S,
			plain = "@1 was squished too much",
			assist = "@1 was squashed by @2",	-- surprisingly "escape" is actually the correct subtype
		},
		fireworks = {
			_translator = S,
			plain = "@1 went off with a bang",
			item = "@1 went off with a bang due to a firework fired by @2 from @3",
		},
		sweet_berry = {
			_translator = S,
			plain = "@1 died a sweet death",
			assist = "@1 was poked to death by a sweet berry bush whilst trying to escape @2",
		},
		-- Missing snowballs: The Minecraft wiki mentions them but the MC source code does not.
	},
}

local function get_item_killer_message(obj, messages, reason)
	if messages.item then
		local wielded = mcl_util.get_wielded_item(reason.source)
		local itemname = wielded:get_meta():get_string("name")
		if itemname ~= "" then
			itemname = "[" .. itemname .. "]"
			if mcl_enchanting.is_enchanted(wielded:get_name()) then
				itemname = minetest.colorize(mcl_colors.AQUA, itemname)
			end
			return messages._translator(messages.item, mcl_util.get_object_name(obj), mcl_util.get_object_name(reason.source), itemname)
		end
	end
end

local function get_plain_killer_message(obj, messages, reason)
	return messages.killer and messages._translator(messages.killer, mcl_util.get_object_name(obj), mcl_util.get_object_name(reason.source))
end

local function get_killer_message(obj, messages, reason)
	return reason.source and (get_item_killer_message(obj, messages, reason) or get_plain_killer_message(obj, messages, reason))
end

local function get_assist_message(obj, messages, reason)
	-- Avoid a timing issue if the assist passes its timeout.
	local assist_details = mcl_death_messages.assist[obj]
	if messages.assist and assist_details then
		return messages._translator(messages.assist, mcl_util.get_object_name(obj), assist_details.name)
	end
end

local function get_plain_message(obj, messages, reason)
	if messages.plain then
		return messages._translator(messages.plain, mcl_util.get_object_name(obj))
	end
end

local function get_fallback_message(obj, messages, reason)
	return "mcl_death_messages.messages." .. reason.type .. " " .. mcl_util.get_object_name(obj)
end

local function fallback_translator(s)
	return s
end

mcl_damage.register_on_death(function(obj, reason)
	if not minetest.settings:get_bool("mcl_showDeathMessages", true) then
		return
	end

	local send_to

	if obj:is_player() then
		send_to = true
	end

	-- ToDo: add mob death messages for owned mobs, only send to owner (sent_to = "player name")

	if send_to then
		local messages = mcl_death_messages.messages[reason.type] or {}
		messages._translator = messages._translator or fallback_translator

		local message =
			get_killer_message(obj, messages, reason) or
			get_assist_message(obj, messages, reason) or
			get_plain_message(obj, messages, reason) or
			get_fallback_message(obj, messages, reason)

		if send_to == true then
			minetest.chat_send_all(message)
		else
			minetest.chat_send_player(send_to, message)
		end
	end
end)

mcl_damage.register_on_damage(function(obj, damage, reason)
	if (obj:get_hp() - damage > 0) and reason.source and
			(reason.source:is_player() or obj:get_luaentity()) then
		-- To avoid timing issues we cancel the previous job before adding a new one.
		if mcl_death_messages.assist[obj] then
			mcl_death_messages.assist[obj].job:cancel()
		end

		-- Add a new assist object with a timeout job.
		local new_job = minetest.after(ASSIST_TIMEOUT_SEC, function()
			mcl_death_messages.assist[obj] = nil
		end)
		mcl_death_messages.assist[obj] = {name = mcl_util.get_object_name(reason.source), job = new_job}
	end
end)