replace drain-aquifer with aquifer drain

Author: myk002

changelog.txt

@@ -42,6 +42,7 @@ Template for new versions:
 - `gui/reveal`: show aquifers even when not in mining mode
 
 ## Removed
+- `drain-aquifer`: replaced by ``aquifer drain --all``; an alias now exists so ``drain-aquifer`` will automatically run the new command
 
 # 50.12-r2.1
 

docs/drain-aquifer.rst

@@ -10,6 +10,8 @@ post-embark. Pre-embark, it changes all aquifers in the world to light ones,
 while post-embark it only modifies the active map tiles, leaving the rest of
 the world unchanged.
 
+For more powerful aquifer editing, please see `aquifer` and `gui/aquifer`.
+
 Usage
 -----
 

docs/light-aquifers-only.rst

@@ -87,11 +87,11 @@ COMMANDS_BY_IDX = {
 
     -- gameplay tools
     {command='agitation-rebalance', group='gameplay', mode='enable'},
+    {command='aquifer drain --all --skip-top 2', group='gameplay', mode='run',
+        desc='Ensure that your maps have no more than 2 layers of aquifer.'},
     {command='combine', group='gameplay', mode='repeat',
         desc='Combine partial stacks in stockpiles into full stacks.',
         params={'--time', '7', '--timeUnits', 'days', '--command', '[', 'combine', 'all', '-q', ']'}},
-    {command='drain-aquifer --top 2', group='gameplay', mode='run',
-        desc='Ensure that your maps have no more than 2 layers of aquifer.'},
     {command='dwarfvet', group='gameplay', mode='enable'},
     {command='eggs-fertile', help_command='tweak', group='gameplay', mode='tweak', default=true,
         desc='Displays an indicator on fetile eggs.'},

drain-aquifer.lua

@@ -8,19 +8,11 @@ if args[1] == 'help' then
 end
 
 if not dfhack.isWorldLoaded() then
-    qerror("Error: This script requires a world to be loaded.")
+    qerror('This script requires a world to be loaded.')
 end
 
 if dfhack.isMapLoaded() then
-    for _, block in ipairs(df.global.world.map.map_blocks) do
-        if block.flags.has_aquifer then
-            for k = 0, 15 do
-                for l = 0, 15 do
-                    block.occupancy[k][l].heavy_aquifer = false
-                end
-            end
-        end
-    end
+    dfhack.run_command('aquifer', 'convert', 'light', '--all')
     return
 end