make lever.lua module capable
#1168
Conversation
| @@ -18,8 +18,6 @@ function leverPullJob(lever, priority) | |||
|
|
|||
| dfhack.job.linkIntoWorld(job, true) | |||
| dfhack.job.checkBuildingsNow() | |||
|
|
|||
| print(leverDescribe(lever)) | |||
There was a problem hiding this comment.
Just because these weren't documented doesn't mean they should be removed. Lots of script output isn't documented, and is generally useful. I don't know exactly how useful this was. It would be possible to keep it by adding a verbose flag that this script uses to these functions. (Actually, such a flag could go in PullLever() because lever is set there.)
There was a problem hiding this comment.
Personally, I don't think it is useful to describe the lever after pulling it. There is already separate functionality for describing levers.
There was a problem hiding this comment.
If you insist on preserving the printing, I would simply move the print statement after the point(s) of use within this script.
There was a problem hiding this comment.
the output is useful as feedback to the player when calling from the CLI. When called as an API, it should be controlled by a quiet flag -- at least that's the pattern that I've been following for most other publicly-accessible calls like this (e.g. https://github.com/DFHack/scripts/blob/master/assign-minecarts.lua#L72)
There was a problem hiding this comment.
If the output was a diagnostic that related to what the function was doing, I would agree. In this case though, printing the description of the lever is only indirectly related to pulling it. In any case, I restored the behavior of the script by moving the print statements after the point of invocation.
note: the removed lever descriptions are not part of the documented behavior.