dfhack/docs/plugins/liquids.rst

85 lines
2.5 KiB
ReStructuredText

.. _liquids-here:
liquids
=======
.. dfhack-tool::
:summary: Place magma, water or obsidian.
:tags: adventure fort armok map
.. dfhack-command:: liquids-here
:summary: Spawn liquids on the selected tile.
2022-07-27 18:14:40 -06:00
Place magma, water or obsidian. See `gui/liquids` for an in-game interface for
this functionality.
Also, if you only want to add or remove water or magma from a single tile, the
`source` script may be easier to use.
2022-08-17 23:42:02 -06:00
Usage
-----
2022-07-27 18:14:40 -06:00
``liquids``
Start the interactive terminal settings interpreter. This command must be
called from the DFHack terminal and not from any in-game interface.
``liquids-here``
Run the liquid spawner with the current/last settings made in ``liquids``
(if no settings in ``liquids`` were made, then it paints a point of 7/7
magma by default). This command is intended to be used as keybinding, and it
requires an active in-game cursor.
2022-07-27 18:14:40 -06:00
.. warning::
2022-07-27 18:14:40 -06:00
Spawning and deleting liquids can mess up pathing data and temperatures
(creating heat traps). You've been warned.
2022-07-27 18:14:40 -06:00
Interactive interpreter
-----------------------
2022-07-27 18:14:40 -06:00
The interpreter replaces the normal dfhack command line and can't be used from a
hotkey. Settings will be remembered as long as dfhack runs. It is intended for
use in combination with the command ``liquids-here`` (which *can* be bound to a
hotkey).
2022-07-27 18:14:40 -06:00
You can enter the following commands at the prompt.
Misc commands:
:q: quit
:help, ?: print this list of commands
:<empty line>: put liquid
Modes:
:m: switch to magma
:w: switch to water
:o: make obsidian wall instead
:of: make obsidian floors
:rs: make a river source
:f: flow bits only
:wclean: remove salt and stagnant flags from tiles
Set-Modes and flow properties (only for magma/water):
:s+: only add mode
:s.: set mode
:s-: only remove mode
:f+: make the spawned liquid flow
:f.: don't change flow state (read state in flow mode)
:f-: make the spawned liquid static
Permaflow (only for water):
:pf.: don't change permaflow state
:pf-: make the spawned liquid static
:pf[NS][EW]: make the spawned liquid permanently flow
:0-7: set liquid amount
Brush size and shape:
:p, point: Single tile
:r, range: Block with cursor at bottom north-west (any place, any size)
:block: DF map block with cursor in it (regular spaced 16x16x1 blocks)
:column: Column from cursor, up through free space
:flood: Flood-fill water tiles from cursor (only makes sense with wclean)