Skip to content
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.

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

Overhaul cleaners plugin; Add Maps::isPlantInBox #4949

Open
wants to merge 36 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
79364de
Update Lua API.rst - maps.isPlantInBox
Bumber64 Sep 20, 2024
8081985
Update cleaners.rst
Bumber64 Sep 20, 2024
174aa2e
Update regrass.rst - Talk about cleaners remove grass
Bumber64 Sep 20, 2024
96ab31d
Update LuaApi.cpp - Add maps.isPlantInBox
Bumber64 Sep 20, 2024
da108ee
Update Maps.h - isPlantInBox
Bumber64 Sep 20, 2024
b5dbea2
Update tile-material.lua - Use getPlantAtTile; handle roots
Bumber64 Sep 20, 2024
8f10e8e
Update Maps.cpp - isPlantInBox
Bumber64 Sep 20, 2024
ad11f48
Update CMakeLists.txt - cleaners link lua
Bumber64 Sep 20, 2024
e3a529a
Update burrow.cpp - Use Maps::forCoord; use using better
Bumber64 Sep 20, 2024
d165e27
Update plant.cpp - Move utility fn to Maps module
Bumber64 Sep 20, 2024
86f98b0
Update regrass.cpp - Maps::isValid is cleaner
Bumber64 Sep 20, 2024
4bd5bec
Create cleaners.lua
Bumber64 Sep 20, 2024
a4ccb44
Update cleaners.cpp
Bumber64 Sep 20, 2024
9ac1ded
Update cleaners.cpp - Remove plant cleaning (just rainwater)
Bumber64 Sep 20, 2024
f910c0c
Update changelog.txt
Bumber64 Sep 20, 2024
6375c92
Update changelog.txt
Bumber64 Sep 20, 2024
f89fc3c
Update cleaners.cpp - Fix print size_t
Bumber64 Sep 20, 2024
961ceb8
Update cleaners.cpp - Really fix print size_t
Bumber64 Sep 20, 2024
3876041
Merge branch 'DFHack:develop' into cleaners_etc
Bumber64 Sep 26, 2024
317eaf3
Merge branch 'DFHack:develop' into cleaners_etc
Bumber64 Sep 27, 2024
244e848
Tidy up docs
Bumber64 Sep 27, 2024
9b1b880
More doc tidying
Bumber64 Sep 27, 2024
ed4e3e0
Update regrass.rst - Minor wording change
Bumber64 Sep 27, 2024
6d26265
Update regrass.rst
Bumber64 Sep 27, 2024
e121d8f
Fix changelog.txt
Bumber64 Dec 8, 2024
a2e1e68
Merge branch 'develop' into cleaners_etc
Bumber64 Dec 8, 2024
0c651d7
Merge branch 'develop' into cleaners_etc
Bumber64 Dec 11, 2024
7b30129
Fix changelog.txt
Bumber64 Dec 11, 2024
82ec22e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
82738b4
Merge branch 'develop' into cleaners_etc
Bumber64 Dec 15, 2024
28f7fca
Update cleaners.cpp
Bumber64 Dec 27, 2024
7ecb7b7
Requested changes
Bumber64 Dec 27, 2024
79bdff8
Merge branch 'develop' into cleaners_etc
Bumber64 Dec 27, 2024
2519439
Update cleaners.cpp
Bumber64 Dec 27, 2024
9f73167
Update cleaners.cpp
Bumber64 Dec 27, 2024
16b311b
Merge branch 'develop' into cleaners_etc
Bumber64 Jan 4, 2025
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
Prev Previous commit
Next Next commit
Tidy up docs
* Update cleaners.rst
* Update regrass.rst
Bumber64 authored Sep 27, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 244e84870e89261be3a128ba5472379429188db1
8 changes: 4 additions & 4 deletions docs/plugins/cleaners.rst
Original file line number Diff line number Diff line change
@@ -91,12 +91,12 @@ Options
-------

``-a``, ``--all``
Equivalent to ``--map --units --items --plants``.
Equivalent to ``--map --units --items``.
``-m``, ``--map``
Clean selected map tiles. Cleans most spatter by default, but not mud,
snow, or item spatter.
``-d``, ``--mud``
Also remove mud from map tiles.
Also remove mud from map tiles. Excludes mud required for farm plots.
``-s``, ``--snow``
Also remove snow coverings from map tiles.
``-t``, ``--item``
@@ -106,7 +106,7 @@ Options
``-g``, ``--grass``
Remove unused (entirely depleted) grass events from map blocks. DF will
create a grass events for each type of grass that grows in a block, but
doesn't remove them if you were to pave over everything, or they got
doesn't remove them if you pave over everything, or the grass got
depleted and entirely replaced with a different type. Could possibly
improve FPS if you had a ton of unused grass events everywhere (a likely
outcome of using ``regrass --new``). Requires ``--map`` option to be
@@ -122,7 +122,7 @@ Options
``--snow``, ``--item``, or ``--grass``.
``-u``, ``--units``
Clean all contaminants off of units in the selected area. Not affected by
map options that specify spatter types (e.g., snow). They will always be
map options that specify spatter types (e.g., snow). Units will always be
completely cleaned.
``-i``, ``--items``
Clean all contaminants off of items in the selected area (including those
6 changes: 3 additions & 3 deletions docs/plugins/regrass.rst
Original file line number Diff line number Diff line change
@@ -9,9 +9,9 @@ This command can refresh the grass (and subterranean moss) growing on your map.
Operates on floors, stairs, and ramps. Also works underneath shrubs, saplings,
and tree trunks. Ignores furrowed soil and wet sand (beaches).

The `cleaners` tool can help remove grass if you messed up and suddenly there's
staring eyeballs all over your fort. `gui/tiletypes` can then be used to
change the soil back to stone.
The `cleaners` tool can help remove grass if you messed up and suddenly there
are staring eyeballs growing all over your fort. `gui/tiletypes` can then be used
to change the soil back to stone.

Usage
-----