Repository navigation
tiletypes: remove plants when their tile is painted away - #5918
Merged
Merged
Conversation
Painting a tile (e.g. clearing ground to open space) left the plant record behind, so trees kept re-sprouting from empty air and then collapsing over whatever was built below. After painting, a plant rooted at the tile is now removed when the new tiletype can no longer host it: grown trees need a tree-material tile, shrubs and saplings need their respective tile shapes, and unsprouted trees need a tile that still exists. Tree records take their tree_info with them so nothing regrows; leftover canopy tiles remain for the user to paint over, same as after 'plant remove'. Fixes DFHack#5838
Alistair-Afton
force-pushed
the
tiletypes-remove-plants
branch
from
September 17, 2026 11:19
20faec4 to
830f539
Compare
ab9rf
reviewed
Sep 17, 2026
| // remaining tiles are left as-is for the user to paint over or collapse | ||
| static void removePlant(df::plant *plant) | ||
| { | ||
| vector<df::plant *> *vec = NULL; |
Member
There was a problem hiding this comment.
Suggested change
| vector<df::plant *> *vec = NULL; | |
| vector<df::plant *> *vec = nullptr; |
NULL is non-standard in C++
ab9rf
requested changes
Sep 17, 2026
| } | ||
| if (vec) | ||
| { | ||
| for (size_t i = vec->size(); i-- > 0;) |
Member
There was a problem hiding this comment.
is there a good reason not to use std::erase here?
| auto col = Maps::getBlockColumn((plant->pos.x / 48) * 3, (plant->pos.y / 48) * 3); | ||
| if (col) | ||
| { | ||
| for (size_t i = col->plants.size(); i-- > 0;) |
Member
There was a problem hiding this comment.
also consider std::erase here
while std::erase will not quit once it's found an instance of the item to remove, and will instead scan the entire vector to remove duplicates, this is actually safer: if (for some reason) there is a duplicate, removing all of them will prevent a dangled reference. remember postel's law.
| } | ||
|
|
||
| auto &all = world->plants.all; | ||
| for (size_t i = all.size(); i-- > 0;) |
| for (int16_t y = lo.y; y <= hi.y; y++) | ||
| { | ||
| df::coord pos(x, y, z); | ||
| if (filter(pos, NULL)) |
Member
There was a problem hiding this comment.
Suggested change
| if (filter(pos, NULL)) | |
| if (filter(pos, nullptr)) |
Contributor
Author
|
All addressed in c20b277:
|
Addresses review feedback: std::erase also guards against duplicate entries leaving dangling references.
Alistair-Afton
force-pushed
the
tiletypes-remove-plants
branch
from
September 17, 2026 15:13
c20b277 to
fc261d7
Compare
Contributor
Author
|
Added in-game regression coverage in 2a7c742: painting a soil wall over a shrub/sapling removes the plant record, an identity repaint preserves it, and painting over a grown tree's trunk removes the tree. Also covers the console/help/error paths. All 6 tests pass in-game. |
ab9rf
approved these changes
Sep 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #5838
Painting a tile (e.g. clearing ground to open space) left the plant record behind, so trees kept re-sprouting from empty air and then collapsing over whatever was built below.
After painting, a plant rooted at the tile is now removed when the new tiletype can no longer host it:
tree_info) need aTREE/ROOT/MUSHROOMmaterial tileSHRUB/SAPLINGshaped tilesDRY_TREE/WET_TREErecords on ground tiles) need a tile that still existsTree records take their
tree_infowith them so nothing regrows; leftover canopy tiles remain for the user to paint over, same as afterplant remove. Removal mirrors theplantplugin's uncat-and-delete flow.Both paint paths are covered: single tiles (
paintTile, also used bygui/tiletypesviatiletypes_setTile) and area brushes (paintArea, which skips filtered-out tiles).Testing
Built and installed locally (win64, DF 53.16), then exercised in a live fort:
TreeTrunkPillarbase to open space viatiletypes_setTile— plant record removed fromworld->plants.all, tile becameOpenSpace.paintAreapath) — the in-area plant was removed while a plant just outside the brush survived untouched.