Skip to content

add lever-interface #1550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
unboundlopez wants to merge 7 commits into
base: master
Choose a base branch
from
Open

add lever-interface #1550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8dc50e1
Document external TTS usage
unboundlopez Jan 25, 2026
4679b4c
Merge pull request #9 from unboundlopez/codex/create-folder-and-file-…
unboundlopez Jan 25, 2026
b2c63f5
Delete flavor-text.lua
unboundlopez Jan 25, 2026
178cfe1
Delete flavor-text.rst
unboundlopez Jan 25, 2026
be482d5
Add files via upload
unboundlopez Jan 27, 2026
8e4406d
Add files via upload
unboundlopez Jan 27, 2026
3b5ee59
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/lever-interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Lever Interface
===============

Overview
--------
The lever interface provides a consolidated list of all levers in the current map
and lets you queue or remove pull tasks. The list is kept up to date automatically
so queued, completed, and cancelled pulls are reflected without manual refreshes.

Main features
-------------
- Lists all levers with a status prefix (``[Pulled]`` or ``[Not Pulled]``).
- Shows queued pull counts per lever and a global queued pull total.
- Allows queuing a pull task for the selected lever.
- Allows removing queued pull tasks from the selected lever.
- Supports hover focus to pan the map to the lever without clicking.
- Supports search filtering by lever name.

Using the interface
-------------------
- **Search**: Type in the search field to filter levers by name. Filtering is
case-insensitive and matches substrings.
- **Hover**: Move the mouse over a lever entry to pan and highlight the lever.
- **Click**: Click a lever entry (or press Enter) to queue a pull task.
- **Remove queued pulls**: Use the remove hotkey to clear queued pull jobs for
the selected lever.

Hotkeys
-------
- ``P``: Queue a pull task for the selected lever.
- ``X``: Remove queued pull tasks from the selected lever.
- ``R``: Refresh the list.
228 changes: 228 additions & 0 deletions lever-interface.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
-- List and pull levers

local gui = require('gui')
local guidm = require('gui.dwarfmode')
local utils = require('utils')
local widgets = require('gui.widgets')

local lever_script = reqscript('lever')

local REFRESH_MS = 1000

local function get_levers()
local levers = {}
for _, building in ipairs(df.global.world.buildings.other.TRAP) do
if building.trap_type == df.trap_type.Lever then
table.insert(levers, building)
end
end
return levers
end

local function get_lever_label(lever)
local status = (lever.state == 1) and 'Pulled' or 'Not Pulled'
local name = utils.getBuildingName(lever)
local queued = 0
for _, job in ipairs(lever.jobs) do
if job.job_type == df.job_type.PullLever then
queued = queued + 1
end
end
local queued_text = queued > 0 and (' (queued: %d)'):format(queued) or ''
return ('[%s] %s (#%d)%s'):format(status, name, lever.id, queued_text)
end

local function get_queued_count(levers)
local queued = 0
for _, lever in ipairs(levers) do
for _, job in ipairs(lever.jobs) do
if job.job_type == df.job_type.PullLever then
queued = queued + 1
end
end
end
return queued
end

LeverWindow = defclass(LeverWindow, widgets.Window)
LeverWindow.ATTRS{
frame_title = 'Lever Tasks',
frame = {w=60, h=18, r=2},
}

