dfhack/scripts/deathcause.rb

# show death cause of a creature

def display_death_event(e)
	str = "The #{e.victim_hf_tg.race_tg.name[0]} #{e.victim_hf_tg.name} died in year #{e.year}"
	str << " (cause: #{e.death_cause.to_s.downcase}),"
	str << " killed by the #{e.slayer_race_tg.name[0]} #{e.slayer_hf_tg.name}" if e.slayer_hf != -1
	str << " using a #{df.world.raws.itemdefs.weapons[e.weapon.item_subtype].name}" if e.weapon.item_type == :WEAPON
	str << ", shot by a #{df.world.raws.itemdefs.weapons[e.weapon.bow_item_subtype].name}" if e.weapon.bow_item_type == :WEAPON

	puts str.chomp(',') + '.'
end

def display_death_unit(u)
	death_info = u.counters.death_tg
	killer = death_info.killer_tg if death_info

	str = "The #{u.race_tg.name[0]}"
	str << " #{u.name}" if u.name.has_name
	str << " died"
	str << " in year #{death_info.event_year}" if death_info
	str << " (cause: #{u.counters.death_cause.to_s.downcase})," if u.counters.death_cause != -1
	str << " killed by the #{killer.race_tg.name[0]} #{killer.name}" if killer

	puts str.chomp(',') + '.'
end

item = df.item_find(:selected)
unit = df.unit_find(:selected)

if !item or !item.kind_of?(DFHack::ItemBodyComponent)
	item = df.world.items.other[:ANY_CORPSE].find { |i| df.at_cursor?(i) }
end

if item and item.kind_of?(DFHack::ItemBodyComponent)
	hf = item.hist_figure_id
elsif unit
	hf = unit.hist_figure_id
end

if not hf
	puts "Please select a corpse in the loo'k' menu, or an unit in the 'u'nitlist screen"

elsif hf == -1
	if unit ||= item.unit_tg
		display_death_unit(unit)
	else
		puts "Not a historical figure, cannot death find info"
	end

else
	histfig = df.world.history.figures.binsearch(hf)
	unit = histfig ? df.unit_find(histfig.unit_id) : nil
	if unit and not unit.flags1.dead and not unit.flags3.ghostly
		puts "#{unit.name} is not dead yet !"

	else
		events = df.world.history.events
		(0...events.length).reverse_each { |i|
			e = events[i]
			if e.kind_of?(DFHack::HistoryEventHistFigureDiedst) and e.victim_hf == hf
				display_death_event(e)
				break
			end
		}
	end
end