dfhack/docs/plugins/changeitem.rst

changeitem
==========

.. dfhack-tool::
    :summary: Change item material or base quality.
    :tags: untested 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.

Usage
-----

``changeitem info``
   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>]``
   Change the item selected in the ``k`` list or inside a container/inventory.
``changeitem here [<options>]``
   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.

Options
-------

``m``, ``material <RAW id>``
   Change material. Must be followed by valid material RAW id.
``s``, ``subtype <RAW id>``
   Change subtype. Must be followed by a valid subtype RAW id."
``q``, ``quality <quality>``
   Change base quality. Must be followed by number (0-5) with 0 being no quality
   and 5 being masterpiece quality.
``force``
   Ignore subtypes and force the change to the new material.
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00			`changeitem`
			`==========`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
			`.. dfhack-tool::`
			`:summary: Change item material or base quality.`
add untested tag to plugins 2023-01-10 23:26:12 -07:00			`:tags: untested adventure fort armok items`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
			`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.`
update docs for changeitem 2022-07-20 14:00:27 -06:00
make Usage a proper header 2022-08-17 23:42:02 -06:00			`Usage`
			`-----`
update docs for changeitem 2022-07-20 14:00:27 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``changeitem info``
update docs for changeitem 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.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``changeitem [<options>]``
update docs for changeitem 2022-07-20 14:00:27 -06:00			Change the item selected in the ``k`` list or inside a container/inventory.
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``changeitem here [<options>]``
update docs for changeitem 2022-07-20 14:00:27 -06:00			`Change all items at the cursor position. Requires in-game cursor.`

update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			`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.`

update docs for changeitem 2022-07-20 14:00:27 -06:00			`Options`
			`-------`

update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``m``, ``material <RAW id>``
update docs for changeitem 2022-07-20 14:00:27 -06:00			`Change material. Must be followed by valid material RAW id.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``s``, ``subtype <RAW id>``
update docs for changeitem 2022-07-20 14:00:27 -06:00			`Change subtype. Must be followed by a valid subtype RAW id."`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``q``, ``quality <quality>``
update docs for changeitem 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.`
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``force``
update docs for changeitem 2022-07-20 14:00:27 -06:00			`Ignore subtypes and force the change to the new material.`