WIP New lua script: a gui pregnancy tool #873

Pebob · 2023-10-23T08:54:16Z

TODO:
1.Add a help string.
2.The exit function also isnt working as intended right now.
3.changelog.txt would also need to be update

anything else?

Would appreciate any feedback (new to lua / dfhack scripts)

myk002

Looks pretty good! Thank you for writing this! What about the case of creating a pregnancy without a specified father? You already have the logic for duplicating the female genes in the case of a historical father. You could extend this to support creating a pregnancy without a selected father at all.

myk002 · 2023-10-25T08:15:30Z

gui/pregnancy.lua

docs for this script would go in docs/gui/pregnancy.rst -- see other files in that directory and copy the format.

docs are still required

gui/pregnancy.lua

myk002 · 2023-10-25T16:35:23Z

gui/pregnancy.lua

+    local count = #self.msg
+    for i=0, count do self.msg[i]=nil end --empty self.msg


Suggested change

local count = #self.msg

for i=0, count do self.msg[i]=nil end --empty self.msg

self.msg = {}

Hmm... i tried this but only seem to get empty strings in the label widgets...

gui/pregnancy.lua

myk002 · 2023-10-25T16:39:25Z

gui/pregnancy.lua

+    end
+    -- self.success = false
+    if bypass or force then
+        --TODO add GUI to select the number of months for pregnancy timer


You can use a RangeSlider for this. See example here: https://github.com/DFHack/dfhack/blob/develop/plugins/lua/zone.lua#L169-L217

Thanks! I got it working (kinda) i had to reverse index my values and use the index for the get_left_idx_fn and get_right_idx_fn.

Re the RangeSlider - I have some issues dragging the slider to the minimum value (for me I have to slide all the way to the right to select the minimum).
Its not the biggest deal.

I did have to make the window pretty wide (initially i was planning to give the options in weeks). I guess RangeSlider is most suited for when there are <10 or so options?

I am curious if the reverse indexing was correct too.

gui/pregnancy.lua

Co-authored-by: Myk <[email protected]>

Pebob · 2023-10-28T18:51:30Z

Yeah, I was planning on adding a option to not have a father (you can select the mother as the father already, but it would be better to do it more explicitly (and not populate the relationship_ids.Father)

I did do some searching but I couldnt find the genes or historical figures (i found their attributes etc). Do the genes exist? or do you (or anyone else) know if there are base genes for a entity?

Thank you very much for the detailed feedback.

added Newline and self.msg changes to pregnancy.lua

myk002 · 2023-11-02T16:29:05Z

gui/pregnancy.lua

docs are still required

gui/pregnancy.lua

myk002 · 2023-11-02T16:30:20Z

gui/pregnancy.lua

-    frame_title='My Window',
-    frame={w=50, h=45},
+    frame_title='Pregnancy manager',
+    frame={w=64, h=35},
    resizable=true, -- if resizing makes sense for your dialog
    resize_min={w=50, h=20}, -- try to allow users to shrink your windows


are these numbers still appropriate?

myk002 · 2023-11-02T16:31:05Z

gui/pregnancy.lua

    resizable=true, -- if resizing makes sense for your dialog
    resize_min={w=50, h=20}, -- try to allow users to shrink your windows
 }

 function PregnancyGui:init()
-    self.mother = false
+    if dfhack.gui.getSelectedUnit(true).sex == df.pronoun_type.she then


this will throw if there is no unit selected when the UI is opened. You should check for a nil return value from getSelectedUnit() before using it

myk002 · 2023-11-02T16:32:38Z

gui/pregnancy.lua

-    self.mother = false
+    if dfhack.gui.getSelectedUnit(true).sex == df.pronoun_type.she then
+        self.mother = dfhack.gui.getSelectedUnit(true)
+    else self.mother = false


unless a field is always intended to be a boolean, it's better to leave unset values unset so they are nil instead of false.

myk002 · 2023-11-02T16:35:16Z

gui/pregnancy.lua

@@ -26,14 +40,14 @@ function PregnancyGui:init()
                },
                widgets.HotkeyLabel{
                    frame={l=0},
-                    label="Select Mother",
+                    label="Set mother to selected unit",


you could also set enabled=function() local unit = dfhack.gui.getSelectedUnit(true) return unit and unit.sex == df.pronoun_type.she end,

and similarly for the father HotkeyLabel

myk002 · 2023-11-02T16:39:39Z

gui/pregnancy.lua

                    options={{label='On', value=true, pen=COLOR_GREEN},
                    {label='Off', value=false, pen=COLOR_RED}},
                    initial_option=false
                },
+                widgets.TooltipLabel{


Can you use a plain Label here? The attributes you're setting seem to undo everything that makes it a TooltipLabel

myk002 · 2023-11-02T16:42:38Z

gui/pregnancy.lua

+    local term_index = {}
+    local months
+    for months=0,10 do
+        -- table.insert(term_options,{label=('%s months'):format(months),value=months}) --I tried this to add labels, probably doing something wrong, it broke the range widget


I notice below you were getting the label to index an array. this should work fine if you get the option value instead

myk002 · 2024-01-06T01:14:22Z

Is this PR still in progress?

myk002 · 2024-08-13T00:43:51Z

I'll see if I can get this fixed up and merged

script for a gui pregnancy tool

f41adf2

Pebob changed the title ~~New lua script: a gui pregnancy tool~~ WIP New lua script: a gui pregnancy tool Oct 23, 2023

myk002 reviewed Oct 25, 2023

View reviewed changes

Pebob and others added 4 commits October 28, 2023 15:20

Implementing myk002's suggestions

15e6752

added Rangeslider widget for pregnancy term

d0d7106

Apply suggestions from code review

523c585

Co-authored-by: Myk <[email protected]>

More myk002 suggestions/corrections

fb43a1e

myk002 newline+msg changes pregnancy.lua

04d2b66

added Newline and self.msg changes to pregnancy.lua

myk002 reviewed Nov 2, 2023

View reviewed changes

myk002 mentioned this pull request Feb 11, 2024

catsplosion should avoid causing pregnancies in children DFHack/dfhack#4263

Closed

Merge branch 'master' into WIP-pregnancy

c144ed3

myk002 mentioned this pull request Aug 13, 2024

new tool: gui/pregnancy #1267

Merged

myk002 merged commit c144ed3 into DFHack:master Aug 13, 2024
8 of 10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP New lua script: a gui pregnancy tool #873

WIP New lua script: a gui pregnancy tool #873

Pebob commented Oct 23, 2023 •

edited

Loading

myk002 left a comment

myk002 Oct 25, 2023

myk002 Nov 2, 2023

myk002 Oct 25, 2023

Pebob Oct 28, 2023

myk002 Oct 25, 2023

Pebob Oct 28, 2023

Pebob Oct 28, 2023

Pebob commented Oct 28, 2023 •

edited

Loading

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 Nov 2, 2023

myk002 commented Jan 6, 2024

myk002 commented Aug 13, 2024

		local count = #self.msg
		for i=0, count do self.msg[i]=nil end --empty self.msg

	local count = #self.msg
	for i=0, count do self.msg[i]=nil end --empty self.msg
	self.msg = {}

WIP New lua script: a gui pregnancy tool #873

WIP New lua script: a gui pregnancy tool #873

Conversation

Pebob commented Oct 23, 2023 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Pebob commented Oct 28, 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

myk002 commented Jan 6, 2024

myk002 commented Aug 13, 2024

Pebob commented Oct 23, 2023 •

edited

Loading

Pebob commented Oct 28, 2023 •

edited

Loading