Skip to content

Document autodump-destroy-item #5897

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

Open
Bumber64 wants to merge 2 commits into
base: develop
Choose a base branch
from
+18 −7
Open

Document autodump-destroy-item #5897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
526ca92
Document `autodump-destroy-item`; update docs
Bumber64 Sep 8, 2026
ba856b0
Update changelog.txt
Bumber64 Sep 8, 2026
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 @@ -67,6 +67,7 @@ Template for new versions:
- Added ``Coord2d`` and ``Coord3d`` C++ templates, providing a standard set operations for 2-tuples and 3-tuples of any numeric type

## Documentation
- Document ``autodump-destroy-here``. Remove mention of ``autodump destroy`` able to revert destruction.

## API
- Added ``MiscUtils::print_range`` to print ranges with prefix, separator, and suffix
Expand Down
24 changes: 17 additions & 7 deletions docs/plugins/autodump.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ autodump
.. dfhack-command:: autodump-destroy-here
:summary: Destroy items marked for dumping under the keyboard cursor.

.. dfhack-command:: autodump-destroy-item
:summary: Destroy the selected item.

This tool can instantly move all unforbidden items marked for dumping to the
tile under the keyboard cursor. After moving the items, the dump flag is unset
and the forbid flag is set, just as if it had been dumped normally. See
Expand All @@ -24,19 +27,22 @@ Usage

autodump [<options>]
autodump-destroy-here
autodump-destroy-item

``autodump-destroy-here`` is an alias for ``autodump destroy-here`` and is
intended for use as a keybinding.

``autodump-destroy-item`` marks the currently viewed item for destruction.
The pending destruction can be canceled if the command is run again before
unpausing. (Does not work on items marked by ``autodump destroy``.)

Options
-------

``destroy``
Destroy instead of dumping. Doesn't require a cursor. If ``autodump`` is
called again with this option before the game is resumed, it cancels
pending destroy actions.
Destroy instead of dumping. Doesn't require a cursor.
``destroy-here``
Destroy items marked for dumping under the cursor.
Destroy items under the cursor that are marked for dumping.
``visible``
Only process items that are not hidden.
``hidden``
Expand All @@ -48,8 +54,12 @@ Examples
--------

``autodump``
Teleports items marked for dumping to the cursor position.
Teleports unforbidden items marked for dumping to the cursor position.
``autodump destroy``
Destroys all unforbidden items marked for dumping
Destroys all unforbidden items marked for dumping.
``autodump destroy forbidden``
Destroys all forbidden items marked for dumping, skipping unforbidden items.
``autodump-destroy-here``
Destroys items on the selected tile that are marked for dumping.
Destroys unforbidden items on the selected tile that are marked for dumping.
``autodump-destroy-item``
Destroys the item currently being viewed, or reverts its pending destruction.
Loading