Update quantum.lua to v50 #834

MarioWizard119 · 2023-09-13T00:45:07Z

WHAT THIS PR DO
Updates gui/quantum to be able to be used on v50 saves. A bit jank, but mostly functional

WHAT THIS PR DON'T DO, BUT PROLLY NEED TO BE DONE (BE IT BY ME OR SOMEONE FAR SMARTER)
Unfortunately I couldn't get the script to automatically order a minecart if there wasn't one. From what I could gather from the old gui/quantum file, that too was handled by quickfort. That could probably be fixed later once I figure out how to do it, but a stopgap measure it to just warn that one will need to be made beforehand or after.

Also could probably use a cleanup or optimization, I'm extremely new to this, and this is the first actual project I've contributed to (I don't count my Space Station 13 days. Writing an entire goddamn essay to explain why changing two variables won't destroy the game's balance isn't coding, It's the psychological equivalent of a root beer float, but with mint chocolate chip ice cream and orange Fanta instead), so feel free to make/have me make changes to it to adhere to community standards. And also, for some reason I couldn't get the script to intercept left clicks on the map whatsoever so I had to resort to a janky hotkey workaround, but it's functional.

copy pasted from the text doc, hopefully everything copied over correctly

myk002 · 2023-09-24T05:04:56Z

gui/quantum.lua

    focus_path='quantum',
-    sidebar_mode=df.ui_sidebar_mode.LookAround,
+	defocusable=true


defocusable is true by default, so you can remove that one. I also suggest you follow the example of gui/blueprint and set

pass_movement_keys=true, pass_mouse_clicks=false,

myk002 · 2023-09-24T05:14:48Z

gui/quantum.lua

@@ -275,80 +225,57 @@ local function order_minecart(pos)
    quickfort_orders.enqueue_additional_order(quickfort_ctx, 'wooden minecart')
    quickfort_orders.create_orders(quickfort_ctx)
 end
+--Key Input
+function QuantumUI:onInput(keys)


Unfortunately, this will break the ZScreen stack (that is, input will not be propagated properly). Try splitting out the Window widget into its own class and attaching input processing code there. Check out the example architecture in the docs here: https://docs.dfhack.org/en/latest/docs/dev/Lua%20API.html#zscreen-class

myk002 · 2023-09-24T05:16:44Z

gui/quantum.lua

+            label='Place QSP under cursor',
+            on_activate=self:callback('commit')
+		},
+        widgets.Panel{autoarrange_subviews=true, 


indents should be four spaces

myk002 · 2023-09-24T05:17:28Z

gui/quantum.lua

 function QuantumUI:get_help_text()
-    if not self.feeder then
+    if not dfhack.gui.getSelectedStockpile() then
        return 'Please select the feeder stockpile with the cursor or mouse.'


there isn't really a cursor option for this anymore. directions should be to use the mouse

myk002 · 2023-09-24T05:21:42Z

gui/quantum.lua

+		name = 'Unnamed QSP'
+	end
+	placed_output = output_type..'{quantum=true}'
+	placed_trackstop = trackstop_dir..'{take_from='..input_id..' route="'..name..'"}'


the trackstop itself should get a name, something like "$name dumper"

setting the route property to a name that already exists will attach to an existing route, which is never what you want for a qsp. I suggest either enforcing a unique name or just not naming the route

myk002 · 2023-09-24T05:24:47Z

gui/quantum.lua

+		data={
+			[0]={
+				[0]={[0]=placed_trackstop}
+			}
+		}


Suggested change

data={

[0]={

[0]={[0]=placed_trackstop}

}

}

data=placed_trackstop

myk002 · 2023-09-24T05:25:52Z

gui/quantum.lua

+	message= 'QSP Placed!'
+	dialogs.MessageBox{text=message:wrap(70)}:show()


does this need to be a popup? could we perhaps instead write it to the gui/quantum window panel?

myk002 · 2023-09-24T05:41:15Z

gui/quantum.lua

+	then
+		name = 'Unnamed QSP'
+	end
+	placed_output = output_type..'{quantum=true}'


should be of the form:
ry{name="$name quantum" quantum=true}:+all
or
c{name="$name quantum" quantum=true}:+all

myk002 · 2023-10-05T22:47:13Z

Unfortunately I couldn't get the script to automatically order a minecart if there wasn't one. From what I could gather from the old gui/quantum file, that too was handled by quickfort.

quickfort can still be responsible for ordering the minecart. that's what the quickfort orders command is for.

hallelujah

myk002

could you possibly fix the formatting? See summary of errors here: https://results.pre-commit.ci/run/github/54066125/1699332446.rdyxy0-8R_eBoKIIwgdL8w

MarioWizard119 · 2023-11-07T16:38:27Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

myk002 · 2023-11-07T08:34:09Z

gui/quantum.lua

+        widgets.Label{
+			text='Quantum'
+		},


"Quantum" is now in the title bar and this Label can be removed

myk002 · 2023-11-08T08:02:58Z

gui/quantum.lua

-QuantumUI = defclass(QuantumUI, guidm.MenuOverlay)
+
+-- UI Layout
+QuantumUI = defclass(QuantumUI, gui.ZScreen)


Try not to mix the functions between two classes. It makes the logic of the file much harder to follow. Put the ZScreen subclass at the bottom and the Window subclass (and all other business logic) at the top

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

gui/quantum.lua

-    main_panel:addviews{
-        widgets.Label{text='Quantum'},
+function QuantumWin:init()
+    cart_count = #assign_minecarts.get_free_vehicles()


cart_count should be an instance variable, not a global. call it self.cart_count instead

myk002 · 2023-11-08T08:07:55Z

gui/quantum.lua

+        widgets.Label{
+            text='Quantum'
+        },


this is in the frame title now and doesn't need to be a label

myk002 · 2023-11-08T08:09:37Z

gui/quantum.lua

+        widgets.HotkeyLabel{
+            key='CUSTOM_Q',
+            label='Place QSP under cursor',
+            on_activate=self:callback('commit')
+        },


I'd say don't bother with the keyboard cursor for now. Few people know how to use it and it complicates the UI. Go with mouse clicks, like gui/quantum and gui/blueprint and other map tools do

edit: I notice that later in the commit function, the keyboard cursor isn't even consulted for where to apply the blueprint. I think it is better if this tool were just mouse-only for now.

I had left the keyboard option in cause there's a part o the community that gets cranky when there's not keyboard shortcuts for stuff. The Q key places it where the mouse cursor is, so I can see why it would be redundant, and I understand it not being worth it to cater to that small subsection of the community.

myk002 · 2023-11-08T08:24:10Z

gui/quantum.lua

+    then
+        self:commit()
+    elseif
+        keys._MOUSE_L_DOWN and not self:getMouseFramePos()


should be _MOUSE_L, not _MOUSE_L_DOWN

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

gui/quantum.lua

+    if
+        cart_count == 0
+    then
+        dfhack.run_command('workorder "{\"amount_left\":1,\"amount_total\":1,\"frequency\":\"OneTime\",\"id\":6,\"is_active\":false,\"is_validated\":true,\"item_subtype\":\"ITEM_TOOL_MINECART\",\"job\":\"MakeTool\",\"material_category\":[\"wood\"]}"')


why are you ordering a minecart via workorder instead of the order_minecart function below?

Basic answer was it was what I could get to work. The order Minecart function was one of the things I couldn't seem to get to work properly before, but now that the class stuff's been sorted out I'll see what I can do about it. I chose work order specifically because it wasn't reliant on any external blueprint or work order file and I could use a json string in the script itself. I can change it if you want me to.

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

gui/quantum.lua

-
-    local tiles = {}
+--UI Data Tables
+qspOutputHor = {


these should all be declared local

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

gui/quantum.lua

+    dump_dir = self.subviews.dir:getOptionLabel()
+    allow_refuse = self.subviews.refuse:getOptionValue()
+    input_id = dfhack.gui.getSelectedStockpile().id
+    output_hor = qspOutputHor[dump_dir]


these should all be declared local

myk002 · 2023-11-08T08:33:57Z

gui/quantum.lua

+    placed_output = output_type..'{name="'..name..'" quantum=true}:+all'
+    placed_trackstop = trackstop_dir..'{name="'..name..'" take_from='..input_id..'}'
+
+    quickfort.apply_blueprint{


this needs the error checking that was in the original code -- if the player has selected an invalid tile for the QSP, we should not blindly move forward

This was somewhat of a deliberate design choice. There are a few uses for a pseudo QSP where the output tile isn't valid to put a stockpile on, for example, dumping goblin corpses down a mass grave out of sight and out of mind, dumping ores down a huge shaft down to the magma sea and magma forges, and dumping iron minecarts onto a roller system to fill them with magma. I've even used quantum to make storm drains and water reactors via a dummy 1x1 input stockpile with no settings, since they both use the same mechanism of a dumping Minecart.

As for the error checking, wouldn't it be redundant? From what I could tell from the old version, the error checking went place trackstop (dry run), if dry placed entities = 0 then display error message, else place trackstop. What's stopping us from place trackstop, if placed entities = 0 then display error message? I could see it being necessary for the trackstop itself, rather than the output stockpile because regardless of the above niche uses or an actual QSP, neither will work without the trackstop, unless it causes problems in the backend I'm not aware of.

Update quantum.lua

f8564e0

copy pasted from the text doc, hopefully everything copied over correctly

myk002 reviewed Sep 24, 2023

View reviewed changes

(hopefully) final touchups and doodads

2061d74

hallelujah

myk002 reviewed Nov 7, 2023

View reviewed changes

[pre-commit.ci] auto fixes from pre-commit.com hooks

156315e

for more information, see https://pre-commit.ci

myk002 reviewed Nov 8, 2023

View reviewed changes

Merge branch 'master' into quantum-update

548a4fe

myk002 merged commit aa50d82 into DFHack:master Apr 27, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update quantum.lua to v50 #834

Update quantum.lua to v50 #834

MarioWizard119 commented Sep 13, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 Sep 24, 2023

myk002 commented Oct 5, 2023

myk002 left a comment

MarioWizard119 commented Nov 7, 2023

myk002 Nov 7, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023 •

edited

Loading

MarioWizard119 Nov 9, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

MarioWizard119 Nov 9, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

myk002 Nov 8, 2023

MarioWizard119 Nov 9, 2023

		message= 'QSP Placed!'
		dialogs.MessageBox{text=message:wrap(70)}:show()

Update quantum.lua to v50 #834

Update quantum.lua to v50 #834

Conversation

MarioWizard119 commented Sep 13, 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

myk002 commented Oct 5, 2023

myk002 left a comment

Choose a reason for hiding this comment

MarioWizard119 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

Choose a reason for hiding this comment

myk002 Nov 8, 2023 • edited Loading

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 Nov 8, 2023 •

edited

Loading