Merge pull request #2544 from myk002/myk_hotkeys_revamp

comment out most keybindings and revamp hotkeys widget
2023-01-02 20:43:06 -08:00 · 2023-01-02 20:43:06 -08:00 · bb1a165d5b
parent 6361b0a3a4 2119d4fb2a
commit bb1a165d5b
3 changed files with 88 additions and 70 deletions
--- a/data/init/dfhack.keybindings.init
+++ b/data/init/dfhack.keybindings.init
@ -20,7 +20,7 @@ keybinding add Ctrl-Shift-C hotkeys
 keybinding add Ctrl-Shift-K gui/cp437-table

 # an in-game init file editor
-keybinding add Alt-S@title|dwarfmode/Default|dungeonmode gui/settings-manager
+#keybinding add Alt-S@title|dwarfmode/Default|dungeonmode gui/settings-manager


 ######################
@ -28,142 +28,142 @@ keybinding add Alt-S@title|dwarfmode/Default|dungeonmode gui/settings-manager
 ######################

 # quicksave, only in main dwarfmode screen and menu page
-keybinding add Ctrl-Alt-S@dwarfmode/Default quicksave
+#keybinding add Ctrl-Alt-S@dwarfmode/Default quicksave

 # toggle the display of water level as 1-7 tiles
 keybinding add Ctrl-W@dwarfmode|dungeonmode twaterlvl

 # designate the whole vein for digging
-keybinding add Ctrl-V@dwarfmode digv
-keybinding add Ctrl-Shift-V@dwarfmode "digv x"
+#keybinding add Ctrl-V@dwarfmode digv
+#keybinding add Ctrl-Shift-V@dwarfmode "digv x"

 # clean the selected tile of blood etc
-keybinding add Ctrl-C spotclean
+#keybinding add Ctrl-C spotclean

 # destroy the selected item
-keybinding add Ctrl-K@dwarfmode autodump-destroy-item
+#keybinding add Ctrl-K@dwarfmode autodump-destroy-item

 # destroy items designated for dump in the selected tile
-keybinding add Ctrl-Shift-K@dwarfmode autodump-destroy-here
+#keybinding add Ctrl-Shift-K@dwarfmode autodump-destroy-here

 # apply blueprints to the map (Alt-F for compatibility with LNP Quickfort)
-keybinding add Ctrl-Shift-Q@dwarfmode gui/quickfort
-keybinding add Alt-F@dwarfmode gui/quickfort
+#keybinding add Ctrl-Shift-Q@dwarfmode gui/quickfort
+#keybinding add Alt-F@dwarfmode gui/quickfort

 # show information collected by dwarfmonitor
-keybinding add Alt-M@dwarfmode/Default "dwarfmonitor prefs"
-keybinding add Ctrl-F@dwarfmode/Default "dwarfmonitor stats"
+#keybinding add Alt-M@dwarfmode/Default "dwarfmonitor prefs"
+#keybinding add Ctrl-F@dwarfmode/Default "dwarfmonitor stats"

 # set the zone or cage under the cursor as the default
-keybinding add Alt-Shift-I@dwarfmode/Zones "zone set"
+#keybinding add Alt-Shift-I@dwarfmode/Zones "zone set"

 # Stocks plugin
-keybinding add Ctrl-Shift-Z@dwarfmode/Default "stocks show"
+#keybinding add Ctrl-Shift-Z@dwarfmode/Default "stocks show"

 # open an overview window summarising some stocks (dfstatus)
-keybinding add Ctrl-Shift-I@dwarfmode/Default|dfhack/lua/dfstatus gui/dfstatus
+#keybinding add Ctrl-Shift-I@dwarfmode/Default|dfhack/lua/dfstatus gui/dfstatus

 # change quantity of manager orders
-keybinding add Alt-Q@jobmanagement/Main gui/manager-quantity
+#keybinding add Alt-Q@jobmanagement/Main gui/manager-quantity

 # re-check manager orders
-keybinding add Alt-R@jobmanagement/Main workorder-recheck
+#keybinding add Alt-R@jobmanagement/Main workorder-recheck

 # set workorder item details (on workorder details screen press D again)
