Add information about gui module requirement for overlay to load
#4896
Conversation
| @@ -263,6 +263,8 @@ the ``Overlays`` tab. | |||
| (``--@ module = true``) and it does not have side effects when loaded as a | |||
| module (i.e. you check ``dfhack_flags.module`` and return before executing | |||
| any statements if the value is ``true``) | |||
| #. you script import `gui` module, even if it is not use it directly: | |||
| ``local gui = require('gui')`` | |||
There was a problem hiding this comment.
are you sure this is true? what situation did you see this with?
There was a problem hiding this comment.
Without importing gui module I was not able to see the notes overlay in the control panel overflow list.
Can you try to recreate the issue with empty overlay class?
There was a problem hiding this comment.
idle-crafting, for example, has an overlay widget that does not require('gui')
Overlay files usually need gui because they reference one of the gui.FRAME_* identifiers or they create a gui.ZScreen, but not all overlays do this.
There was a problem hiding this comment.
idle-crafting require gui.widgets which itself require gui. I will make some test to confirm if this is the case.
There was a problem hiding this comment.
I agree with Myk - this should not be the case. If this is the case, that probably means importing the gui module has some side effects, and we should fix that instead.
There was a problem hiding this comment.
Can not repeat it, so I closing the PR.
Maybe there was some another factor that I just did not understand earlier.
Without
guirequired, overlay module will not appear on the overlays list, which is confusing for the dev.