dfhack/docs/plugins/cleanconst.rst

cleanconst
==========

.. dfhack-tool::
    :summary: Cleans up construction materials.
    :tags: fort fps buildings

This tool alters all constructions on the map so that they spawn their building
component when they are disassembled, allowing their actual build items to be
safely deleted. This can improve FPS when you have many constructions on the
map.

Usage
-----

::

    cleanconst
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00			`cleanconst`
			`==========`
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: Cleans up construction materials.`
revise tag list and assignments 2022-08-12 00:34:37 -06:00			`:tags: fort fps buildings`
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
			`This tool alters all constructions on the map so that they spawn their building`
			`component when they are disassembled, allowing their actual build items to be`
			`safely deleted. This can improve FPS when you have many constructions on the`
			`map.`
update docs for cleanconst 2022-07-20 14:26:30 -06:00
make Usage a proper header 2022-08-17 23:42:02 -06:00			`Usage`
			`-----`

			`::`
update docs for cleanconst 2022-07-20 14:26:30 -06:00
			`cleanconst`