-keybinding add D@workquota_details gui/workorder-details
+#keybinding add D@workquota_details gui/workorder-details

 # view combat reports for the selected unit/corpse/spatter
-keybinding add Ctrl-Shift-R@dwarfmode|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|workshop_profile|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit|buildinglist|workshop_profile view-unit-reports
+#keybinding add Ctrl-Shift-R@dwarfmode|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|workshop_profile|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit|buildinglist|workshop_profile view-unit-reports

 # view extra unit information
-keybinding add Alt-I@dwarfmode/ViewUnits|unitlist gui/unit-info-viewer
+#keybinding add Alt-I@dwarfmode/ViewUnits|unitlist gui/unit-info-viewer

 # boost priority of jobs related to the selected entity
-keybinding add Alt-N@dwarfmode|job|joblist|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit|buildinglist|textviewer|item|layer_assigntrade|tradegoods|store|assign_display_item|treasurelist do-job-now
+#keybinding add Alt-N@dwarfmode|job|joblist|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit|buildinglist|textviewer|item|layer_assigntrade|tradegoods|store|assign_display_item|treasurelist do-job-now

 # export a Dwarf's preferences screen in BBCode to post to a forum
-keybinding add Ctrl-Shift-F@textviewer forum-dwarves
+#keybinding add Ctrl-Shift-F@textviewer forum-dwarves

 # q->stockpile - copy & paste stockpiles
-keybinding add Alt-P@dwarfmode/QueryBuilding/Some/Stockpile copystock
+#keybinding add Alt-P@dwarfmode/QueryBuilding/Some/Stockpile copystock

 # q->stockpile - load and save stockpile settings out of game
-keybinding add Alt-L@dwarfmode/QueryBuilding/Some/Stockpile "gui/stockpiles -load"
-keybinding add Alt-S@dwarfmode/QueryBuilding/Some/Stockpile "gui/stockpiles -save"
+#keybinding add Alt-L@dwarfmode/QueryBuilding/Some/Stockpile "gui/stockpiles -load"
+#keybinding add Alt-S@dwarfmode/QueryBuilding/Some/Stockpile "gui/stockpiles -save"

 # q->workshop - duplicate the selected job
-keybinding add Ctrl-D job-duplicate
+#keybinding add Ctrl-D job-duplicate

 # materials: q->workshop; b->select items
-keybinding add Shift-A "job-material ALUNITE"
-keybinding add Shift-M "job-material MICROCLINE"
-keybinding add Shift-D "job-material DACITE"
-keybinding add Shift-R "job-material RHYOLITE"
-keybinding add Shift-I "job-material CINNABAR"
-keybinding add Shift-B "job-material COBALTITE"
-keybinding add Shift-O "job-material OBSIDIAN"
-keybinding add Shift-T "job-material ORTHOCLASE"
-keybinding add Shift-G "job-material GLASS_GREEN"
+#keybinding add Shift-A "job-material ALUNITE"
+#keybinding add Shift-M "job-material MICROCLINE"
+#keybinding add Shift-D "job-material DACITE"
+#keybinding add Shift-R "job-material RHYOLITE"
+#keybinding add Shift-I "job-material CINNABAR"
+#keybinding add Shift-B "job-material COBALTITE"
+#keybinding add Shift-O "job-material OBSIDIAN"
+#keybinding add Shift-T "job-material ORTHOCLASE"
+#keybinding add Shift-G "job-material GLASS_GREEN"

 # sort units and items in the on-screen list
-keybinding add Alt-Shift-N "sort-units name" "sort-items description"
-keybinding add Alt-Shift-R "sort-units arrival"
-keybinding add Alt-Shift-T "sort-units profession" "sort-items type material"
-keybinding add Alt-Shift-Q "sort-units squad_position" "sort-items quality"
+#keybinding add Alt-Shift-N "sort-units name" "sort-items description"
+#keybinding add Alt-Shift-R "sort-units arrival"
+#keybinding add Alt-Shift-T "sort-units profession" "sort-items type material"
+#keybinding add Alt-Shift-Q "sort-units squad_position" "sort-items quality"

 # browse linked mechanisms
