2022-07-10 00:01:46 -06:00
|
|
|
autodump
|
|
|
|
|
========
|
2022-08-06 23:44:02 -06:00
|
|
|
|
|
|
|
|
.. dfhack-tool::
|
2022-08-09 23:37:24 -06:00
|
|
|
:summary: Automatically set items in a stockpile to be dumped.
|
2022-08-16 10:36:17 -06:00
|
|
|
:tags: fort armok fps productivity items stockpiles
|
2022-08-09 23:37:24 -06:00
|
|
|
:no-command:
|
|
|
|
|
|
|
|
|
|
.. dfhack-command:: autodump
|
|
|
|
|
:summary: Teleports items marked for dumping to the cursor position.
|
2022-08-06 23:44:02 -06:00
|
|
|
|
|
|
|
|
.. dfhack-command:: autodump-destroy-here
|
2022-08-09 23:37:24 -06:00
|
|
|
:summary: Destroy items marked for dumping under the cursor.
|
2022-08-06 23:44:02 -06:00
|
|
|
|
|
|
|
|
.. dfhack-command:: autodump-destroy-item
|
2022-08-09 23:37:24 -06:00
|
|
|
:summary: Destroys the selected item.
|
2022-07-20 00:11:02 -06:00
|
|
|
|
2022-08-09 23:37:24 -06:00
|
|
|
When `enabled <enable>`, this plugin adds an option to the :kbd:`q` menu for
|
2022-07-22 11:14:50 -06:00
|
|
|
stockpiles. When the ``autodump`` option is selected for the stockpile, any
|
|
|
|
|
items placed in the stockpile will automatically be designated to be dumped.
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-22 01:05:53 -06:00
|
|
|
When invoked as a command, it can instantly move all unforbidden items marked
|
|
|
|
|
for dumping to the tile under the cursor. After moving the items, the dump flag
|
|
|
|
|
is unset and the forbid flag is set, just as if it had been dumped normally. Be
|
2022-07-18 14:28:16 -06:00
|
|
|
aware that dwarves that are en route to pick up the item for dumping may still
|
|
|
|
|
come and move the item to your dump zone.
|
|
|
|
|
|
|
|
|
|
The cursor must be placed on a floor tile so the items can be dumped there.
|
|
|
|
|
|
2022-08-17 23:42:02 -06:00
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
::
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-18 14:28:16 -06:00
|
|
|
enable autodump
|
|
|
|
|
autodump [<options>]
|
2022-07-22 01:05:53 -06:00
|
|
|
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`` destroys only the selected item. The item may be
|
|
|
|
|
selected in the :kbd:`k` list or in the container item list. If called again
|
|
|
|
|
before the game is resumed, cancels destruction of the item.
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-20 00:11:02 -06:00
|
|
|
Options
|
|
|
|
|
-------
|
2022-07-10 00:01:46 -06:00
|
|
|
|
2022-07-23 17:03:40 -06:00
|
|
|
``destroy``
|
2022-07-18 14:28:16 -06:00
|
|
|
Destroy instead of dumping. Doesn't require a cursor. If ``autodump`` is
|
|
|
|
|
called again with this option before the game is resumed, it cancels
|
2022-07-22 01:05:53 -06:00
|
|
|
pending destroy actions.
|
2022-07-23 17:03:40 -06:00
|
|
|
``destroy-here``
|
2022-08-09 23:37:24 -06:00
|
|
|
Destroy items marked for dumping under the cursor.
|
2022-07-23 17:03:40 -06:00
|
|
|
``visible``
|
2022-07-18 14:28:16 -06:00
|
|
|
Only process items that are not hidden.
|
2022-07-23 17:03:40 -06:00
|
|
|
``hidden``
|
2022-07-18 14:28:16 -06:00
|
|
|
Only process hidden items.
|
2022-07-23 17:03:40 -06:00
|
|
|
``forbidden``
|
2022-07-18 14:28:16 -06:00
|
|
|
Only process forbidden items (default: only unforbidden).
|
|
|
|
|
|
2022-07-20 00:11:02 -06:00
|
|
|
Examples
|
|
|
|
|
--------
|
2022-07-18 14:28:16 -06:00
|
|
|
|
2022-07-23 17:03:40 -06:00
|
|
|
``autodump``
|
2022-08-09 23:37:24 -06:00
|
|
|
Teleports items marked for dumping to the cursor position.
|
2022-07-23 17:03:40 -06:00
|
|
|
``autodump destroy``
|
2022-07-18 14:28:16 -06:00
|
|
|
Destroys all unforbidden items marked for dumping
|
2022-07-23 17:03:40 -06:00
|
|
|
``autodump-destroy-item``
|
2022-08-09 23:37:24 -06:00
|
|
|
Destroys the selected item.
|
