WIP Add reorderstops overlay #889

robob27 · 2023-11-08T07:38:29Z

Need to do some testing with this and figure out if changing the ids breaks stuff, or if anything else needs to be cleared out like the guide paths. Putting up what I have for now.

myk002 · 2023-11-08T08:38:38Z

trackstop.lua

+end
+
+local function reset_guide_paths(conditions)
+  for _i, condition in ipairs(conditions) do


for unused variables, the Lua convention is just to use an underscore with no other characters.

Ah yeah that's it. Was wondering why it still showed greyed out in the editor but hadn't looked into it yet. ty!

myk002 · 2023-11-08T08:41:26Z

trackstop.lua

+          df.global.game.main_interface.recenter_indicator_m.x = item_pos.x
+          df.global.game.main_interface.recenter_indicator_m.y = item_pos.y
+          df.global.game.main_interface.recenter_indicator_m.z = item_pos.z


pass another , true to revealInDwarfmodeMap to get this for free

myk002 · 2023-11-08T08:45:30Z

trackstop.lua

@@ -236,7 +260,170 @@ function RollerOverlay:init()
  }
 end

+selected_stop = selected_stop or nil


why does this need to be a global instead of an instance variable in ReorderStopsWindow?

I guess with the way modals work I don't need the other global variable either. Nice. Removed that too.

myk002 · 2023-11-08T08:46:27Z

trackstop.lua

