Skip to content

Commit 86456fa

Browse files
committed
new script store-owned.lua and its documentation
1 parent 5391205 commit 86456fa

3 files changed

Lines changed: 454 additions & 0 deletions

File tree

changelog.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Template for new versions:
2727
# Future
2828

2929
## New Tools
30+
- `store-owned`: task owned items to be stored in the owner's room furniture
3031

3132
## New Features
3233

docs/store-owned.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
store-owned
2+
===========
3+
4+
.. dfhack-tool::
5+
:summary: Task units to store their owned items.
6+
:tags: fort items buildings
7+
8+
Task any owned item to be stored in an appropriate storage furniture in
9+
a room assigned to the item's owner.
10+
11+
Usage
12+
-----
13+
14+
``store-owned [<option>]``
15+
16+
Select an owned item and run the tool to task the owner to put the item
17+
into storage.
18+
19+
If the storage furniture is full, unreachable, or unavailable, the item
20+
will be dropped off on the floor of the owner's room. If the owner has
21+
no assigned room or is unable to access their room(s), the item will be
22+
stored in the dormitory if available. If the dormitory is unreachable or
23+
unavailable, the item will be dropped off at the trade depot instead.
24+
25+
This tool can be used to unburden a unit that has acquired too many
26+
trinkets, or simply as an alternative to ``cleanowned`` when cleaning
27+
up scattered owned items. It can also be used to force a unit to
28+
relinquish ownership of the selected item.
29+
30+
Options
31+
-------
32+
33+
``discard``
34+
Force the owner of the selected item to relinquish ownership of
35+
said item. The item will not be tasked for storage. If the item
36+
is in the owner's inventory, they will drop it to the ground.
37+
38+
``dorm``
39+
Task the selected owned item for storage in an appropriate storage
40+
furniture, or on the floor, in any available dormitory zone.
41+
42+
``depot``
43+
Task the selected owned item to be dropped off at the trade depot.

0 commit comments

Comments
 (0)