Make `gui/workorder-details` and `gui/workshop-job` work again #799

TymurGubayev · 2023-08-13T17:16:03Z

This PR merges the gui/workorder-details.lua into gui/workshop-job.lua and updates the result to work with DF50.

TymurGubayev · 2023-08-13T17:20:16Z

issues:

Ctrl+D opens another DFHack screen as well -- keybindings: add /Default to Ctrl-D@dwarfmode gui/design dfhack#3727
I haven't found a better way to hide the widget when in the wrong context, other than self.subviews.button.visible = false in onRenderBody -- we'll keep it as is for now
also, I haven't tested it beyond ensuring the UI is kind of working

myk002 · 2023-08-13T18:33:10Z

Ctrl+D opens another DFHack screen as well

This can likely be solved by changing the gui/design keybinding from @dwarfmode to @dwarfmode/Default in dfhack.keybindings.init

I haven't found a better way to hide the widget when in the wrong context, other than self.subviews.button.visible = false in onRenderBody

The preferred solution here is to modify modules/Gui.cpp to produce the more specific focus string that you need. If that is not sufficient, then yes you can set the button invisible in onRender[Whatever]

also, I haven't tested it beyond ensuring the UI is kind of working

The UI definitely needs some updating and testing. It uses code from gui/workshop-job, which itself hasn't been looked at since v50 dropped. It also should use a ZScreen and draggable windows to fit in with the modern UI themes.

myk002 · 2023-08-13T18:15:54Z

docs/gui/workorder-details.rst

@@ -9,8 +9,7 @@ This tool allows you to adjust item types, materials, and/or traits for items
 used in manager workorders. The jobs created from those workorders will inherit
 the details.


the introductory text could use a few more examples of things you can do with this tool that you wouldn't be able to do in vanilla. what do you think are the most useful situations where this tool helps?

probably use dyed or dyeable (=undyed I think) cloth, or encrust unimproved items...

I'm not quite sure.

docs/gui/workorder-details.rst

gui/workorder-details.lua

