Merge branch 'master' into HEAD

Author: myk002

changelog.txt

@@ -42,9 +42,13 @@ Template for new versions:
 - `hide-tutorials`: handle tutorial popups for adventure mode
 - `hide-tutorials`: new ``reset`` command that will re-enable popups in the current game (in case you hid them all and now want them back)
 - `gui/notify`: moody dwarf notification turns red when they can't reach workshop or items
+- `gui/notify`: save reminder now appears in adventure mode
+- `gui/notify`: save reminder changes color to yellow at 30 minutes and to orange at 60 minutes
 - `gui/confirm`: in the delete manager order confirmation dialog, show a description of which order you have selected to delete
 - `position`: display both adventurer and site pos simultaneously. Display map block pos+offset of selected tile.
 - `gui/sitemap`: shift click to start following the selected unit or artifact
+- `prioritize`: when prioritizing jobs of a specified type, also output how many of those jobs were already prioritized before you ran the command
+- `prioritize`: don't include already-prioritized jobs in the output of ``prioritize -j``
 
 ## Removed
 

docs/prioritize.rst

@@ -7,7 +7,7 @@ prioritize
 
 This tool encourages specified types of jobs to get assigned and completed as
 soon as possible. Finally, you can be sure your food will be hauled before
-rotting, your hides will be tanned before going bad, and the corpses of your
+it rots, your hides will be tanned before they go bad, and the corpses of your
 enemies will be cleared expediently from your entranceway.
 
 You can prioritize a bunch of active jobs that you need done *right now*, or you
@@ -40,7 +40,8 @@ Examples
     Watch for and prioritize the default set of job types that the community has
     suggested and playtested (see below for details).
 ``prioritize -j``
-    Print out the list of active jobs that you can prioritize right now.
+    Print out the list of not-yet prioritized jobs that you can prioritize
+    right now.
 ``prioritize ConstructBuilding DestroyBuilding``
     Prioritize all current building construction and destruction jobs.
 ``prioritize -a --haul-labor=Food,Body StoreItemInStockpile``
@@ -56,8 +57,7 @@ Options
 ``-d``, ``--delete``
     Stop automatically prioritizing new jobs of the specified job types.
 ``-j``, ``--jobs``
-    Print out how many current jobs of each type there are. This is useful for
-    discovering the types of the jobs that you can prioritize right now. If any
+    Print out how many current unprioritized jobs of each type there are. If any
     job types are specified, only jobs of those types are listed.
 ``-l``, ``--haul-labor <labor>[,<labor>...]``
     For StoreItemInStockpile jobs, match only the specified hauling labor(s).
@@ -97,7 +97,7 @@ staring at the screen in annoyance for too long.
 You may be tempted to automatically prioritize ``ConstructBuilding`` jobs, but
 beware that if you engage in megaprojects where many constructions must be
 built, these jobs can consume your entire fortress if prioritized. It is often
