Update Exterminate #1187

Crystalwarrior · 2024-06-15T21:05:56Z

Fix it crashing adventure mode due to outdated item deletion method
Add --x (--max) argument, letting you set an extermination cap
Teleport disintegrated units to the top of the world so they are not seen dying

…te" option Swap to dfhack.items.remove(item) method of destroying an item Add a --maximum options to set maximum number of units to exterminate

…emove(item) anymore?

…to z-level 0 instead?) Add a "maximum" option letting you exterminate up to a cap

myk002

please add documentation to docs/exterminate.rst and changelog.txt

exterminate.lua

Don't teleport unit on DISINTEGRATE method Add documentation for new features

changelog.txt

myk002 · 2024-06-22T01:17:54Z

docs/exterminate.rst

@@ -48,6 +48,8 @@ Options
    on the map.
 ``-f``, ``--include-friendly``
    Specifies the tool should also kill units friendly to the player.
+``-x``, ``--max <num>``


Suggested change

``-x``, ``--max <num>``

``-l``, ``--limit <num>``

myk002 · 2024-06-22T01:18:57Z

docs/exterminate.rst

@@ -64,6 +66,7 @@ Methods
 :magma: Boil the unit in magma (not recommended for magma-safe creatures).
 :butcher: Will mark the units for butchering instead of killing them. This is
    more useful for pets than armed enemies.
+:knockout: Will put units into an unconscious state for 30k ticks.


Suggested change

:knockout: Will put units into an unconscious state for 30k ticks.

:knockout: Will put units into an unconscious state for 30k ticks (about a month).

more testing needed for this one, I dunno if adventure mode ticks align with fortress mode ticks

they don't. the month estimate is for fort mode. you could define either define a time span that knockout will last and adjust different ticks based on the mode, or else document the different time spans that knockout will last in fort mode vs. adventure mode.

wiki article on time: https://dwarffortresswiki.org/index.php/Time#Basic_mechanics

myk002 · 2024-06-22T01:23:44Z

exterminate.lua

+    local isInAdvGroup = false
+    local isAdvPet = false
+    local adv = dfhack.world.getAdventurer()
+    if adv then
+        isInAdvGroup = unit.relationship_ids.GroupLeader == dfhack.world.getAdventurer().id
+        isAdvPet = unit.relationship_ids.PetOwner == dfhack.world.getAdventurer().id
+    end


Suggested change

local isInAdvGroup = false

local isAdvPet = false

local adv = dfhack.world.getAdventurer()

if adv then

isInAdvGroup = unit.relationship_ids.GroupLeader == dfhack.world.getAdventurer().id

isAdvPet = unit.relationship_ids.PetOwner == dfhack.world.getAdventurer().id

end

local adv = dfhack.world.getAdventurer()

if adv then

if adv == unit or

unit.relationship_ids.GroupLeader == adv.id or

unit.relationship_ids.PetOwner == adv.id

then

return true

end

end

myk002 · 2024-06-22T01:24:36Z

exterminate.lua

+    if adv then
+        isInAdvGroup = unit.relationship_ids.GroupLeader == dfhack.world.getAdventurer().id
+        isAdvPet = unit.relationship_ids.PetOwner == dfhack.world.getAdventurer().id
+    end
    return dfhack.units.isOwnCiv(unit) or
        dfhack.units.isOwnGroup(unit) or


how does isOwnGroup behave in adventure mode?

it doesn't. isOwnGroup only checks plotinfo which is irrelevant to adventure mode

does that mean it always returns false, or that it returns garbage data?

myk002 · 2024-06-22T01:25:14Z

exterminate.lua

