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

Implements plugin: channel-safely v1.0.1a

develop
Josh Cooper 2022-11-18 10:47:39 -08:00
parent 6c68e72295
commit 9959ef1b36
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/plugins/channel-safely.rst
Unescape Escape View File

@ -18,7 +18,7 @@ Usage
enable channel-safely enable channel-safely
channel-safely set <setting> <value> channel-safely set <setting> <value>
channel-safely enable|disable <feature> channel-safely enable|disable <feature>
channel-safely run once channel-safely runonce
When enabled the map will be scanned for channel designations which will be grouped When enabled the map will be scanned for channel designations which will be grouped
together based on adjacency and z-level. These groups will then be analyzed for safety together based on adjacency and z-level. These groups will then be analyzed for safety
@ -32,7 +32,7 @@ Examples
``channel-safely`` ``channel-safely``
The plugin reports its configured status. The plugin reports its configured status.
``channel-safely run once`` ``channel-safely runonce``
Runs the safety procedures once. You can use this if you prefer initiating scans manually. Runs the safety procedures once. You can use this if you prefer initiating scans manually.
``channel-safely disable require-vision`` ``channel-safely disable require-vision``
@ -47,6 +47,7 @@ Examples
Features Features
-------- --------
:require-vision: Toggle whether the dwarves need vision of a tile before channeling to it can be deemed unsafe. (default: enabled) :require-vision: Toggle whether the dwarves need vision of a tile before channeling to it can be deemed unsafe. (default: enabled)
:monitor: Toggle whether to monitor the conditions of active digs. (default: disabled) :monitor: Toggle whether to monitor the conditions of active digs. (default: disabled)
:resurrect: Toggle whether to resurrect units involved in cave-ins, and if monitor is enabled :resurrect: Toggle whether to resurrect units involved in cave-ins, and if monitor is enabled
@ -56,6 +57,7 @@ Features
Settings Settings
-------- --------
:refresh-freq: The rate at which full refreshes are performed. :refresh-freq: The rate at which full refreshes are performed.
This can be expensive if you're undertaking many mega projects. (default:600, twice a day) This can be expensive if you're undertaking many mega projects. (default:600, twice a day)
:monitor-freq: The rate at which active jobs are monitored. (default:1) :monitor-freq: The rate at which active jobs are monitored. (default:1)

2
plugins/channel-safely/channel-safely-plugin.cpp
Unescape Escape View File

@ -584,7 +584,7 @@ DFhackCExport command_result plugin_onupdate(color_ostream &out, state_change_ev
command_result channel_safely(color_ostream &out, std::vector<std::string> &parameters) { command_result channel_safely(color_ostream &out, std::vector<std::string> &parameters) {
if (!parameters.empty()) { if (!parameters.empty()) {
if (parameters.size() >= 2 && parameters.size() <= 3) { if (parameters.size() >= 2 && parameters.size() <= 3) {
if (parameters[0] == "run" && parameters[1] == "once") { if (parameters[0] == "runonce") {
CSP::UnpauseEvent(); CSP::UnpauseEvent();
return DFHack::CR_OK; return DFHack::CR_OK;
} }