…logs` anymore

TymurGubayev · 2023-09-03T17:32:57Z

I'm not quite sure what is the replacement for dlg.showMessage -- don't replace it

myk002 · 2023-09-03T17:36:31Z

I'm not quite sure what is the replacement for dlg.showMessage

That's still fine to use. At some point, I'll swap out the implementation to use a ZScreenModal, but that should be transparent to the callers.

TymurGubayev · 2023-09-03T18:01:28Z

Sphinx is complaining because of docs/changelogs/news.rst:861:undefined label: gui/workorder-details

What's the approach with removed scripts here, should I keep the referenced docs as is, or maybe make its only content a reference to the new script?

myk002 · 2023-09-03T19:28:40Z

Tool removal is a tad janky since it crosses repos. You have to add an entry to https://github.com/DFHack/dfhack/blob/develop/docs/about/Removed.rst, but CI for both repos will fail until everything is consistent.

this PR should be completed simultaneously with DFHack/scripts#799 or abandoned in case DFHack#3729 is solved

docs/gui/job-details.rst

gui/job-details.lua

myk002 · 2023-10-12T00:59:00Z

gui/job-details.lua

@@ -92,14 +86,13 @@ function JobDetails:init(args)
            frame = { l = 0, b = 0 },
            text = {
                { key = 'LEAVESCREEN', text = ': Back',
-                  on_activate = self:callback('dismiss')
+                  -- on_activate = self:callback('dismiss')


yeah, not needed. the base ZScreen superclass takes care of window lifecycles

myk002

what does the 20 mean?

myk002 · 2023-10-12T17:38:26Z

gui/job-details.lua

+
+DetailsHotkeyOverlay_BuildingTask = defclass(DetailsHotkeyOverlay_BuildingTask, DetailsHotkeyOverlay)
+DetailsHotkeyOverlay_BuildingTask.ATTRS{
+    default_pos={x=-120, y=6}, -- {x=-120, y=6} is right above the job title on all but smallest widths


I'd move this to the right by 5 so it still looks good at the smallest width

I "reserved" the whole line using frame={w=1000, h= 1}, so that now with dfhack.screen.getWindowSize() I can move the hotkey around and it always fits.

It would've been nice to be able to move the widget itself. IIRC that wasn't possible last time I checked (half a year ago? because of label placement in the workorder-recheck.lua).

I improved upon this. The logic is as follows now.

Fix the distance from the right edge; make the widget slightly wider than necessary to allow moving the text around

determine the calculated x1 coordinate of the frame, which is the screen width minus the distance from the right minus the widget width

if the x1 < 0, set it to 0 --- making it the real position of the widget (I think this works better than built-in methods for some reason, although it's a few experiments back)

is the real left edge position of the widget too far to the left (x1 < 6), move the text to the right (offset = 6 - x1).

This works well enough until you try to narrow the game window to the minimum and then widen it again. Then the self.frame.r is changed from 102 to 77 and stays that way. That's why the 4th step is needed

restore original self.frame.r

Even with this after widening the window it doesn't immediately get the right position, but another small resizing in any direction sets it right.

gui/job-details.lua

… of window width

TymurGubayev · 2023-11-05T19:32:42Z

what does the 20 mean?

something changed somewhere and now we have for some reason a set bit without a name:

(even though df.job_item_flags3[20] == nil)

and this is how the list is filled from a bitfield:

local function list_flags(list, bitfield)
    for name,val in pairs(bitfield) do
        if val then
            table.insert(list, name)
        end
    end
end

Might this be a bug? Or maybe it should've been unknown?

To avoid confusion, I'll change the method above to exclude those.

myk002 · 2023-11-06T00:45:17Z

what does the 20 mean?

That might require a structure update. I'll look into it

myk002 · 2023-11-06T22:53:48Z

I identified the flags and pushed the updated build to the Steam testing branch if you'd like to test with it. Flag 20 is (unsurprisingly, given the context) "gem".

gui/job-details.lua

myk002 · 2023-11-07T01:21:40Z

testing notes:

the alignment seems off (screen dimensions: 150x66):
maybe don't enable the Configure job inputs HotkeyLabel if there is nothing that can be configured:
The ability to reset to defaults would be very nice
The ability to remove traits (or change the item type) could be considered an exploit. Could we only offer that capability if armok mode is enabled? (dfhack.getHideArmokTools() returns false)
I've learned from showmood that people want to see whole item quantities, not the internal counters. could we display 1 here instead of 150 (similar for cloth and thread)
The Esc hotkey hint probably isn't necessary. Most other windows don't have that.
"quantity: 1" would be clearer than "x1"

cache references to global statics

Also, refactor the way header text is built

TymurGubayev · 2023-11-07T18:50:05Z

the alignment seems off (screen dimensions: 150x66):

changed it to work based on window size instead of reading the screen

maybe don't enable the Configure job inputs HotkeyLabel if there is nothing that can be configured:

did that

The ability to reset to defaults would be very nice

defaults is hard - I'd have to know them for every job type in advance. I added a Ctrl-Z to reset changes

The ability to remove traits (or change the item type) could be considered an exploit. Could we only offer that capability if armok mode is enabled? (dfhack.getHideArmokTools() returns false)

change item type is now disabled if armok tools aren't present. Traits have same problem as defaults: I'd need to know in advance what the defaults are, to prevent the user from removing the non-default ones.

I've learned from showmood that people want to see whole item quantities, not the internal counters. could we display 1 here instead of 150 (similar for cloth and thread)

changed that. Now I'm not sure anything but 1 is even possible... Maybe in a modded game?

The Esc hotkey hint probably isn't necessary. Most other windows don't have that.

removed that

"quantity: 1" would be clearer than "x1"

changed that. Btw, there are two modes: work order and active job, with slightly different texts

It's possible we can only ever see 0 of 1 for an active job.

gui/job-details.lua

myk002 · 2023-11-09T23:09:55Z

gui/job-details.lua

+    for _, obj in pairs(self.list.choices) do
+        local stored_obj = self.stored[obj.index]
+
+        local item_type = stored_obj.item_type


Attempting to reset changes for me results in this error:

gui/job-details.lua:419: attempt to index a nil value (local 'stored_obj')

looking through the code, it looks like storeInitialProperties is checking job.items instead of job.job_items

the job.job_items vs job.items is the bane of my existence 😣

because there are two structures involved, manager order and job, and one of them has both but uses the one that's distinct.

I think I fixed it now.

myk002 reviewed Aug 13, 2023

View reviewed changes

TymurGubayev added 3 commits September 3, 2023 18:21

Update workorder-details.lua

84fc36d

Update workorder-details.rst

1f9c249

remove trailing whitespaces

9eca80b

TymurGubayev force-pushed the TymurGubayev-patch-2 branch from 970f738 to 9eca80b Compare September 3, 2023 16:22

merge workorder-details into workshop-job, update to not use `gui.dia…

8b559fd

