Skip to content

aquifer: honor --skip-top and top-relative --levels #5906

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

Merged
ab9rf merged 1 commit into from
Sep 15, 2026
Merged

aquifer: honor --skip-top and top-relative --levels #5906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/changelog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ Template for new versions:
## Fixes
- Fix broken weather lookup in ``World::ReadCurrentWeather``
- `timestream`: deal properly with units who have breathing difficulties
- `aquifer`: make ``--skip-top`` and top-relative ``--levels`` take effect for the ``drain``, ``convert``, and ``add`` actions instead of being silently ignored

## Misc Improvements
- Added ``Coord2d`` and ``Coord3d`` C++ templates, providing a standard set operations for 2-tuples and 3-tuples of any numeric type
Expand Down
50 changes: 41 additions & 9 deletions plugins/aquifer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ static void get_z_range(color_ostream &out, int & minz, int & maxz, const df::co
else
maxz = get_max_aq_z(out, pos1, pos2) - skip_top;

maxz = std::min((int)pos2.z, maxz);
minz = std::max((int)pos1.z, maxz - levels + 1);

DEBUG(log,out).print("calculated z range: minz={}, maxz={}\n", minz, maxz);
Expand Down Expand Up @@ -188,11 +189,32 @@ static void aquifer_list(color_ostream &out, df::coord pos1, df::coord pos2, int
}
}

// adjust the pos range to honor --skip-top and top-relative --levels,
// which are only meaningful when the target is the whole map (--all).
// for drain/convert the reference level is the topmost existing aquifer;
// for add it is the topmost level that can hold an aquifer tile.
static bool apply_top_relative_z(color_ostream &out, df::coord & pos1, df::coord & pos2,
int skip_top, int levels, bool top_is_aq)
{
int minz = 0, maxz = -1;
get_z_range(out, minz, maxz, pos1, pos2, levels, top_is_aq, skip_top);
if (maxz < minz)
return false;
pos1.z = minz;
pos2.z = maxz;
return true;
}

static int aquifer_drain(color_ostream &out, string aq_type,
df::coord pos1, df::coord pos2, int skip_top, int levels, bool leaky)
df::coord pos1, df::coord pos2, int skip_top, int levels, bool leaky, bool top_relative)
{
DEBUG(log,out).print("entering aquifer_drain: aq_type={}, pos1={}, pos2={}, skip_top={}, levels={}, leaky={}\n",
aq_type, pos1, pos2, skip_top, levels, leaky);
DEBUG(log,out).print("entering aquifer_drain: aq_type={}, pos1={}, pos2={}, skip_top={}, levels={}, leaky={}, top_relative={}\n",
aq_type, pos1, pos2, skip_top, levels, leaky, top_relative);

if (top_relative && !apply_top_relative_z(out, pos1, pos2, skip_top, levels, true)) {
DEBUG(log, out).print("no aquifer levels in range after skip_top/levels\n");
return 0;
}

const bool all = aq_type == "all";
const bool heavy_state = aq_type == "heavy";
Expand All @@ -211,10 +233,15 @@ static int aquifer_drain(color_ostream &out, string aq_type,
}

static int aquifer_convert(color_ostream &out, string aq_type,
df::coord pos1, df::coord pos2, int skip_top, int levels, bool leaky)
df::coord pos1, df::coord pos2, int skip_top, int levels, bool leaky, bool top_relative)
{
DEBUG(log,out).print("entering aquifer_convert: aq_type={}, pos1={}, pos2={}, skip_top={}, levels={}, leaky={}\n",
aq_type, pos1, pos2, skip_top, levels, leaky);
DEBUG(log,out).print("entering aquifer_convert: aq_type={}, pos1={}, pos2={}, skip_top={}, levels={}, leaky={}, top_relative={}\n",
aq_type, pos1, pos2, skip_top, levels, leaky, top_relative);

if (top_relative && !apply_top_relative_z(out, pos1, pos2, skip_top, levels, true)) {
DEBUG(log, out).print("no aquifer levels in range after skip_top/levels\n");
return 0;
}

const bool heavy_state = aq_type == "heavy";

Expand All @@ -232,10 +259,15 @@ static int aquifer_convert(color_ostream &out, string aq_type,
}

static int aquifer_add(color_ostream &out, string aq_type,
df::coord pos1, df::coord pos2, int skip_top, int levels, bool leaky)
df::coord pos1, df::coord pos2, int skip_top, int levels, bool leaky, bool top_relative)
{
DEBUG(log,out).print("entering aquifer_add: aq_type={}, pos1={}, pos2={}, skip_top={}, levels={}, leaky={}\n",
aq_type, pos1, pos2, skip_top, levels, leaky);
DEBUG(log,out).print("entering aquifer_add: aq_type={}, pos1={}, pos2={}, skip_top={}, levels={}, leaky={}, top_relative={}\n",
aq_type, pos1, pos2, skip_top, levels, leaky, top_relative);

if (top_relative && !apply_top_relative_z(out, pos1, pos2, skip_top, levels, false)) {
DEBUG(log, out).print("no levels in range after skip_top/levels\n");
return 0;
}

const bool heavy_state = aq_type == "heavy";

Expand Down
6 changes: 3 additions & 3 deletions plugins/lua/aquifer.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,11 @@ function parse_commandline(args)
local modified = 0

if action == 'drain' then
modified = aquifer_drain(aq_type or 'all', pos1, pos2, opts.skip_top, opts.levels, opts.leaky)
modified = aquifer_drain(aq_type or 'all', pos1, pos2, opts.skip_top, opts.levels, opts.leaky, opts.all)
elseif action == 'convert' then
modified = aquifer_convert(aq_type, pos1, pos2, opts.skip_top, opts.levels, opts.leaky)
modified = aquifer_convert(aq_type, pos1, pos2, opts.skip_top, opts.levels, opts.leaky, opts.all)
elseif action == 'add' then
modified = aquifer_add(aq_type, pos1, pos2, opts.skip_top, opts.levels, opts.leaky)
modified = aquifer_add(aq_type, pos1, pos2, opts.skip_top, opts.levels, opts.leaky, opts.all)
else
qerror(('invalid action: %s'):format(action))
end
Expand Down
Loading