+ReorderStopsWindow.ATTRS {
+  frame={t=4,l=60,w=45, h=28},
+  frame_title='Reorder Stops',
+  view_id='main',


since this is never referenced, you don't need to give it an explicit view_id

myk002 · 2023-11-08T08:47:30Z

trackstop.lua

+
+ReorderStopsWindow = defclass(ReorderStopsWindow, widgets.Window)
+ReorderStopsWindow.ATTRS {
+  frame={t=4,l=60,w=45, h=28},


since this window contains a list with a variable number of elements, it would be useful to set resizable=true

myk002 · 2023-11-08T08:48:22Z

trackstop.lua

+          if item.type == 'stop' then
+            local stop_index = item.stop_index
+
+            -- don't allow moving stops to a different route


Yeah this might be fine, I'll revisit it for sure.

Now possible

myk002

I have to admit this scares me a little bit, but if @ab9rf gives the ok that we've handled all the potential places where the id is stored, then I'll allow it.

myk002 · 2023-11-09T06:45:26Z

changelog.txt

+- `trackstop`: provides 3 new overlays:
+    - trackstop: allow changing track stop dump direction and friction
+    - rollers: allow changing roller direction and speed
+    - reorderstops: reorder stops in hauling routes


this kind of formatting doesn't translate well to the final rendered changelog. each line should be independent. If you start each of them with `trackstop`: then they will get combined into a list similar to your intention here

myk002 · 2023-11-09T06:49:26Z

trackstop.lua

+ReorderStopsOverlay.ATTRS{
+  default_pos={x=6, y=6},
+  default_enabled=true,
+  viewscreens='dwarfmode/Hauling',


is this specific enough, or should it disappear on hauling subscreens? We might need to extend Gui.cpp if this is the case

It looks like it's okay on all of them except them item selection one. Will fix.

myk002 · 2023-11-09T06:55:37Z

trackstop.lua

+}
+
+local SELECT_STOP_HINT = 'Select a stop to move'
+local SELECT_ANOTHER_STOP_HINT = 'Select another stop to swap or same to cancel'


right click should also cancel out of a partially completed reorder operation. you can do this by handling keys._MOUSE_R in ReorderStopsWindow:onInput(keys) and returning true if you have handled the right click and don't want the window to close.

ab9rf · 2023-11-09T07:55:50Z

I have to admit this scares me a little bit, but if @ab9rf gives the ok that we've handled all the potential places where the id is stored, then I'll allow it.

the function where this all takes place in the game is one of the monsters that ghidra cannot decompile (i left it running for six hours and it was unable to do so). clearing the guide path after reordering the stop resolved the odd behavior we were seeing previously. there aren't any other fields involved and since we're just reordering the elements in the vector, pointers to the individual stops are unaffected. stockpile links to hauling stops are by pointer, not by id, so changing the hauling stop id doesn't affect those

the one thing i'm not sure this covers is the vehicle_current_stop (bay12 name) vector in hauling_routest (also bay12 name). basically if you change the order of the stops, you also have to update hauling_route::vehicle_stops to reflect that the index where that vehicle is currently has changed. my brief review of this code suggests that this is not being done, but i might have missed it. basically you need to transform each element of this vector by the remapping involved in whatever reorder you do, so that the minecarts are reported as being at the right place. this is based entirely on bay12 information so you should investigate whether what i'm saying even makes sense before you implement as i could be misinterpreting toady's code entirely

myk002 · 2023-11-09T15:43:28Z

also, make sure you test to see what happens if a minecart is en route to a reordered stop, both in the pushing case and the guided case

robgoodberry · 2023-11-09T15:55:24Z

Thanks to both of you! Will update and ensure to test these scenarios.

robob27 · 2023-11-09T16:39:49Z

I was wondering why I got a reply for my own notification, replied on my other account 😅 haha

robob27 · 2023-11-11T01:17:39Z

I think the code now handles updating hauling_route::vehicle_stops properly when reordering stops within the same route. I don't currently do anything with hauling_route::vehicle_stops when swapping stops between different routes. I think this works out okay?

If I have this setup:

And I swap Stop 1 and Stop 4 (different physical locations):

From the same initial setup, if I swap Stop 1 and Stop 5 (same physical locations):

Again from that setup, if I swap Stop 2 and Stop 4 (different physical locations):

Again from that setup, if I swap Stop 1 and Stop 2 (same route, same result regardless of which stop is selected first):

So, if after swapping stops, the cart for that route is not physically at the stop index it was at before the swap, it will be moved there. If the swapped stop is at the same physical location, the cart will be considered in the right spot. If the stops are swapped within the same route, the vehicle index is updated appropriately.

Still working on more playtesting.

myk002 · 2023-11-18T00:45:33Z

I have notes on the UX, but they can wait until you have the basic functionality tested

Add reorderstops overlay

a7f269b

robob27 force-pushed the reorder-stops branch from 13e0e1c to a7f269b Compare November 8, 2023 07:40

myk002 reviewed Nov 8, 2023

View reviewed changes

Feedback/improvements

882f8e2

robob27 force-pushed the reorder-stops branch from d642880 to 882f8e2 Compare November 8, 2023 09:32

robob27 added 2 commits November 8, 2023 18:22

Allow swapping between different routes, cleanup

2a5bac3

Fix hint, slight layout adjustments

068b6a3

robob27 force-pushed the reorder-stops branch from 46811aa to 068b6a3 Compare November 8, 2023 23:22

myk002 reviewed Nov 9, 2023

View reviewed changes

Feedback, improve variable names

44595f5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP Add reorderstops overlay #889

WIP Add reorderstops overlay #889

robob27 commented Nov 8, 2023

myk002 Nov 8, 2023

robob27 Nov 8, 2023

myk002 Nov 8, 2023

robob27 Nov 8, 2023

myk002 Nov 8, 2023

robob27 Nov 8, 2023

robob27 Nov 8, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

robob27 Nov 8, 2023

robob27 Nov 8, 2023

myk002 left a comment

myk002 Nov 9, 2023

myk002 Nov 9, 2023

robob27 Nov 11, 2023

myk002 Nov 9, 2023

robob27 Nov 11, 2023

ab9rf commented Nov 9, 2023 •

edited

myk002 commented Nov 9, 2023

robgoodberry commented Nov 9, 2023

robob27 commented Nov 9, 2023

robob27 commented Nov 11, 2023

myk002 commented Nov 18, 2023

WIP Add reorderstops overlay #889

Are you sure you want to change the base?

WIP Add reorderstops overlay #889

Conversation

robob27 commented Nov 8, 2023

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

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ab9rf commented Nov 9, 2023 • edited

myk002 commented Nov 9, 2023

robgoodberry commented Nov 9, 2023

robob27 commented Nov 9, 2023

robob27 commented Nov 11, 2023

myk002 commented Nov 18, 2023

ab9rf commented Nov 9, 2023 •

edited