Overhaul cleaners plugin; Add Maps::isPlantInBox #4949
Conversation
This file contains 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
* Cuboid selections * Lua argparse * Allow remove grass, skip blood removal * Better track affected blocks (arrow debris) * Debug logging
Bumber64
commented
Sep 20, 2024
Comment on lines
+339
to
365
| command_result spotclean(color_ostream &out, vector<string> ¶meters) | ||
| { // Hotkey command, already suspended | ||
| DEBUG(log, out).print("Doing spotclean.\n"); | ||
| if (!Maps::IsValid()) | ||
| { | ||
| out.printerr("Map is not available.\n"); | ||
| return CR_FAILURE; | ||
| } | ||
| df::map_block *block = Maps::getTileBlock(cursor->x, cursor->y, cursor->z); | ||
| if (block == NULL) | ||
| auto pos = Gui::getCursorPos(); | ||
| if (!pos.isValid()) | ||
| { | ||
| out.printerr("The keyboard cursor is not active.\n"); | ||
| return CR_WRONG_USAGE; | ||
| } | ||
| auto block = Maps::getTileBlock(pos); | ||
| if (!block) | ||
| { | ||
| out.printerr("Invalid map block selected!\n"); | ||
| return CR_FAILURE; | ||
| } | ||
| clean_options options; | ||
| options.mud = true; | ||
| options.snow = true; | ||
|
|
||
| for (auto evt : block->block_events) | ||
| { | ||
| if (evt->getType() != block_square_event_type::material_spatter) | ||
| continue; | ||
| // type verified - recast to subclass | ||
| df::block_square_event_material_spatterst *spatter = (df::block_square_event_material_spatterst *)evt; | ||
| clean_mud_safely(spatter, block->map_pos, df::coord(cursor->x % 16, cursor->y % 16, 0)); | ||
| } | ||
| clean_block(out, block, cuboid(pos), options); | ||
| return CR_OK; | ||
| } |
There was a problem hiding this comment.
Could we make spotclean an alias for clean here -mds or possibly clean here -ads? (Should it include item spatter? A full command can be used if you want to avoid cleaning tree fruit.)
I also don't think we can assume core is suspended unless invoking it from the terminal ensures that. Using an alias would fix that issue either way.
|
Need to properly document syntax changes and |
* Update cleaners.rst * Update regrass.rst
* Update regrass.rst * Update cleaners.rst
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.
Overhaul
cleanersto use cuboid selection instead of operating on entire map only. Can now remove grass (or just unused grass events for performance), skip cleaning blood/vomit/ooze when performing other cleanings, and counts arrow debris removal as affecting block.Now uses argparse, which will affect existing command syntax. Spotclean now just calls the existing map cleaning fn with a 1x1x1 cuboid. It could probably be replaced by an alias, assuming those work with hotkeys.
Removed
clean plantsoption, as this was just rainwater (which evaporates and will be reapplied when it rains).Moved a
plantplugin utility fn out toMaps::isPlantInBoxbecause it was going to be used for plant contaminant removal. This will detect if trees intersect with a box, so someone might have use for it.Made
burrows.cppuseMaps::forCoordinstead of a nested x,y,z iterator.Made
tile-material.luausemaps.getPlantAtTileand handle tree root material properly.