Skip to content

Commit

Permalink
gui/pregnancy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
myk002 committed Aug 13, 2024
1 parent a53e7c7 commit 97392d8
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Template for new versions:

## New Tools
- `embark-anyone`: allows you to embark as any civilisation, including dead, and non-dwarven ones
- `gui/pregnancy`: view and generate pregnancies with specified parents

## New Features
- `caravan`: DFHack dialogs for trade screens (both ``Bring goods to depot`` and the ``Trade`` barter screen) can now filter by item origins (foreign vs. fort-made) and can filter bins by whether they have a mix of ethically acceptable and unacceptable items in them
Expand Down
32 changes: 32 additions & 0 deletions docs/gui/pregnancy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
gui/pregnancy
=============

.. dfhack-tool::
:summary: Generate pregnancies with pairings of your choice.
:tags: adventure fort armok animals units

This tool provides an interface for producing pregnancies with specific mothers
and fathers.

If a unit is selected when you run `gui/pregnancy`, they will be pre-selected
as a parent. If the unit has a spouse of a different gender, they will be
automatically selected as the other parent. You can click on other units on the
map and choose them as alternate mothers or fathers as desired.

If a unit is selected as a mother or father, or is listed as a spouse, you can
zoom the map to their location by clicking on their name in the `gui/pregnancy`
UI.

A unit must be on the map to participate in a pregnancy. For example, you
cannot designate a father that is not on-site, even if they are the selected
mother's spouse.

Children cannot be selected as a parent, and, due to game limitations,
cross-species pregnancies are not supported.

Usage
-----

::

gui/pregnancy
14 changes: 12 additions & 2 deletions gui/pregnancy.lua
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,18 @@ function Pregnancy:init()
key_back='CUSTOM_SHIFT_Z',
key='CUSTOM_Z',
options={
{label='Default', value='default'},
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
{label='Default', value='default', pen=COLOR_BROWN},
{label='0', value=0, pen=COLOR_BROWN},
{label='1', value=1, pen=COLOR_BROWN},
{label='2', value=2, pen=COLOR_BROWN},
{label='3', value=3, pen=COLOR_BROWN},
{label='4', value=4, pen=COLOR_BROWN},
{label='5', value=5, pen=COLOR_BROWN},
{label='6', value=6, pen=COLOR_BROWN},
{label='7', value=7, pen=COLOR_BROWN},
{label='8', value=8, pen=COLOR_BROWN},
{label='9', value=9, pen=COLOR_BROWN},
{label='10', value=10, pen=COLOR_BROWN},
},
initial_option='default',
},
Expand Down

0 comments on commit 97392d8

Please sign in to comment.