update docs for clean and spotclean
parent
048b20ac45
commit
e9e477c680
@ -1,16 +1,37 @@
|
||||
clean
|
||||
=====
|
||||
Cleans all the splatter that get scattered all over the map, items and
|
||||
creatures. In an old fortress, this can significantly reduce FPS lag. It can
|
||||
also spoil your !!FUN!!, so think before you use it.
|
||||
|
||||
Options:
|
||||
Tags:
|
||||
:dfhack-keybind:
|
||||
|
||||
:map: Clean the map tiles. By default, it leaves mud and snow alone.
|
||||
:units: Clean the creatures. Will also clean hostiles.
|
||||
:items: Clean all the items. Even a poisoned blade.
|
||||
Removes contaminants from tiles, items, and units. More specifically, it
|
||||
cleans all the splatter that get scattered all over the map and that clings to
|
||||
your items and units. In an old fortress, this can significantly reduce FPS lag.
|
||||
It can also spoil your !!FUN!!, so think before you use it.
|
||||
|
||||
Extra options for ``map``:
|
||||
Usage::
|
||||
|
||||
:mud: Remove mud in addition to the normal stuff.
|
||||
:snow: Also remove snow coverings.
|
||||
clean all|map|items|units|plants [<options>]
|
||||
|
||||
By default, cleaning the map leaves mud and snow alone. Note that cleaning units
|
||||
includes hostiles, and that cleaning items removes poisons from weapons.
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
When cleaning the map, you can specify extra options for extra cleaning:
|
||||
|
||||
- ``mud``
|
||||
Also remove mud.
|
||||
- ``item``
|
||||
Also remove item spatter, like fallen leaves and flowers.
|
||||
- ``snow``
|
||||
Also remove snow coverings.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
- ``clean all``
|
||||
Clean everything that can be cleaned (except mud and snow).
|
||||
- ``clean all mud item snow``
|
||||
Removes all spatter, including mud, leaves, and snow from map tiles.
|
||||
|
@ -1,6 +1,14 @@
|
||||
spotclean
|
||||
=========
|
||||
Works like ``clean map snow mud``, but only for the tile under the cursor. Ideal
|
||||
if you want to keep that bloody entrance ``clean map`` would clean up.
|
||||
|
||||
:dfhack-keybind:`spotclean`
|
||||
Tags:
|
||||
:dfhack-keybind:
|
||||
|
||||
Cleans a map tile of contaminants and spatter. It works like
|
||||
``clean map snow mud``, but only for the tile under the cursor. Ideal if you
|
||||
just want to clean a specific tile but don't want the `clean` command to remove
|
||||
all the glorious blood from your entranceway.
|
||||
|
||||
Usage::
|
||||
|
||||
spotclean
|
||||
|
Loading…
Reference in New Issue