MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs for liquids

develop
myk002 2022-07-27 17:14:40 -07:00
parent 52a0b0f2ca
commit ddae1aa900
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 36 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/plugins/liquids.rst
Unescape Escape View File

@ -2,30 +2,42 @@
liquids liquids
======= =======
Allows adding magma, water and obsidian to the game. It replaces the normal Tags:
dfhack command line and can't be used from a hotkey. Settings will be remembered :dfhack-keybind:`liquids`
as long as dfhack runs. Intended for use in combination with the command :dfhack-keybind:`liquids-here`
``liquids-here`` (which can be bound to a hotkey). See also :issue:`80`.
.. warning:: 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.
Usage:
Spawning and deleting liquids can mess up pathing data and ``liquids``
temperatures (creating heat traps). You've been warned. 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.
.. note:: .. warning::
`gui/liquids` is an in-game UI for this script. Spawning and deleting liquids can mess up pathing data and temperatures
(creating heat traps). You've been warned.
Settings will be remembered until you quit DF. You can call `liquids-here` to execute Interactive interpreter
the last configured action, which is useful in combination with keybindings. -----------------------
Usage: point the DF cursor at a tile you want to modify and use the commands. 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).
If you only want to add or remove water or magma from one tile, You can enter the following commands at the prompt.
`source` may be easier to use.
Commands
--------
Misc commands: Misc commands:
:q: quit :q: quit
@ -65,10 +77,3 @@ Brush size and shape:
:block: DF map block with cursor in it (regular spaced 16x16x1 blocks) :block: DF map block with cursor in it (regular spaced 16x16x1 blocks)
:column: Column from cursor, up through free space :column: Column from cursor, up through free space
:flood: Flood-fill water tiles from cursor (only makes sense with wclean) :flood: Flood-fill water tiles from cursor (only makes sense with wclean)
liquids-here
------------
Run the liquid spawner with the current/last settings made in liquids (if no
settings in liquids were made it paints a point of 7/7 magma by default).
Intended to be used as keybinding. Requires an active in-game cursor.

18
plugins/liquids.cpp
Unescape Escape View File

@ -65,17 +65,15 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
{ {
liquids_hist.load(HISTORY_FILE); liquids_hist.load(HISTORY_FILE);
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"liquids", "Place magma, water or obsidian.", "liquids",
df_liquids, true, "Place magma, water or obsidian.",
"This tool allows placing magma, water and other similar things.\n" df_liquids,
"It is interactive and further help is available when you run it.\n" true)); // interactive, needs console for prompt
"The settings will be remembered until dfhack is closed and you can call\n"
"'liquids-here' (mapped to a hotkey) to paint liquids at the cursor position\n"
"without the need to go back to the dfhack console.\n")); // interactive, needs console for prompt
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"liquids-here", "Use settings from liquids at cursor position.", "liquids-here",
df_liquids_here, Gui::cursor_hotkey, // non-interactive, needs ingame cursor "Use settings from liquids at cursor position.",
" This command is intended to be mapped to a hotkey and is identical to pressing Enter in liquids with the current parameters.\n")); df_liquids_here,
Gui::cursor_hotkey)); // non-interactive, needs ingame cursor
return CR_OK; return CR_OK;
} }