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

update docs for filltraffic

develop
myk002 2022-07-25 10:23:05 -07:00
parent ab9c3a07c4
commit 2654de583f
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 41 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/plugins/filltraffic.rst
Unescape Escape View File

@ -1,43 +1,43 @@
.. _alltraffic:
.. _restrictice: .. _restrictice:
.. _restrictliquids: .. _restrictliquids:
filltraffic filltraffic
=========== ===========
Set traffic designations using flood-fill starting at the cursor. Tags:
See also `alltraffic`, `restrictice`, and `restrictliquids`. Options: :dfhack-keybind:``
:H: High Traffic Usage:
:N: Normal Traffic
:L: Low Traffic ``filltraffic <designation> [<options>]``
:R: Restricted Traffic Set traffic designations using flood-fill starting at the cursor. Flood
:X: Fill across z-levels. filling stops at walls and doors.
:B: Include buildings and stockpiles. ``alltraffic <designation>``
:P: Include empty space. Set traffic designations for every single tile of the map - useful for
resetting traffic designations.
``restrictice``
Restrict traffic on all tiles on top of visible ice.
``restrictliquids``
Restrict traffic on all visible tiles with liquid.
Example: Examples
--------
``filltraffic H`` ``filltraffic H``
When used in a room with doors, it will set traffic to HIGH in just that room. When used in a room with doors, it will set traffic to HIGH in just that
room.
alltraffic Options
========== -------
Set traffic designations for every single tile of the map - useful for resetting
traffic designations. See also `filltraffic`, `restrictice`, and `restrictliquids`.
Options: Traffic designations:
:H: High Traffic :H: High Traffic.
:N: Normal Traffic :N: Normal Traffic.
:L: Low Traffic :L: Low Traffic.
:R: Restricted Traffic :R: Restricted Traffic.
restrictice Filltraffic extra options:
===========
Restrict traffic on all tiles on top of visible ice.
See also `alltraffic`, `filltraffic`, and `restrictliquids`.
restrictliquids :X: Fill across z-levels.
=============== :B: Include buildings and stockpiles.
Restrict traffic on all visible tiles with liquid. :P: Include empty space.
See also `alltraffic`, `filltraffic`, and `restrictice`.

44
plugins/filltraffic.cpp
Unescape Escape View File

@ -44,41 +44,21 @@ DFHACK_PLUGIN("filltraffic");
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands) DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"filltraffic","Flood-fill selected traffic designation from cursor", "filltraffic",
filltraffic, Gui::cursor_hotkey, "Flood-fill selected traffic designation from cursor.",
" Flood-fill selected traffic type from the cursor.\n" filltraffic, Gui::cursor_hotkey));
"Traffic Type Codes:\n"
" H: High Traffic\n"
" N: Normal Traffic\n"
" L: Low Traffic\n"
" R: Restricted Traffic\n"
"Other Options:\n"
" X: Fill across z-levels.\n"
" B: Include buildings and stockpiles.\n"
" P: Include empty space.\n"
"Example:\n"
" filltraffic H\n"
" When used in a room with doors,\n"
" it will set traffic to HIGH in just that room.\n"
));
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"alltraffic","Set traffic for the entire map", "alltraffic",
alltraffic, false, "Set traffic designation for the entire map.",
" Set traffic types for all tiles on the map.\n" alltraffic));
"Traffic Type Codes:\n"
" H: High Traffic\n"
" N: Normal Traffic\n"
" L: Low Traffic\n"
" R: Restricted Traffic\n"
));
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"restrictliquids","Restrict on every visible square with liquid", "restrictliquids",
restrictLiquid, false, "" "Restrict traffic on every visible square with liquid.",
)); restrictLiquid));
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"restrictice","Restrict traffic on squares above visible ice", "restrictice",
restrictIce, false, "" "Restrict traffic on squares above visible ice.",
)); restrictIce));
return CR_OK; return CR_OK;
} }