SpecialFlavorText.lua

--[[
	author: Aussiemon

	-----

	Copyright 2018 Aussiemon

	Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

	-----

	Provides more information about things that happen to specials.
--]]

local mod_name = "SpecialFlavorText"

-- ##########################################################
-- ################## Variables #############################

local flavor_text_list = {
	deactivate_area = {
		" left to pursue other targets.",
	},
	stuck = {
		" was caught in a trap.",
	},
	far_away = {
		" lost sight of the heroes.",
	},
	main_path_blocked = {
		" was blocked from pursuing the heroes.",
	},
	no_path_found = {
		" couldn't continue on.",
	},
	intentionally_destroyed = {
		" was murdered by an unseen hand.",
	},
	out_of_range = {
		" lost track of the hunt.",
	},
	gas_explosion = {
		" exploded in a cloud of poison gas.",
	},
	death_zone = {
		" was caught in a dangerous place.",
	},
	crushed = {
		" was crushed by falling debris.",
	},
	poison = {
		" fell to the Callach's Claws.",
	},
	forced = {
		" suffered a hard impact.",
	},
	push = {
		" collapsed.",
	},
	volume_insta_kill = {
		" fell to their death.",
	},
	globadier_gas_dot = {
		" inhaled poison gas.",
	},
	inside_forbidden_tag_volume = {
		" fell out of the world.",
	},
	kinetic = {
		" was killed by a powerful force.",
	},
}

local special_breeds = {
	skaven_gutter_runner = "Gutter Runner",
	skaven_ratling_gunner = "Ratling Gunner",
	skaven_pack_master = "Packmaster",
	skaven_poison_wind_globadier = "Globadier",
	skaven_storm_vermin_champion = "Stormvermin Chieftain",
	skaven_rat_ogre = "Rat Ogre",
	skaven_loot_rat = "Sack Rat",
}

local event_colors = {
	fade_to = Colors.get_table("white"),
	default = Colors.get_table("cheeseburger"),
	kill = Colors.get_table("red"),
	personal = Colors.get_table("dodger_blue")
}

SpecialFlavorText = {}

-- ##########################################################
-- ################## Functions #############################

SpecialFlavorText.send_message = function(message)
	safe_pcall(function()
		local managers = Managers
		local player_manager = managers.player
		local local_player = player_manager:local_player()
		local stats_id = local_player.stats_id(local_player)

		local managers_state = managers.state
		local event_manager = managers_state.event

		event_manager:trigger("add_personal_interaction_warning", stats_id .. message, message)
	end)
	return
end

SpecialFlavorText.choose_message = function(breed_name, reason)
	if flavor_text_list[reason] then
		local num_options = #flavor_text_list[reason]
		if 0 < num_options then
			local flavor_text = flavor_text_list[reason][math.random(num_options)]
			return "A " .. (special_breeds[breed_name] or "rat") .. flavor_text
		end
	else
		EchoConsole("Unrecognized reason: " .. tostring(reason))
	end

	return ""
end

-- ##########################################################
-- #################### Hooks ###############################

-- When a unit is destroyed by the director, print a message.
Mods.hook.set(mod_name, "ConflictDirector.destroy_unit", function (func, self, unit, blackboard, reason)
	safe_pcall(function()
		local breed = blackboard.breed
		local breed_name = breed.name
		if reason and breed_name and special_breeds[breed_name] then
			local send_message = SpecialFlavorText.send_message
			local choose_message = SpecialFlavorText.choose_message

			-- Display flavor text
			send_message(choose_message(breed_name, reason))
		end
	end)

	local result = func(self, unit, blackboard, reason)
	return result
end)

Mods.hook.set(mod_name, "AiUtils.poison_explode_unit", function (func, unit, action, blackboard)
	safe_pcall(function()
		local breed = blackboard.breed
		local breed_name = breed.name
		if breed_name and special_breeds[breed_name] then
			local send_message = SpecialFlavorText.send_message
			local choose_message = SpecialFlavorText.choose_message

			-- Display flavor text
			local reason = "gas_explosion"
			send_message(choose_message(breed_name, reason))
		end
	end)

	local result = func(unit, action, blackboard)
	return result
end)

Mods.hook.set(mod_name, "AiUtils.kill_unit", function (func, victim_unit, attacker_unit, hit_zone_name, damage_type, damage_direction)
	safe_pcall(function()
		local AiUtils_breed_name = AiUtils.breed_name
		local breed_name = AiUtils_breed_name(victim_unit)
		local reason = damage_type
		if reason and breed_name and special_breeds[breed_name] then
			local send_message = SpecialFlavorText.send_message
			local choose_message = SpecialFlavorText.choose_message

			-- Display flavor text
			send_message(choose_message(breed_name, reason))
		end
	end)

	local result = func(victim_unit, attacker_unit, hit_zone_name, damage_type, damage_direction)
	return result
end)

-- Remove localization to just print message as-is.
Mods.hook.set(mod_name, "PositiveReinforcementUI.event_add_interaction_warning", function (func, self, hash, message)
	self.add_event(self, hash, true, event_colors.kill, "interaction_warning", message)
	return
end)

-- ##########################################################
-- ################### Script ###############################

-- ##########################################################