function LeverWindow:init()
local _, screen_height = dfhack.screen.getWindowSize()
if screen_height then
self.frame.t = math.max(0, math.floor((screen_height - self.frame.h) / 2))
end
self.next_refresh_ms = dfhack.getTickCount() + REFRESH_MS
self.filter_text = ''
self:addviews{
widgets.EditField{
view_id='search',
frame={t=0, l=0, r=0},
label_text='Search: ',
on_change=self:callback('set_filter'),
},
widgets.List{
view_id='lever_list',
frame={t=1, l=0, r=0, b=4},
on_submit=self:callback('queue_pull'),
on_select=self:callback('focus_lever'),
},
widgets.Label{
view_id='empty_message',
frame={t=1, l=0, r=0},
text='No levers found.',
visible=false,
},
widgets.HotkeyLabel{
frame={b=3, l=0},
label='Pull selected lever',
key='CUSTOM_P',
on_activate=self:callback('queue_pull'),
},
widgets.HotkeyLabel{
frame={b=2, l=0},
label='Remove queued pulls',
key='CUSTOM_X',
on_activate=self:callback('remove_queued_pulls'),
},
widgets.Label{
view_id='queued_count',
frame={b=3, r=0},
text='Queued pulls: 0',
auto_width=true,
},
widgets.HotkeyLabel{
frame={b=1, l=0},
label='Refresh list',
key='CUSTOM_R',
on_activate=self:callback('refresh_list'),
},
}

self:refresh_list()
end

function LeverWindow:set_filter(text)
self.filter_text = text or ''
self:refresh_list()
end

function LeverWindow:refresh_list()
local list = self.subviews.lever_list
local selected_id
if list then
local _, selected = list:getSelected()
if selected and selected.data then
selected_id = selected.data.id
end
end

local choices = {}
local levers = get_levers()
table.sort(levers, function(a, b)
if a.state == b.state then
return a.id < b.id
end
return a.state > b.state
end)
local filter = (self.filter_text or ''):lower()
local filtered_levers = {}
if filter == '' then
filtered_levers = levers
else
for _, lever in ipairs(levers) do
local name = utils.getBuildingName(lever)
if name:lower():find(filter, 1, true) then
table.insert(filtered_levers, lever)
end
end
end
local selected_idx = 1
for idx, lever in ipairs(filtered_levers) do
table.insert(choices, {text=get_lever_label(lever), data=lever})
if selected_id and lever.id == selected_id then
selected_idx = idx
end
end
list:setChoices(choices, selected_idx)
self.subviews.empty_message.visible = #choices == 0
self.subviews.queued_count:setText(('Queued pulls: %d'):format(get_queued_count(levers)))
end

function LeverWindow:queue_pull()
local _, choice = self.subviews.lever_list:getSelected()
if not choice then
return
end
lever_script.leverPullJob(choice.data, false)
self:refresh_list()
end

function LeverWindow:remove_queued_pulls()
local _, choice = self.subviews.lever_list:getSelected()
if not choice then
return
end
local jobs = {}
for _, job in ipairs(choice.data.jobs) do
if job.job_type == df.job_type.PullLever then
table.insert(jobs, job)
end
end
for _, job in ipairs(jobs) do
dfhack.job.removeJob(job)
end
self:refresh_list()
end

function LeverWindow:onRenderFrame(dc, rect)
LeverWindow.super.onRenderFrame(self, dc, rect)

local list = self.subviews.lever_list
local hover_idx = list:getIdxUnderMouse()
if hover_idx and hover_idx ~= self.hover_index then
self.hover_index = hover_idx
list:setSelected(hover_idx)
local _, choice = list:getSelected()
if choice then
self:focus_lever(nil, choice)
end
end
end

function LeverWindow:onRenderBody()
if dfhack.getTickCount() >= self.next_refresh_ms then
self.next_refresh_ms = dfhack.getTickCount() + REFRESH_MS
self:refresh_list()
end
end

function LeverWindow:focus_lever(_, choice)
if not choice then
return
end
local lever = choice.data
local pos = {x=lever.centerx, y=lever.centery, z=lever.z}
dfhack.gui.revealInDwarfmodeMap(pos, true, true)
guidm.setCursorPos(pos)
end

LeverScreen = defclass(LeverScreen, gui.ZScreen)
LeverScreen.ATTRS{focus_path='lever'}

function LeverScreen:init()
self:addviews{LeverWindow{}}
end

function LeverScreen:onDismiss()
view = nil
end

if not dfhack.isMapLoaded() then
qerror('gui/lever requires a map to be loaded')
end

view = view and view:raise() or LeverScreen{}:show()