@@ -156,13 +161,15 @@ local options, args = {
    method = killMethod.INSTANT,
    only_visible = false,
    include_friendly = false,
+    maximum = -1,


Suggested change

maximum = -1,

limit = -1,

exterminate.lua

myk002 · 2024-06-22T01:29:45Z

exterminate.lua

@@ -217,7 +224,9 @@ elseif positionals[1]:split(':')[1] == "all" then
    local selected_caste = positionals[1]:split(':')[2]

    for _, unit in ipairs(df.global.world.units.active) do
-
+        if options.maximum > 0 and count >= options.maximum then


Suggested change

if options.maximum > 0 and count >= options.maximum then

if options.limit > 0 and count >= options.limit then

myk002 · 2024-06-22T01:30:14Z

exterminate.lua

@@ -269,6 +278,9 @@ else
    target = selected_race

    for _, unit in pairs(df.global.world.units.active) do
+        if options.maximum > 0 and count >= options.maximum then


Suggested change

if options.maximum > 0 and count >= options.maximum then

if options.limit > 0 and count >= options.limit then

…tate with no pathfinding maximum -> limit Implement suggestions

myk002 · 2024-06-22T14:36:36Z

note that you can add the code change suggestions to a batch and commit them directly instead of reimplementing the suggestions yourself. That also has the benefit of resolving the suggestion.

changelog.txt

myk002 · 2024-06-22T15:08:12Z

I determined that dfhack.units.isOwnGroup will return garbage data in adventure mode, but it's due to a DF bug. I'll take that up with Putnam.

Crystalwarrior added 4 commits June 14, 2024 16:54

Fix exterminate crashing in adventure mode when used with "disintegra…

27ea49d

…te" option Swap to dfhack.items.remove(item) method of destroying an item Add a --maximum options to set maximum number of units to exterminate

Remove the --maximum option, that's a feature not a bug fix

7c87abb

Don't think I need to recursively delete contents with dfhack.items.r…

c7ce259

…emove(item) anymore?

Teleport DISINTEGRATED units to the top of the world (maybe teleport …

67e6f39

…to z-level 0 instead?) Add a "maximum" option letting you exterminate up to a cap

myk002 reviewed Jun 16, 2024

View reviewed changes

exterminate.lua Outdated Show resolved Hide resolved

myk002 reviewed Jun 16, 2024

View reviewed changes

exterminate.lua Outdated Show resolved Hide resolved

myk002 mentioned this pull request Jun 16, 2024

use the more robust item removal method #1189

Merged

Crystalwarrior and others added 3 commits June 22, 2024 02:48

Add KNOCKOUT method

4e06ed8

Don't teleport unit on DISINTEGRATE method Add documentation for new features

expand exterminate changelog

cd4da57

Merge branch 'master' into exterminate-update

517d777

myk002 reviewed Jun 22, 2024

View reviewed changes

myk002 and others added 2 commits June 21, 2024 18:30

fix merge error

08b1a0d

Add the ability to "traumatize" units, which should force them in a s…

2c75517

…tate with no pathfinding maximum -> limit Implement suggestions

Update changelog.txt

09c3b7d

myk002 reviewed Jun 22, 2024

View reviewed changes

changelog.txt Outdated Show resolved Hide resolved

Update changelog.txt

15a70fb

myk002 approved these changes Jun 22, 2024

View reviewed changes

myk002 merged commit d95e812 into DFHack:master Jun 22, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Exterminate #1187

Update Exterminate #1187

Crystalwarrior commented Jun 15, 2024

myk002 left a comment

myk002 Jun 22, 2024

myk002 Jun 22, 2024

Crystalwarrior Jun 22, 2024

myk002 Jun 22, 2024 •

edited

Loading

myk002 Jun 22, 2024

myk002 Jun 22, 2024

Crystalwarrior Jun 22, 2024

myk002 Jun 22, 2024

myk002 Jun 22, 2024

myk002 Jun 22, 2024

myk002 Jun 22, 2024

myk002 commented Jun 22, 2024

myk002 commented Jun 22, 2024

	:knockout: Will put units into an unconscious state for 30k ticks.
	:knockout: Will put units into an unconscious state for 30k ticks (about a month).

	if options.maximum > 0 and count >= options.maximum then
	if options.limit > 0 and count >= options.limit then

Update Exterminate #1187

Update Exterminate #1187

Conversation

Crystalwarrior commented Jun 15, 2024

myk002 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myk002 Jun 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myk002 commented Jun 22, 2024

myk002 commented Jun 22, 2024

myk002 Jun 22, 2024 •

edited

Loading