scripts/gui/unit-info-viewer.lua at master · UnknowableCoder/scripts

558 lines (495 loc) · 19.2 KB
--@module = true
local gui = require('gui')
local widgets = require('gui.widgets')
local skills_progress = reqscript('internal/unit-info-viewer/skills-progress')
--------------------------------------------------
---------------------- Time ----------------------
--------------------------------------------------
local TU_PER_DAY = 1200
if advmode then TU_PER_DAY = 86400 ? or only for cur_year_tick?
advmod_TU / 72 = ticks
local TU_PER_MONTH = TU_PER_DAY * 28
local TU_PER_YEAR = TU_PER_MONTH * 12
local MONTHS = {
    'Granite',
    'Slate',
    'Felsite',
    'Hematite',
    'Malachite',
    'Galena',
    'Limestone',
    'Sandstone',
    'Timber',
    'Moonstone',
    'Opal',
    'Obsidian',
Time = defclass(Time)
function Time:init(args)
    self.year = args.year or 0
    self.ticks = args.ticks or 0
function Time:getDays() -- >>float<< Days as age (including years)
    return self.year * 336 + (self.ticks / TU_PER_DAY)
function Time:getMonths() -- >>int<< Months as age (not including years)
    return self.ticks // TU_PER_MONTH
function Time:getMonthStr() -- Month as date
    return MONTHS[self:getMonths() + 1] or 'error'
function Time:getDayStr() -- Day as date
    local d = ((self.ticks % TU_PER_MONTH) // TU_PER_DAY) + 1
    if d == 11 or d == 12 or d == 13 then
        d = tostring(d) .. 'th'
    elseif d % 10 == 1 then
        d = tostring(d) .. 'st'
    elseif d % 10 == 2 then
        d = tostring(d) .. 'nd'
    elseif d % 10 == 3 then
        d = tostring(d) .. 'rd'
        d = tostring(d) .. 'th'
    return d
--function Time:__add()
function Time:__sub(other)
    if self.ticks < other.ticks then
        return Time{year=(self.year-other.year-1), ticks=(TU_PER_YEAR+self.ticks-other.ticks)}
        return Time{year=(self.year-other.year), ticks=(self.ticks-other.ticks)}
--------------------------------------------------
--------------------------------------------------
-- used in getting race/caste description strings
local PLURAL = 1
local PRONOUNS = {
    [df.pronoun_type.she] = 'She',
    [df.pronoun_type.he] = 'He',
    [df.pronoun_type.it] = 'It',
local function get_pronoun(unit)
    return PRONOUNS[unit.sex] or 'It'
local GHOST_TYPES = {
    [0] = 'A murderous ghost.',
    'A sadistic ghost.',
    'A secretive ghost.',
    'An energetic poltergeist.',
    'An angry ghost.',
    'A violent ghost.',
    'A moaning spirit returned from the dead.  It will generally trouble one unfortunate at a time.',
    'A howling spirit.  The ceaseless noise is making sleep difficult.',
    'A troublesome poltergeist.',
    'A restless haunt, generally troubling past acquaintances and relatives.',
    'A forlorn haunt, seeking out known locations or drifting around the place of death.',
local function get_ghost_type(unit)
    return GHOST_TYPES[unit.ghost_info.type] or 'A mysterious ghost.'
-- non-local since it is used by deathcause
DEATH_TYPES = {
    [0] = ' died of old age',                 -- OLD_AGE
    ' starved to death',                      -- HUNGER
    ' died of dehydration',                   -- THIRST
    ' was shot and killed',                   -- SHOT
    ' bled to death',                         -- BLEED
    ' drowned',                               -- DROWN
    ' suffocated',                            -- SUFFOCATE
    ' was struck down',                       -- STRUCK_DOWN
    ' was scuttled',                          -- SCUTTLE
    " didn't survive a collision",            -- COLLISION
    ' took a magma bath',                     -- MAGMA
    ' took a magma shower',                   -- MAGMA_MIST
    ' was incinerated by dragon fire',        -- DRAGONFIRE
    ' was killed by fire',                    -- FIRE
    ' experienced death by SCALD',            -- SCALD
    ' was crushed by cavein',                 -- CAVEIN
    ' was smashed by a drawbridge',           -- DRAWBRIDGE
    ' was killed by falling rocks',           -- FALLING_ROCKS
    ' experienced death by CHASM',            -- CHASM
    ' experienced death by CAGE',             -- CAGE
    ' was murdered',                          -- MURDER
    ' was killed by a trap',                  -- TRAP
    ' vanished',                              -- VANISH
    ' experienced death by QUIT',             -- QUIT
    ' experienced death by ABANDON',          -- ABANDON
    ' suffered heat stroke',                  -- HEAT
    ' died of hypothermia',                   -- COLD
    ' experienced death by SPIKE',            -- SPIKE
    ' experienced death by ENCASE_LAVA',      -- ENCASE_LAVA
    ' experienced death by ENCASE_MAGMA',     -- ENCASE_MAGMA
    ' was preserved in ice',                  -- ENCASE_ICE
    ' became headless',                       -- BEHEAD
    ' was crucified',                         -- CRUCIFY
    ' experienced death by BURY_ALIVE',       -- BURY_ALIVE
    ' experienced death by DROWN_ALT',        -- DROWN_ALT
    ' experienced death by BURN_ALIVE',       -- BURN_ALIVE
    ' experienced death by FEED_TO_BEASTS',   -- FEED_TO_BEASTS
    ' experienced death by HACK_TO_PIECES',   -- HACK_TO_PIECES
    ' choked on air',                         -- LEAVE_OUT_IN_AIR
    ' experienced death by BOIL',             -- BOIL
    ' melted',                                -- MELT
    ' experienced death by CONDENSE',         -- CONDENSE
    ' experienced death by SOLIDIFY',         -- SOLIDIFY
    ' succumbed to infection',                -- INFECTION
    "'s ghost was put to rest with a memorial", -- MEMORIALIZE
    ' scared to death',                       -- SCARE
    ' experienced death by DARKNESS',         -- DARKNESS
    ' experienced death by COLLAPSE',         -- COLLAPSE
    ' was drained of blood',                  -- DRAIN_BLOOD
    ' was slaughtered',                       -- SLAUGHTER
    ' became roadkill',                       -- VEHICLE
    ' killed by a falling object',            -- FALLING_OBJECT
local function get_death_type(death_cause)
    return DEATH_TYPES[death_cause] or ' died of unknown causes'
local function get_creature_data(unit)
    return df.global.world.raws.creatures.all[unit.race]
local function get_name_chunk(unit)
    return {
        text=dfhack.units.getReadableName(unit, true),
        pen=dfhack.units.getProfessionColor(unit)
local function get_translated_name_chunk(unit)
    local tname = dfhack.translation.translateName(dfhack.units.getVisibleName(unit), true)
    if #tname == 0 then return '' end
    return ('"%s"'):format(tname)
local function get_description_chunk(unit)
    local desc = dfhack.units.getCasteRaw(unit).description
    if #desc == 0 then return end
    return {text=desc, pen=COLOR_WHITE}
-- dead-dead not undead-dead
local function get_death_event(unit)
    if not dfhack.units.isKilled(unit) or unit.hist_figure_id == -1 then return end
    local events = df.global.world.history.events2
    for idx = #events - 1, 0, -1 do
        local e = events[idx]
        if df.history_event_hist_figure_diedst:is_instance(e) and e.victim_hf == unit.hist_figure_id then
            return e
        end
-- if undead/ghostly dead or dead-dead
local function get_death_incident(unit)
    if unit.counters.death_id > -1 then
        return df.global.world.incidents.all[unit.counters.death_id]
local function get_age_chunk(unit)
    if not dfhack.units.isAlive(unit) then return end
    local ident = dfhack.units.getIdentity(unit)
    local birth_date = ident and Time{year=ident.birth_year, ticks=ident.birth_second} or
        Time{year=unit.birth_year, ticks=unit.birth_time}
    local death_date
    local event = get_death_event(unit)
    if event then
        death_date = Time{year=e.year, ticks=e.seconds}
    local incident = get_death_incident(unit)
    if not death_date and incident then
        death_date = Time{year=incident.event_year, ticks=incident.event_time}
    local age
    if death_date then
        age = death_date - birth_date
        local cur_date = Time{year=df.global.cur_year, ticks=df.global.cur_year_tick}
        age = cur_date - birth_date
    local age_str
    if age.year > 1 then
        age_str = tostring(age.year) .. ' years old'
    elseif age.year > 0 then
        age_str = '1 year old'
        local age_m = age:getMonths()
        if age_m > 1 then
            age_str = tostring(age_m) .. ' months old'
        elseif age_m > 0 then
            age_str = '1 month old'
        else
            age_str = 'a newborn'
        end
    local blurb = ('%s is %s, born'):format(get_pronoun(unit), age_str)
    if birth_date.year < 0 then
        blurb = blurb .. ' before the dawn of time.'
    elseif birth_date.ticks < 0 then
        blurb = ('%s in the year %d.'):format(blurb, birth_date.year)
        blurb = ('%s on the %s of %s in the year %d.'):format(blurb,
            birth_date:getDayStr(), birth_date:getMonthStr(), birth_date.year)
    return {text=blurb, pen=COLOR_YELLOW}
local function get_max_age_chunk(unit)
    if not dfhack.units.isAlive(unit) then return end
    local caste = dfhack.units.getCasteRaw(unit)
    local blurb
    if caste.misc.maxage_min == -1 then
        blurb = ' only die of unnatural causes.'
        local avg_age = math.floor((caste.misc.maxage_max + caste.misc.maxage_min) // 2)
        if avg_age == 0 then
            blurb = ' usually die at a very young age.'
        elseif avg_age == 1 then
            blurb = ' live about 1 year.'
        else
            blurb = ' live about ' .. tostring(avg_age) .. ' years.'
        end
    blurb = caste.caste_name[PLURAL]:gsub("^%l", string.upper) .. blurb
    return {text=blurb, pen=COLOR_DARKGREY}
local function get_ghostly_chunk(unit)
    if not dfhack.units.isGhost(unit) then return end
    -- TODO: Arose in curse_year curse_time
    local blurb = get_ghost_type(unit) ..
        " This spirit has not been properly memorialized or buried."
    return {text=blurb, pen=COLOR_LIGHTMAGENTA}
local function get_dead_str(unit)
    local incident = get_death_incident(unit)
    if incident and incident.missing then
        return ' is missing.', COLOR_WHITE
    local event = get_death_event(unit)
    if event then
        --str = "The Caste_name Unit_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
        return get_death_type(event.death_cause) .. PERIOD, COLOR_MAGENTA
    elseif incident then
        --str = "The #{u.race_tg.name[0]}"
        --str << " #{u.name}" if u.name.has_name
        --str << " died"
        --str << " in year #{incident.event_year}" if incident
        --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
        return get_death_type(incident.death_cause) .. PERIOD, COLOR_MAGENTA
    elseif dfhack.units.isMarkedForSlaughter(unit) and dfhack.units.isKilled(unit) then
        return ' was slaughtered.', COLOR_MAGENTA
    elseif dfhack.units.isUndead(unit) then
        return ' is undead.', COLOR_GREY
        return ' is dead.', COLOR_MAGENTA
local function get_dead_chunk(unit)
    if dfhack.units.isAlive(unit) then return end
    local str, pen = get_dead_str(unit)
    return {text=dfhack.units.getReadableName(unit)..str, pen=pen}
-- the metrics of the universe
local ELEPHANT_SIZE = 500000
local DWARF_SIZE = 6000
local CAT_SIZE = 500
local function get_conceivable_comparison(unit)
    --[[ the objective here is to get a (resaonably) small number to help concieve
    how large a thing is. "83 dwarves" doesn't really help convey the size of an
    elephant much better than 5m cc, so at certain breakpoints we will use
    different animals --]]
    local size = unit.body.size_info.size_cur
    local comparison_name, comparison_name_plural, comparison_size
    if size > DWARF_SIZE*20 and get_creature_data(unit).creature_id ~= "ELEPHANT" then
        comparison_name, comparison_name_plural, comparison_size = 'elephant', 'elephants', ELEPHANT_SIZE
    elseif size <= DWARF_SIZE*0.25 and get_creature_data(unit).creature_id ~= "CAT" then
        comparison_name, comparison_name_plural, comparison_size = 'cat', 'cats', CAT_SIZE
        comparison_name, comparison_name_plural, comparison_size = 'dwarf', 'dwarves', DWARF_SIZE
    local ratio = size / comparison_size
    if ratio == 1 then
        return ('1 average %s'):format(comparison_name)
    for precision=1,4 do
        if ratio >= 1/(10^precision) then
            return ('%%.%df average %%s'):format(precision):format(ratio, comparison_name_plural)
        end
    return string.format('a miniscule part of an %s', comparison_name)
local function get_size_compared_to_median(unit)
    local size_modifier = unit.appearance.size_modifier
    if size_modifier >= 110 then
        return "larger than average"
    elseif size_modifier <= 90 then
        return "smaller than average"
        return "about average"
local function get_body_chunk(unit)
    local blurb = ('%s weighs about as much as %s'):format(get_pronoun(unit), get_conceivable_comparison(unit))
    return {text=blurb, pen=COLOR_LIGHTBLUE}
local function format_size_in_cc(unit)
    -- internal measure is cubic centimeters divided by 10
    local cc = unit.body.size_info.size_cur * 10
    return dfhack.formatInt(cc)
local function get_average_size(unit)
    local blurb = ('%s is %s cc, which is %s in size.')
        :format(get_pronoun(unit), format_size_in_cc(unit), get_size_compared_to_median(unit))
    return{text=blurb, pen=COLOR_LIGHTCYAN}
local function get_grazer_chunk(unit)
    if not dfhack.units.isGrazer(unit) then return end
    local caste = dfhack.units.getCasteRaw(unit)
    local blurb = 'Grazing satisfies ' .. tostring(caste.misc.grazer) .. ' units of hunger.'
    return {text=blurb, pen=COLOR_LIGHTGREEN}
local function get_milkable_chunk(unit)
    if not dfhack.units.isAlive(unit) or not dfhack.units.isMilkable(unit) then return end
    if not dfhack.units.isAnimal(unit) then return end
    local caste = dfhack.units.getCasteRaw(unit)
    local milk = dfhack.matinfo.decode(caste.extracts.milkable_mat, caste.extracts.milkable_matidx)
    if not milk then return end
    local days, seconds = math.modf(caste.misc.milkable / TU_PER_DAY)
    local blurb = (seconds > 0) and (tostring(days) .. ' to ' .. tostring(days + 1)) or tostring(days)
    if dfhack.units.isAdult(unit) then
        blurb = ('%s secretes %s every %s days.'):format(get_pronoun(unit), milk:toString(), blurb)
        blurb = ('%s secrete %s every %s days.'):format(caste.caste_name[PLURAL], milk:toString(), blurb)
    return {text=blurb, pen=COLOR_LIGHTCYAN}
local function get_shearable_chunk(unit)
    if not dfhack.units.isAlive(unit) then return end
    if not dfhack.units.isAnimal(unit) then return end
    local caste = dfhack.units.getCasteRaw(unit)
    local mat_types = caste.body_info.materials.mat_type
    local mat_idxs = caste.body_info.materials.mat_index
    for idx, mat_type in ipairs(mat_types) do
        local mat_info = dfhack.matinfo.decode(mat_type, mat_idxs[idx])
        if mat_info and mat_info.material.flags.YARN then
            local blurb
            if dfhack.units.isAdult(unit) then
                blurb = ('%s produces %s.'):format(get_pronoun(unit), mat_info:toString())
            else
                blurb = ('%s produce %s.'):format(caste.caste_name[PLURAL], mat_info:toString())
            return {text=blurb, pen=COLOR_BROWN}
        end
local function get_egg_layer_chunk(unit)
    if not dfhack.units.isAlive(unit) or not dfhack.units.isEggLayer(unit) then return end
    local caste = dfhack.units.getCasteRaw(unit)
    local clutch = (caste.misc.clutch_size_max + caste.misc.clutch_size_min) // 2
    local blurb = ('She lays clutches of about %d egg%s.'):format(clutch, clutch == 1 and '' or 's')
    return {text=blurb, pen=COLOR_GREEN}
----------------------------
-- UnitInfo
UnitInfo = defclass(UnitInfo, widgets.Window)
UnitInfo.ATTRS {
    frame_title='Unit info',
    frame={w=50, h=25},
    resizable=true,
    resize_min={w=40, h=10},
function UnitInfo:init()
    self.unit_id = nil
    self:addviews{
        widgets.Label{
            view_id='nameprof',
            frame={t=0, l=0, h=1},
            auto_height=false,
        widgets.Label{
            view_id='translated_name',
            frame={t=1, l=0, h=1},
            auto_height=false,
        widgets.Label{
            view_id='chunks',
            frame={t=3, l=0, b=0, r=0},
            auto_height=false,
            text='Please select a unit.',
local function add_chunk(chunks, chunk, width)
    if not chunk then return end
    if type(chunk) == 'string' then
        table.insert(chunks, chunk:wrap(width))
        table.insert(chunks, NEWLINE)
        for _, line in ipairs(chunk.text:wrap(width):split(NEWLINE)) do
            local newchunk = copyall(chunk)
            newchunk.text = line
            table.insert(chunks, newchunk)
            table.insert(chunks, NEWLINE)
        end
    table.insert(chunks, NEWLINE)
function UnitInfo:refresh(unit, width)
    self.unit_id = unit.id
    self.subviews.nameprof:setText{get_name_chunk(unit)}
    self.subviews.translated_name:setText{get_translated_name_chunk(unit)}
    local chunks = {}
    add_chunk(chunks, get_description_chunk(unit), width)
    add_chunk(chunks, get_age_chunk(unit), width)
    add_chunk(chunks, get_max_age_chunk(unit), width)
    add_chunk(chunks, get_ghostly_chunk(unit), width)
    add_chunk(chunks, get_dead_chunk(unit), width)
    add_chunk(chunks, get_average_size(unit), width)
    if get_creature_data(unit).creature_id ~= "DWARF" then
        add_chunk(chunks, get_body_chunk(unit), width)
    add_chunk(chunks, get_grazer_chunk(unit), width)
    add_chunk(chunks, get_milkable_chunk(unit), width)
    add_chunk(chunks, get_shearable_chunk(unit), width)
    add_chunk(chunks, get_egg_layer_chunk(unit), width)
    self.subviews.chunks:setText(chunks)
function UnitInfo:check_refresh(force)
    local unit = dfhack.gui.getSelectedUnit(true)
    if unit and (force or unit.id ~= self.unit_id) then
        self:refresh(unit, self.frame_body.width-3)
function UnitInfo:postComputeFrame()
    -- re-wrap
    self:check_refresh(true)
function UnitInfo:render(dc)
    self:check_refresh()
    UnitInfo.super.render(self, dc)
----------------------------
-- UnitInfoScreen
UnitInfoScreen = defclass(UnitInfoScreen, gui.ZScreen)
UnitInfoScreen.ATTRS {
    focus_path='unit-info-viewer',
function UnitInfoScreen:init()
    self:addviews{UnitInfo{}}
function UnitInfoScreen:onDismiss()
    view = nil
OVERLAY_WIDGETS = {
    skillprogress=skills_progress.SkillProgressOverlay,
if dfhack_flags.module then
view = view and view:raise() or UnitInfoScreen{}:show()
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

unit-info-viewer.lua

Latest commit

History

unit-info-viewer.lua

File metadata and controls