-keybinding add Ctrl-M@dwarfmode/QueryBuilding/Some gui/mechanisms
+#keybinding add Ctrl-M@dwarfmode/QueryBuilding/Some gui/mechanisms

 # browse rooms of same owner
-keybinding add Alt-R@dwarfmode/QueryBuilding/Some gui/room-list
+#keybinding add Alt-R@dwarfmode/QueryBuilding/Some gui/room-list

 # interface for the liquids plugin - spawn water/magma/obsidian
-keybinding add Alt-L@dwarfmode/LookAround gui/liquids
+#keybinding add Alt-L@dwarfmode/LookAround gui/liquids

 # machine power sensitive pressure plate construction
-keybinding add Ctrl-Shift-M@dwarfmode/Build/Position/Trap gui/power-meter
+#keybinding add Ctrl-Shift-M@dwarfmode/Build/Position/Trap gui/power-meter

 # siege engine control
-keybinding add Alt-A@dwarfmode/QueryBuilding/Some/SiegeEngine gui/siege-engine
+#keybinding add Alt-A@dwarfmode/QueryBuilding/Some/SiegeEngine gui/siege-engine

 # military weapon auto-select
-keybinding add Ctrl-W@layer_military/Equip/Customize/View gui/choose-weapons
+#keybinding add Ctrl-W@layer_military/Equip/Customize/View gui/choose-weapons

 # military copy uniform
-keybinding add Ctrl-C@layer_military/Uniforms gui/clone-uniform
+#keybinding add Ctrl-C@layer_military/Uniforms gui/clone-uniform

 # minecart Guide path
-keybinding add Alt-P@dwarfmode/Hauling/DefineStop/Cond/Guide gui/guide-path
+#keybinding add Alt-P@dwarfmode/Hauling/DefineStop/Cond/Guide gui/guide-path

 # workshop job details
-keybinding add Alt-A@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workshop-job
+#keybinding add Alt-A@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workshop-job

 # workflow front-end
-keybinding add Alt-W@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workflow
-keybinding add Alt-W@overallstatus "gui/workflow status"
+#keybinding add Alt-W@dwarfmode/QueryBuilding/Some/Workshop/Job gui/workflow
+#keybinding add Alt-W@overallstatus "gui/workflow status"
 # equivalent to the one above when gui/extended-status is enabled
-keybinding add Alt-W@dfhack/lua/status_overlay "gui/workflow status"
+#keybinding add Alt-W@dfhack/lua/status_overlay "gui/workflow status"

 # autobutcher front-end
-keybinding add Shift-B@pet/List/Unit gui/autobutcher
+#keybinding add Shift-B@pet/List/Unit gui/autobutcher

 # view pathable tiles from active cursor
-keybinding add Alt-Shift-P@dwarfmode/LookAround gui/pathable
+#keybinding add Alt-Shift-P@dwarfmode/LookAround gui/pathable

 # gui/rename script - rename units and buildings
-keybinding add Ctrl-Shift-N@dwarfmode|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|workshop_profile|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit|buildinglist gui/rename
-keybinding add Ctrl-Shift-T@dwarfmode|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|workshop_profile|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit "gui/rename unit-profession"
+#keybinding add Ctrl-Shift-N@dwarfmode|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|workshop_profile|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit|buildinglist gui/rename
+#keybinding add Ctrl-Shift-T@dwarfmode|unit|unitlist|joblist|dungeon_monsterstatus|layer_unit_relationship|item|workshop_profile|layer_noblelist|locations|pets|layer_overall_health|textviewer|reportlist|announcelist|layer_military|layer_unit_health|customize_unit "gui/rename unit-profession"


 #####################
 # adv mode bindings #
 #####################

-keybinding add Ctrl-A@dungeonmode/ConversationSpeak adv-rumors
-keybinding add Ctrl-B@dungeonmode adv-bodyswap
-keybinding add Ctrl-Shift-B@dungeonmode "adv-bodyswap force"
-keybinding add Shift-O@dungeonmode gui/companion-order
-keybinding add Ctrl-T@dungeonmode gui/advfort
+#keybinding add Ctrl-A@dungeonmode/ConversationSpeak adv-rumors
+#keybinding add Ctrl-B@dungeonmode adv-bodyswap
+#keybinding add Ctrl-Shift-B@dungeonmode "adv-bodyswap force"
+#keybinding add Shift-O@dungeonmode gui/companion-order
+#keybinding add Ctrl-T@dungeonmode gui/advfort


 #########################
