dfhack/docs/plugins/changeitem.rst

45 lines
1.5 KiB
ReStructuredText

changeitem
==========
.. dfhack-tool::
:summary: Change item material or base quality.
2023-03-24 23:34:09 -06:00
:tags: unavailable adventure fort armok items
By default, a change is only allowed if the existing and desired item materials
are of the same subtype (for example wood -> wood, stone -> stone, etc). But
since some transformations work pretty well and may be desired you can override
this with ``force``. Note that forced changes can possibly result in items that
crafters and haulers refuse to touch.
2022-07-20 14:00:27 -06:00
2022-08-17 23:42:02 -06:00
Usage
-----
2022-07-20 14:00:27 -06:00
``changeitem info``
2022-07-20 14:00:27 -06:00
Show details about the selected item. Does not change the item. You can use
this command to discover RAW ids for existing items.
``changeitem [<options>]``
2022-07-20 14:00:27 -06:00
Change the item selected in the ``k`` list or inside a container/inventory.
``changeitem here [<options>]``
2022-07-20 14:00:27 -06:00
Change all items at the cursor position. Requires in-game cursor.
Examples
--------
``changeitem here m INORGANIC:GRANITE``
Change material of all stone items under the cursor to granite.
``changeitem q 5``
Change currently selected item to masterpiece quality.
2022-07-20 14:00:27 -06:00
Options
-------
``m``, ``material <RAW id>``
2022-07-20 14:00:27 -06:00
Change material. Must be followed by valid material RAW id.
``s``, ``subtype <RAW id>``
2022-07-20 14:00:27 -06:00
Change subtype. Must be followed by a valid subtype RAW id."
``q``, ``quality <quality>``
2022-07-20 14:00:27 -06:00
Change base quality. Must be followed by number (0-5) with 0 being no quality
and 5 being masterpiece quality.
``force``
2022-07-20 14:00:27 -06:00
Ignore subtypes and force the change to the new material.