Merge pull request #909 from myk002/myk_overlay_descriptions

add descriptions to script overlays

docs/gui/mod-manager.rst

@@ -5,9 +5,8 @@ gui/mod-manager
     :summary: Save and restore lists of active mods.
     :tags: dfhack interface
 
-Adds an optional overlay to the mod list screen that
-allows you to save and load mod list presets, as well
-as set a default mod list preset for new worlds.
+Adds an optional overlay to the mod list screen that allows you to save and
+load mod list presets, as well as set a default mod list preset for new worlds.
 
 Usage
 -----

exportlegends.lua

@@ -1031,6 +1031,7 @@ end
 
 LegendsOverlay = defclass(LegendsOverlay, overlay.OverlayWidget)
 LegendsOverlay.ATTRS{
+    desc='Adds extended export progress bar to the legends main screen.',
     default_pos={x=2, y=2},
     default_enabled=true,
     viewscreens='legends/Default',
@@ -1085,6 +1086,7 @@ end
 
 DoneMaskOverlay = defclass(DoneMaskOverlay, overlay.OverlayWidget)
 DoneMaskOverlay.ATTRS{
+    desc='Prevents legends mode from being exited while an export is in progress.',
     default_pos={x=-2, y=2},
     default_enabled=true,
     viewscreens='legends',

gui/civ-alert.lua

@@ -111,6 +111,7 @@ end
 
 CivalertOverlay = defclass(CivalertOverlay, overlay.OverlayWidget)
 CivalertOverlay.ATTRS{
+    desc='Adds a button for activating a civilian alert when the squads panel is open.',
     default_pos={x=-15,y=-1},
     default_enabled=true,
     viewscreens='dwarfmode',

gui/design.lua

@@ -1784,6 +1784,7 @@ local DIMENSION_TOOLTIP_Y_OFFSET = 3
 
 DimensionsOverlay = defclass(DimensionsOverlay, overlay.OverlayWidget)
 DimensionsOverlay.ATTRS{
+    desc='Adds a tooltip that shows the selected dimensions when drawing boxes.',
     default_pos={x=1,y=1},
     default_enabled=true,
     overlay_only=true, -- not player-repositionable

gui/mod-manager.lua

@@ -378,6 +378,7 @@ ModmanageOverlay = defclass(ModmanageOverlay, overlay.OverlayWidget)
 ModmanageOverlay.ATTRS {
     frame = { w=16, h=3 },
     frame_style = gui.MEDIUM_FRAME,
+    desc = "Adds a link to the mod selection screen for accessing the mod manager.",
     default_pos = { x=5, y=-5 },
     viewscreens = { "new_region/Mods" },
     default_enabled=true,
@@ -400,6 +401,7 @@ end
 NotificationOverlay = defclass(NotificationOverlay, overlay.OverlayWidget)
 NotificationOverlay.ATTRS {
     frame = { w=60, h=1 },
+    desc = "Displays a message when a mod preset has been automatically applied.",
     default_pos = { x=3, y=-2 },
     viewscreens = { "new_region" },
     default_enabled=true,
@@ -462,3 +464,6 @@ end
 if dfhack_flags.module then
     return
 end
+
+-- TODO: when invoked as a command, should show information on which mods are loaded
+-- and give the player the option to export the list (or at least copy it to the clipboard)

internal/caravan/movegoods.lua

@@ -717,6 +717,7 @@ end
 
 MoveGoodsOverlay = defclass(MoveGoodsOverlay, overlay.OverlayWidget)
 MoveGoodsOverlay.ATTRS{
+    desc='Adds link to trade depot building to launch the DFHack trade goods UI.',
     default_pos={x=-64, y=10},
     default_enabled=true,
     viewscreens='dwarfmode/ViewSheets/BUILDING/TradeDepot',
@@ -766,6 +767,7 @@ end
 
 AssignTradeOverlay = defclass(AssignTradeOverlay, overlay.OverlayWidget)
 AssignTradeOverlay.ATTRS{
+    desc='Adds link to the trade goods screen to launch the DFHack trade goods UI.',
     default_pos={x=-41,y=-5},
     default_enabled=true,
     viewscreens='dwarfmode/AssignTrade',

internal/caravan/pedestal.lua

@@ -666,6 +666,7 @@ end
 
 PedestalOverlay = defclass(PedestalOverlay, overlay.OverlayWidget)
 PedestalOverlay.ATTRS{
+    desc='Adds link to the display furniture building panel to launch the DFHack display assignment UI.',
     default_pos={x=-40, y=34},
     default_enabled=true,
     viewscreens='dwarfmode/ViewSheets/BUILDING/DisplayFurniture',

internal/caravan/trade.lua

@@ -719,6 +719,7 @@ end
 
 TradeOverlay = defclass(TradeOverlay, overlay.OverlayWidget)
 TradeOverlay.ATTRS{
+    desc='Adds convenience functions for working with bins to the trade screen.',
     default_pos={x=-3,y=-12},
     default_enabled=true,
     viewscreens='dwarfmode/Trade/Default',
@@ -803,6 +804,7 @@ end
 
 TradeBannerOverlay = defclass(TradeBannerOverlay, overlay.OverlayWidget)
 TradeBannerOverlay.ATTRS{
+    desc='Adds link to the trade screen to launch the DFHack trade UI.',
     default_pos={x=-31,y=-7},
     default_enabled=true,
     viewscreens='dwarfmode/Trade/Default',

internal/caravan/tradeagreement.lua

@@ -6,6 +6,7 @@ local widgets = require('gui.widgets')
 
 TradeAgreementOverlay = defclass(TradeAgreementOverlay, overlay.OverlayWidget)
 TradeAgreementOverlay.ATTRS{
+    desc='Adds select all/none functionality when requesting trade agreement items.',
     default_pos={x=45, y=-6},
     default_enabled=true,
     viewscreens='dwarfmode/Diplomacy/Requests',

startdwarf.lua

@@ -6,6 +6,7 @@ local widgets = require('gui.widgets')
 
 StartDwarfOverlay = defclass(StartDwarfOverlay, overlay.OverlayWidget)
 StartDwarfOverlay.ATTRS{
+    desc='Adds a scrollbar (if necessary) to the list of starting dwarves.',
     default_pos={x=5, y=9},
     default_enabled=true,
     viewscreens='setupdwarfgame/Dwarves',

suspendmanager.lua

@@ -800,6 +800,7 @@ 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',
@@ -837,6 +838,7 @@ 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',

trackstop.lua

@@ -54,6 +54,7 @@ local DIRECTION_MAP_REVERSE = utils.invert(DIRECTION_MAP)
 
 TrackStopOverlay = defclass(TrackStopOverlay, overlay.OverlayWidget)
 TrackStopOverlay.ATTRS{
+  desc='Adds widgets for reconfiguring trackstops after construction.',
   default_pos={x=-73, y=29},
   default_enabled=true,
   viewscreens='dwarfmode/ViewSheets/BUILDING/Trap/TrackStop',
@@ -166,6 +167,7 @@ end
 
 RollerOverlay = defclass(RollerOverlay, overlay.OverlayWidget)
 RollerOverlay.ATTRS{
+  desc='Adds widgets for reconfiguring rollers after construction.',
   default_pos={x=-71, y=29},
   default_enabled=true,
   viewscreens='dwarfmode/ViewSheets/BUILDING/Rollers',

unsuspend.lua

@@ -16,6 +16,7 @@ local textures = dfhack.textures.loadTileset('hack/data/art/unsuspend.png', 32,
 
 SuspendOverlay = defclass(SuspendOverlay, overlay.OverlayWidget)
 SuspendOverlay.ATTRS{
+    desc='Annotates suspended buildings with a visible marker.',
     viewscreens='dwarfmode',
     default_enabled=true,
     overlay_only=true,