Update to use a wrapper function to accept unit OR histfig

Author: realSquidCoder

deathcause.lua

@@ -26,7 +26,7 @@ local function getDeathStringFromCause(cause)
 end
 
 -- Returns a cause of death given a unit
-function getDeathCauseFromUnit(unit)
+local function getDeathCauseFromUnit(unit)
     local str = unit.name.has_name and '' or 'The '
     str = str .. dfhack.units.getReadableName(unit)
 
@@ -104,7 +104,7 @@ local function getDeathEventForHistFig(histfig_id)
 end
 
 -- Returns the cause of death given a histfig
-function getDeathCauseFromHistFig(histfig)
+local function getDeathCauseFromHistFig(histfig)
     local histfig_unit = df.unit.find(histfig.unit_id)
     if not histfig_unit then
         qerror("Cause of death not available")
@@ -149,6 +149,15 @@ local function get_target()
     return selected_item.hist_figure_id, df.unit.find(selected_item.unit_id)
 end
 
+-- wrapper function to take either a unit or a histfig and get the death cause
+function getDeathCause(target)
+    if df.unit:is_instance(target) then
+        return getDeathCauseFromUnit(target)
+    else
+        return getDeathCauseFromHistFig(target)
+    end
+end
+
 if dfhack_flags.module then
     return
 end
@@ -161,7 +170,7 @@ elseif hist_figure_id == -1 then
     if not selected_unit then
         qerror("Cause of death not available")
     end
-    print(dfhack.df2console(getDeathCauseFromUnit(selected_unit)))
+    print(dfhack.df2console(getDeathCause(selected_unit)))
 else
-    print(dfhack.df2console(getDeathCauseFromHistFig(df.historical_figure.find(hist_figure_id))))
+    print(dfhack.df2console(getDeathCause(df.historical_figure.find(hist_figure_id))))
 end

docs/deathcause.rst

@@ -23,14 +23,11 @@ commandline interface with ``dfhack.run_script()`` or via the API functions
 defined in :source-scripts:`deathcause.lua`, available from the return value of
 ``reqscript('deathcause')``:
 
-* ``getDeathCauseFromHistFig(histfig)``
+* ``getDeathCause(unit or historical_figure)``
 
-Returns a string with the historical figure's cause of death, sometimes with more information
-than with a unit.
+Returns a string with the unit or historical figure's cause of death. Note that using a historical
+figure will sometimes provide more information than using a unit.
 
-* ``getDeathCauseFromUnit(unit)``
-
-Returns a string with the unit's cause of death.
 
  API usage example::