Skip to content

Update exterminate script and documentation #1489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update exterminate script and documentation #1489

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
170565a
Update exterminate script and documentation
unboundlopez Aug 8, 2025
c24b0d4
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 8, 2025
344a526
Merge branch 'master' into update-exterminate
unboundlopez Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions exterminate.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
--@module = true

local argparse = require('argparse')
-- for profession constants
local profession = df.profession

local function spawnLiquid(position, liquid_level, liquid_type, update_liquids)
local map_block = dfhack.maps.getTileBlock(position)
Expand Down Expand Up @@ -28,9 +30,14 @@ local function checkUnit(opts, unit)
if not opts.include_friendly and not dfhack.units.isDanger(unit) and not dfhack.units.isWildlife(unit) then
return false
end
-- filter by caste if specified
if opts.selected_caste and opts.selected_caste ~= df.creature_raw.find(unit.race).caste[unit.caste].caste_id then
return false
end
-- filter only children if requested
if opts.children_only and unit.profession ~= profession.CHILD then
return false
end
return true
end

Expand Down Expand Up @@ -167,13 +174,15 @@ local options, args = {
only_visible = false,
include_friendly = false,
limit = -1,
children_only = false,
}, {...}

local positionals = argparse.processArgsGetopt(args, {
{'h', 'help', handler = function() options.help = true end},
{'m', 'method', handler = function(arg) options.method = killMethod[arg:upper()] end, hasArg = true},
{'o', 'only-visible', handler = function() options.only_visible = true end},
{'f', 'include-friendly', handler = function() options.include_friendly = true end},
{'c', 'children-only', handler = function() options.children_only = true end},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer that if you're going to add "children-only" you should also add "adult-only" just for parallelism

also, this won't kill babies. is this intended? should it kill babies? if not, should it offer a "baby-only" option?

{'l', 'limit', handler = function(arg) options.limit = argparse.positiveInt(arg, 'limit') end, hasArg = true},
})

Expand Down