-better to run ``prioritize ConstructBuilding`` by itself (i.e. without the
+better to run ``prioritize ConstructBuilding`` by itself (that is, without the
 ``-a`` parameter) as needed to just prioritize the construction jobs that you
 have ready at the time if you need to "clear the queue".
 

internal/notify/notifications.lua

@@ -14,6 +14,10 @@ local buildings = df.global.world.buildings
 local caravans = df.global.plotinfo.caravans
 local units = df.global.world.units
 
+-- TODO: Add a proper API and UI for notification configuration
+-- this is global so one can use `:lua reqscript('internal/notify/notifications').save_time_threshold_mins=X` to change the threshold to X mins.
+save_time_threshold_mins = save_time_threshold_mins or 15
+
 function for_iter(vec, match_fn, action_fn, reverse)
     local offset = type(vec) == 'table' and 1 or 0
     local idx1 = reverse and #vec-1+offset or offset
@@ -303,6 +307,33 @@ local function get_bar(get_fn, get_max_fn, text, color)
     return nil
 end
 
+local function get_save_alert()
+    local mins_since_save = dfhack.persistent.getUnsavedSeconds()//60
+    local pen = COLOR_LIGHTCYAN
+    if mins_since_save < save_time_threshold_mins then return end
+    if mins_since_save >= 4*save_time_threshold_mins then
+        pen = COLOR_LIGHTRED
+    elseif mins_since_save >= 2*save_time_threshold_mins then
+        pen = COLOR_YELLOW
+    end
+    return {
+        {text='Last save: ', pen=COLOR_WHITE},
+        {text=dfhack.formatInt(mins_since_save) ..' mins ago', pen=pen},
+    }
+end
+
+local function save_popup()
+    local mins_since_save = dfhack.persistent.getUnsavedSeconds()//60
+    local message = 'It has been ' .. dfhack.formatInt(mins_since_save) .. ' minutes since your last save.'
+    if dfhack.world.isFortressMode() then
+        message = message .. '\n\nWould you like to save now? (Note: You can also close this reminder and save manually)'
+        dlg.showYesNoPrompt('Save now?', message, nil, function() dfhack.run_script('quicksave') end)
+    else
+        message = message .. '\n\nClose this popup to open the options menu and select "Save and continue playing"'
+        dlg.showMessage('Save reminder', message, COLOR_WHITE, function() gui.simulateInput(dfhack.gui.getDFViewscreen(true), 'OPTIONS') end)
+    end
+end
+
 -- the order of this list controls the order the notifications will appear in the overlay
 NOTIFICATIONS_BY_IDX = {
     {
@@ -526,20 +557,10 @@ NOTIFICATIONS_BY_IDX = {
     },
     {
         name='save-reminder',
-        desc='Shows a reminder if it has been more than 15 minutes since your last save.',
+        desc=('Shows a reminder if it has been more than %d minute%s since your last save.'):format(save_time_threshold_mins, save_time_threshold_mins == 1 and '' or 's'),
         default=true,
-        dwarf_fn=function ()
-            local minsSinceSave = dfhack.persistent.getUnsavedSeconds()//60
-            if minsSinceSave >= 15 then
-                return "Last save: ".. (dfhack.formatInt(minsSinceSave)) ..' mins ago'
-            end
-        end,
-        on_click=function()
-            local minsSinceSave = dfhack.persistent.getUnsavedSeconds()//60
-            local message = 'It has been ' .. dfhack.formatInt(minsSinceSave) .. ' minutes since your last save. \n\nWould you like to save now?\n\n' ..
-            'You can also close this reminder and save manually.'
-            dlg.showYesNoPrompt('Save now?', message, nil, function() dfhack.run_script('quicksave') end)
-        end,
+        fn=get_save_alert,
+        on_click=save_popup,
     },
 }
 

prioritize.lua

@@ -192,15 +192,23 @@ local function for_all_jobs(cb)
 end
 
 local function boost(job_matchers, opts)
-    local count = 0
+    local count, already_prioritized = 0, 0
     for_all_jobs(
         function(job)
-            if not job.flags.do_now and boost_job_if_matches(job, job_matchers) then
-                count = count + 1
+            local was_prioritized = job.flags.do_now
+            if boost_job_if_matches(job, job_matchers) then
+                if was_prioritized then
+                    already_prioritized = already_prioritized + 1
+                else
+                    count = count + 1
+                end
             end
         end)
     if not opts.quiet then
         print(('Prioritized %d job%s.'):format(count, count == 1 and '' or 's'))
+        if already_prioritized > 0 then
+            print(('%d job%s already prioritized.'):format(already_prioritized, already_prioritized == 1 and '' or 's'))
+        end
     end
 end
 
@@ -440,6 +448,7 @@ local function print_current_jobs(job_matchers, opts)
     local filtered = next(job_matchers)
     local function count_job(jobs, job)
         if filtered and not job_matchers[job.job_type] then return end
+        if job.flags.do_now then return end
         local job_type = get_job_type_str(job)
         jobs[job_type] = (jobs[job_type] or 0) + 1
     end