Skip to content
Navigation Menu
{{ message }}
forked from DFHack/dfhack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsuspendmanager.lua
More file actions
320 lines (278 loc) · 9.71 KB
/
Copy pathsuspendmanager.lua
File metadata and controls
320 lines (278 loc) · 9.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
local _ENV = mkmodule('plugins.suspendmanager')
local utils = require('utils')
local gui = require('gui')
local guidm = require('gui.dwarfmode')
local overlay = require('plugins.overlay')
local widgets = require('gui.widgets')
local argparse = require('argparse')
--- Loop over all the construction jobs
---@param fn function A function taking a job as argument
function foreach_construction_job(fn)
for _, job in utils.listpairs(df.global.world.jobs.list) do
if job.job_type == df.job_type.ConstructBuilding then
fn(job)
end
end
end
function isKeptSuspended(job)
return suspendmanager_isKeptSuspended(job)
end
function isBuildingPlanJob(job)
return suspendmanager_isBuildingPlanJob(job)
end
function runOnce(prevent_blocking, quiet, unsuspend_everything)
suspendmanager_runOnce(prevent_blocking, unsuspend_everything)
if (not quiet) then
print(suspendmanager_getStatus())
end
end
function unsuspend_command(...)
local quiet, skipblocking, unsuspend_everything = false, false, false
argparse.processArgsGetopt({ ... }, {
{ 'q', 'quiet', handler = function() quiet = true end },
{ 's', 'skipblocking', handler = function() skipblocking = true end },
{ 'f', 'force', handler = function() unsuspend_everything = true end },
})
runOnce(not skipblocking, quiet, unsuspend_everything)
end
-- Overlay Widgets
StatusOverlay = defclass(StatusOverlay, overlay.OverlayWidget)
StatusOverlay.ATTRS{
desc='Adds information to suspended building panels about why it is suspended.',
default_pos={x=-39,y=16},
default_enabled=true,
viewscreens='dwarfmode/ViewSheets/BUILDING',
frame={w=59, h=3},
frame_style=gui.MEDIUM_FRAME,
frame_background=gui.CLEAR_PEN,
}
function StatusOverlay:init()
self:addviews{
widgets.Label{
frame={t=0, l=0},
text={
{text=self:callback('get_status_string')}
}
},
}
end
function StatusOverlay:get_status_string()
local job = dfhack.gui.getSelectedJob(true)
if job and job.flags.suspend then
return "Suspended because: " .. suspendmanager_suspensionDescription(job) .. "."
end
return "Not suspended."
end
function StatusOverlay:render(dc)
local job = dfhack.gui.getSelectedJob(true)
if not job or job.job_type ~= df.job_type.ConstructBuilding or not isEnabled() or isBuildingPlanJob(job) then
return
end
StatusOverlay.super.render(self, dc)
end
ToggleOverlay = defclass(ToggleOverlay, overlay.OverlayWidget)
ToggleOverlay.ATTRS{
desc='Adds a link to suspended building panels for enabling suspendmanager.',
default_pos={x=-57,y=23},
default_enabled=true,
viewscreens='dwarfmode/ViewSheets/BUILDING',
frame={w=40, h=1},
frame_background=gui.CLEAR_PEN,
}
function ToggleOverlay:init()
self:addviews{
widgets.ToggleHotkeyLabel{
view_id="enable_toggle",
frame={t=0, l=0, w=34},
label="Suspendmanager is",
key="CUSTOM_CTRL_M",
options={{value=true, label="Enabled"},
{value=false, label="Disabled"}},
initial_option = isEnabled(),
on_change=function(val) dfhack.run_command{val and "enable" or "disable", "suspendmanager"} end
},
}
end
function ToggleOverlay:shouldRender()
local job = dfhack.gui.getSelectedJob(true)
return job and job.job_type == df.job_type.ConstructBuilding and not isBuildingPlanJob(job)
end
function ToggleOverlay:render(dc)
if not self:shouldRender() then
return
end
-- Update the option: the "initial_option" value is not up to date since the widget
-- is not reinitialized for overlays
self.subviews.enable_toggle:setOption(isEnabled(), false)
ToggleOverlay.super.render(self, dc)
end
function ToggleOverlay:onInput(keys)
if not self:shouldRender() then
return
end
ToggleOverlay.super.onInput(self, keys)
end
-- suspend overlay (formerly in unsuspend.lua)
local textures = dfhack.textures.loadTileset('hack/data/art/unsuspend.png', 32, 32, true)
local ok, buildingplan = pcall(require, 'plugins.buildingplan')
if not ok then
buildingplan = nil
end
local function show_suspend_overlay()
return dfhack.screen.inGraphicsMode() or
dfhack.gui.matchFocusString('dwarfmode/Default', dfhack.gui.getDFViewscreen(true))
end
SuspendOverlay = defclass(SuspendOverlay, overlay.OverlayWidget)
SuspendOverlay.ATTRS{
desc='Annotates suspended buildings with a visible marker.',
viewscreens='dwarfmode',
default_enabled=true,
frame={w=0, h=0},
visible=show_suspend_overlay,
overlay_onupdate_max_freq_seconds=30,
}
function SuspendOverlay:init()
self:reset()
-- there can only be one of these widgets allocated at a time, so this is
-- safe
dfhack.onStateChange.unsuspend = function(code)
if code ~= SC_MAP_LOADED then return end
self:reset()
end
end
function SuspendOverlay:reset()
-- value of df.global.building_next_id on last scan
self.prev_building_next_id = 0
-- increments on every refresh so we can clear old data from the map
self.data_version = 0
-- map of building id -> {suspended=bool, suspend_count=int, version=int}
-- suspended is the job suspension state as of the last refresh
-- if suspend_count > 1 then this is a repeat offender (red 'X')
-- only buildings whose construction is in progress should be in this map.
self.in_progress_buildings = {}
-- viewport for cached screen_buildings
self.viewport = {}
-- map of building ids to current visible screen position
self.screen_buildings = {}
end
function SuspendOverlay:overlay_onupdate()
local added = false
self.data_version = self.data_version + 1
foreach_construction_job(function(job)
self:update_building(dfhack.job.getHolder(job).id, job)
added = true
end)
self.prev_building_next_id = df.global.building_next_id
if added then
-- invalidate screen_buildings cache
self.viewport = {}
end
-- clear out old data
for bld_id,data in pairs(self.in_progress_buildings) do
if data.version ~= self.data_version then
self.in_progress_buildings[bld_id] = nil
end
end
end
function SuspendOverlay:update_building(bld_id, job)
local suspended = job.flags.suspend
local data = self.in_progress_buildings[bld_id]
if not data then
self.in_progress_buildings[bld_id] = {suspended=suspended,
suspend_count=suspended and 1 or 0, version=self.data_version}
else
if suspended and suspended ~= data.suspended then
data.suspend_count = data.suspend_count + 1
end
data.suspended = suspended
data.version = self.data_version
end
end
function SuspendOverlay:process_new_buildings()
local added = false
for bld_id=self.prev_building_next_id,df.global.building_next_id-1 do
local bld = df.building.find(bld_id)
if not bld or #bld.jobs ~= 1 then
goto continue
end
local job = bld.jobs[0]
if job.job_type ~= df.job_type.ConstructBuilding then
goto continue
end
self:update_building(bld_id, job)
added = true
::continue::
end
self.prev_building_next_id = df.global.building_next_id
if added then
-- invalidate screen_buildings cache
self.viewport = {}
end
end
-- returns true if viewport has changed
function SuspendOverlay:update_viewport(viewport)
local pviewport = self.viewport
if viewport.z == pviewport.z
and viewport.x1 == pviewport.x1 and viewport.x2 == pviewport.x2
and viewport.y1 == pviewport.y1 and viewport.y2 == pviewport.y2 then
return false
end
self.viewport = viewport
return true
end
function SuspendOverlay:refresh_screen_buildings()
local viewport = guidm.Viewport.get()
if not self:update_viewport(viewport) then return end
local screen_buildings, z = {}, viewport.z
for bld_id,data in pairs(self.in_progress_buildings) do
local bld = df.building.find(bld_id)
if bld then
local pos = {x=bld.centerx, y=bld.centery, z=bld.z}
if viewport:isVisible(pos) then
screen_buildings[bld_id] = viewport:tileToScreen(pos)
end
end
end
self.screen_buildings = screen_buildings
end
local tp = function(offset)
return dfhack.textures.getTexposByHandle(textures[offset])
end
function SuspendOverlay:render_marker(dc, bld, screen_pos)
if not bld or #bld.jobs ~= 1 then return end
local data = self.in_progress_buildings[bld.id]
if not data then return end
local job = bld.jobs[0]
if job.job_type ~= df.job_type.ConstructBuilding
or not job.flags.suspend then
return
end
local color, ch, texpos = COLOR_YELLOW, 'x', tp(2)
if buildingplan and buildingplan.isPlannedBuilding(bld) then
color, ch, texpos = COLOR_GREEN, 'P', tp(4)
elseif isKeptSuspended(job) then
color, ch, texpos = COLOR_WHITE, 'x', tp(3)
elseif data.suspend_count > 1 then
color, ch, texpos = COLOR_RED, 'X', tp(1)
end
dc:seek(screen_pos.x, screen_pos.y):tile(ch, texpos, color)
end
function SuspendOverlay:onRenderFrame(dc)
if not df.global.pause_state and not dfhack.screen.inGraphicsMode() then
return
end
self:process_new_buildings()
self:refresh_screen_buildings()
dc:map(true)
for bld_id,screen_pos in pairs(self.screen_buildings) do
self:render_marker(dc, df.building.find(bld_id), screen_pos)
end
dc:map(false)
end
-- register widgets
OVERLAY_WIDGETS = {
status=StatusOverlay,
toggle=ToggleOverlay,
overlay=SuspendOverlay
}
return _ENV
You can’t perform that action at this time.