Merge pull request #844 from myk002/myk_pedestal

dialog for assigning items to display furniture
DFHack · Sep 30, 2023 · 57c8593 · 57c8593
2 parents 73eac04 + c26b63b
commit 57c8593
Show file tree

Hide file tree

Showing 4 changed files with 691 additions and 0 deletions.
diff --git a/caravan.lua b/caravan.lua
@@ -2,6 +2,7 @@
 --@ module = true
 
 local movegoods = reqscript('internal/caravan/movegoods')
+local pedestal = reqscript('internal/caravan/pedestal')
 local trade = reqscript('internal/caravan/trade')
 local tradeagreement = reqscript('internal/caravan/tradeagreement')
 
@@ -20,6 +21,7 @@ OVERLAY_WIDGETS = {
     tradeagreement=tradeagreement.TradeAgreementOverlay,
     movegoods=movegoods.MoveGoodsOverlay,
     assigntrade=movegoods.AssignTradeOverlay,
+    displayitemselector=pedestal.PedestalOverlay,
 }
 
 INTERESTING_FLAGS = {

diff --git a/changelog.txt b/changelog.txt
@@ -31,6 +31,7 @@ Template for new versions:
 
 ## New Features
 - `startdwarf`: overlay scrollbar so you can scroll through your starting dwarves if they don't all fit on the screen
+- A new searchable, sortable, filterable dialog for selecting items for display on pedestals and display cases
 
 ## Fixes
 - `suspendmanager`: fixed a bug where floor grates, bars, bridges etc. wouldn't be recognised as walkable, leading to unnecessary suspensions in certain cases.

diff --git a/docs/caravan.rst b/docs/caravan.rst
@@ -94,3 +94,15 @@ Trade agreement
 
 A small panel is shown with a hotkey (``Ctrl-A``) for selecting all/none in the
 currently shown category.
+
+Display furniture
+`````````````````
+
+A button is added to the screen when you are viewing display furniture
+(pedestals and display cases) where you can launch an item assignment GUI.
+
+The dialog allows you to sort by name, value, or where the item is currently
+assigned for display.
+
+You can search by name, and you can filter by item quality and by whether the
+item is forbidden.