@ -171,4 +171,4 @@ keybinding add Ctrl-T@dungeonmode gui/advfort
 #########################

 # export all information, or just the detailed maps (doesn't handle site maps)
-keybinding add Ctrl-A@legends "exportlegends all"
+#keybinding add Ctrl-A@legends "exportlegends all"
--- a/plugins/lua/hotkeys.lua
+++ b/plugins/lua/hotkeys.lua
@ -13,13 +13,13 @@ HotspotMenuWidget = defclass(HotspotMenuWidget, overlay.OverlayWidget)
 HotspotMenuWidget.ATTRS{
    default_pos={x=1,y=2},
    hotspot=true,
-    viewscreens={'dwarfmode'},
+    viewscreens='all',
    overlay_onupdate_max_freq_seconds=0,
    frame={w=4, h=3}
 }

 function HotspotMenuWidget:init()
-    self:addviews{widgets.Label{text={'!!!!', NEWLINE, '!!!!', NEWLINE, '!!!!'}}}
+    self:addviews{widgets.Label{text={'!DF!', NEWLINE, '!Ha!', NEWLINE, '!ck!'}}}
    self.mouseover = false
 end

--- a/plugins/lua/overlay.lua
+++ b/plugins/lua/overlay.lua
@ -78,7 +78,9 @@ end

 -- normalize "short form" viewscreen names to "long form"
 local function normalize_viewscreen_name(vs_name)
-    if vs_name:match('viewscreen_.*st') then return vs_name end
+    if vs_name == 'all' or vs_name:match('viewscreen_.*st') then
+        return vs_name
+    end
    return 'viewscreen_' .. vs_name .. 'st'
 end

@ -417,18 +419,24 @@ function update_hotspot_widgets()
    end
 end

-- not subject to trigger lock since these widgets are already filtered by
-- viewscreen
-function update_viewscreen_widgets(vs_name, vs)
+local function _update_viewscreen_widgets(vs_name, vs, now_ms)
    local vs_widgets = active_viewscreen_widgets[vs_name]
    if not vs_widgets then return end
-    local now_ms = dfhack.getTickCount()
+    now_ms = now_ms or dfhack.getTickCount()
    for name,db_entry in pairs(vs_widgets) do
        if do_update(name, db_entry, now_ms, vs) then return end
    end
+    return now_ms
 end

-function feed_viewscreen_widgets(vs_name, keys)
+-- not subject to trigger lock since these widgets are already filtered by
+-- viewscreen
+function update_viewscreen_widgets(vs_name, vs)
+    local now_ms = _update_viewscreen_widgets(vs_name, vs, nil)
+    _update_viewscreen_widgets('all', vs, now_ms)
+end
+
+local function _feed_viewscreen_widgets(vs_name, keys)
    local vs_widgets = active_viewscreen_widgets[vs_name]
    if not vs_widgets then return false end
    for _,db_entry in pairs(vs_widgets) do
@ -440,16 +448,26 @@ function feed_viewscreen_widgets(vs_name, keys)
    return false
 end

-function render_viewscreen_widgets(vs_name)
+function feed_viewscreen_widgets(vs_name, keys)
+    return _feed_viewscreen_widgets(vs_name, keys) or
+            _feed_viewscreen_widgets('all', keys)
+end
+
+local function _render_viewscreen_widgets(vs_name, dc)
    local vs_widgets = active_viewscreen_widgets[vs_name]
    if not vs_widgets then return false end
-    local dc = gui.Painter.new()
+    dc = dc or gui.Painter.new()
    for _,db_entry in pairs(vs_widgets) do
        local w = db_entry.widget
        detect_frame_change(w, function() w:render(dc) end)
    end
 end

+function render_viewscreen_widgets(vs_name)
+    local dc = _render_viewscreen_widgets(vs_name, nil)
+    _render_viewscreen_widgets('all', dc)
+end
+
 -- called when the DF window is resized
 function reposition_widgets()
    local sr = get_screen_rect()