…logs` anymore

TymurGubayev changed the title ~~Make gui/workorder-details.lua work again~~ Make gui/workorder-details and gui/workshop-job work again Sep 3, 2023

Update job-details.lua: fix whitespaces

c94a5be

require 'gui.dialogs' for the showMessage()

1f2c9f5

add instructions how to open the tool

3846f1f

This was referenced Sep 3, 2023

add a Removed.rst to scripts repo DFHack/dfhack#3729

Open

[Gui] add focus string details for orders context DFHack/dfhack#3730

Merged

TymurGubayev added a commit to TymurGubayev/dfhack that referenced this pull request Sep 5, 2023

add gui/workorder-details and gui/workshop-job to Removed.rst

1277e84

this PR should be completed simultaneously with DFHack/scripts#799 or abandoned in case DFHack#3729 is solved

TymurGubayev mentioned this pull request Sep 5, 2023

add gui/workorder-details and gui/workshop-job to Removed.rst DFHack/dfhack#3740

Open

myk002 reviewed Sep 9, 2023

View reviewed changes

gui/job-details.lua Outdated Show resolved Hide resolved

TymurGubayev added 6 commits October 2, 2023 18:27

explain magic numbers

d80af4f

make use of more specific focus strings

d06b5a8

avoid redefining a variable

937e6d2

use more descriptive label text

e2bd30f

separate ZScreenModal and Window

07a9ccd

separate ZScreenModal and Window, part 2

bfa2892

myk002 reviewed Oct 12, 2023

View reviewed changes

TymurGubayev added 3 commits November 5, 2023 17:31

add the widget to workorder conditions as well

590dd4a

use HotkeyLabel to make actions clickable

7603249

place the overlay text over task name in BuildingTask view regardless…

9ada99a

… of window width

TymurGubayev added 3 commits November 5, 2023 20:42

do not show unnamed flags even if set

ef0ebcc

job-details.rst: mention where can we find the tool

bf055ab

enable in the workshops' work order details screen

85b92c0

TymurGubayev added 2 commits November 6, 2023 21:20

improve positioning logic for building overlay

36985ed

set auto_width=true on hotkey labels

069fd09

myk002 mentioned this pull request Nov 6, 2023

identify additional job_item_flag3 flags DFHack/df-structures#674

Merged

myk002 reviewed Nov 7, 2023

View reviewed changes

gui/job-details.lua Outdated Show resolved Hide resolved

TymurGubayev added 9 commits November 7, 2023 17:44

remove the 'LEAVESCREEN' label

bd88a1a

only hide numeric flag names if dfhack.getHideArmokTools() == true

77ab5b9

cache references to global statics

Use user-friendly quantity instead of internal counter

597c48a

Also, refactor the way header text is built

use window size do determine if tabs are in two rows

cd7ca2f

disable the key if job has no items

bb95a28

add an ability to reset changes

17ca139

disable "change type" if Armok mode is off

e861565

use special setItemType and setMaterial methods when resetting changes

5ac5b9c

fix a bug introduced in recent commit

11393bc

myk002 reviewed Nov 9, 2023

View reviewed changes

fix another bug

492417b

myk002 mentioned this pull request Jan 7, 2024

workorder-detail-fix: Enforce order item details for buggy job types #929

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make `gui/workorder-details` and `gui/workshop-job` work again #799

Make `gui/workorder-details` and `gui/workshop-job` work again #799

TymurGubayev commented Aug 13, 2023 •

edited

TymurGubayev commented Aug 13, 2023 •

edited

myk002 commented Aug 13, 2023

myk002 Aug 13, 2023

TymurGubayev Sep 3, 2023

TymurGubayev commented Sep 3, 2023 •

edited

myk002 commented Sep 3, 2023

TymurGubayev commented Sep 3, 2023

myk002 commented Sep 3, 2023

myk002 Oct 12, 2023

myk002 left a comment

myk002 Oct 12, 2023

TymurGubayev Nov 5, 2023

TymurGubayev Nov 6, 2023

TymurGubayev commented Nov 5, 2023 •

edited

myk002 commented Nov 6, 2023

myk002 commented Nov 6, 2023

myk002 commented Nov 7, 2023

TymurGubayev commented Nov 7, 2023

myk002 Nov 9, 2023

myk002 Nov 9, 2023

TymurGubayev Nov 10, 2023

		@@ -9,8 +9,7 @@ This tool allows you to adjust item types, materials, and/or traits for items
		used in manager workorders. The jobs created from those workorders will inherit
		the details.

Make gui/workorder-details and gui/workshop-job work again #799

Are you sure you want to change the base?

Make gui/workorder-details and gui/workshop-job work again #799

Conversation

TymurGubayev commented Aug 13, 2023 • edited

TymurGubayev commented Aug 13, 2023 • edited

myk002 commented Aug 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TymurGubayev commented Sep 3, 2023 • edited

myk002 commented Sep 3, 2023

TymurGubayev commented Sep 3, 2023

myk002 commented Sep 3, 2023

Choose a reason for hiding this comment

myk002 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TymurGubayev commented Nov 5, 2023 • edited

myk002 commented Nov 6, 2023

myk002 commented Nov 6, 2023

myk002 commented Nov 7, 2023

TymurGubayev commented Nov 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Make `gui/workorder-details` and `gui/workshop-job` work again #799

Make `gui/workorder-details` and `gui/workshop-job` work again #799

TymurGubayev commented Aug 13, 2023 •

edited

TymurGubayev commented Aug 13, 2023 •

edited

TymurGubayev commented Sep 3, 2023 •

edited

TymurGubayev commented Nov 5, 2023 •

edited