Historical Figures #
This section concerns manipulating historical figures.
GM Editor #
You can peek at a historical figure with gui/gm-editor df.global.world.history.figures[histfig_id].
Historical figure info
Code snippets #
Get historical figure object via its historical figure id:
histfig = df.historical_figure.find(histfig_id)
Get unit object’s historical figure id:
histfig_id = unit.hist_figure_id
Get selected (open in game’s gui) unit object’s historical figure id:
histfig_id = dfhack.gui.getSelectedUnit().hist_figure_id
Links vectors #
(stuff with st at the end)
Types reference #
Histfig entity link #
df.histfig_entity_link_type
| Index | Value |
|---|---|
| 0 | MEMBER |
| 1 | FORMER_MEMBER |
| 2 | MERCENARY |
| 3 | FORMER_MERCENARY |
| 4 | SLAVE |
| 5 | FORMER_SLAVE |
| 6 | PRISONER |
| 7 | FORMER_PRISONER |
| 8 | ENEMY |
| 9 | CRIMINAL |
| 10 | POSITION |
| 11 | FORMER_POSITION |
| 12 | POSITION_CLAIM |
| 13 | SQUAD |
| 14 | FORMER_SQUAD |
| 15 | OCCUPATION |
| 16 | FORMER_OCCUPATION |
Histfig hf link #
df.histfig_hf_link_type
| Index | Value |
|---|---|
| 0 | MOTHER |
| 1 | FATHER |
| 2 | SPOUSE |
| 3 | CHILD |
| 4 | DEITY |
| 5 | LOVER |
| 6 | PRISONER |
| 7 | IMPRISONER |
| 8 | MASTER |
| 9 | APPRENTICE |
| 10 | COMPANION |
| 11 | FORMER_MASTER |
| 12 | FORMER_APPRENTICE |
| 13 | PET_OWNER |
| 14 | FORMER_SPOUSE |
| 15 | DECEASED_SPOUSE |
Histfig relationship #
df.histfig_relationship_type
| Index | Value |
|---|---|
| -1 | None |
| 0 | Mother |
| 1 | Father |
| 2 | Parent |
| 3 | Husband |
| 4 | Wife |
| 5 | Spouse |
| 6 | SonEldest |
| 7 | SonEldest2 |
| 8 | SonEldest3 |
| 9 | SonEldest4 |
| 10 | SonEldest5 |
| 11 | SonEldest6 |
| 12 | SonEldest7 |
| 13 | SonEldest8 |
| 14 | SonEldest9 |
| 15 | SonEldest10 |
| 16 | Son |
| 17 | SonYoungest |
| 18 | SonOnly |
| 19 | DaughterEldest |
| 20 | DaughterEldest2 |
| 21 | DaughterEldest3 |
| 22 | DaughterEldest4 |
| 23 | DaughterEldest5 |
| 24 | DaughterEldest6 |
| 25 | DaughterEldest7 |
| 26 | DaughterEldest8 |
| 27 | DaughterEldest9 |
| 28 | DaughterEldest10 |
| 29 | Daughter |
| 30 | DaughterOnly |
| 31 | DaughterYoungest |
| 32 | ChildEldest |
| 33 | ChildEldest2 |
| 34 | ChildEldest3 |
| 35 | ChildEldest4 |
| 36 | ChildEldest5 |
| 37 | ChildEldest6 |
| 38 | ChildEldest7 |
| 39 | ChildEldest8 |
| 40 | ChildEldest9 |
| 41 | ChildEldest10 |
| 42 | Child |
| 43 | ChildYoungest |
| 44 | ChildOnly |
| 45 | PaternalGrandmother |
| 46 | PaternalGrandfather |
| 47 | MaternalGrandmother |
| 48 | MaternalGrandfather |
| 49 | Grandmother |
| 50 | Grandfather |
| 51 | Grandparent |
| 52 | OlderBrother |
| 53 | OlderSister |
| 54 | OlderSibling |
| 55 | YoungerBrother |
| 56 | YoungerSister |
| 57 | YoungerSibling |
| 58 | Cousin |
| 59 | Aunt |
| 60 | Uncle |
| 61 | Niece |
| 62 | Nephew |
| 63 | Sibling |
| 64 | Grandchild |
| 65 | OlderHalfBrother |
| 66 | OlderHalfSister |
| 67 | OlderHalfSibling |
| 68 | YoungerHalfBrother |
| 69 | YoungerHalfSister |
| 70 | YoungerHalfSibling |
| 71 | HalfSibling |
Histfig site link #
df.histfig_site_link_type
| Index | Value |
|---|---|
| 0 | OCCUPATION |
| 1 | SEAT_OF_POWER |
| 2 | HANGOUT |
| 3 | HOME_SITE_ABSTRACT_BUILDING |
| 4 | HOME_SITE_REALIZATION_BUILDING |
| 5 | LAIR |
| 6 | HOME_SITE_REALIZATION_SUL |
| 7 | HOME_SITE_SAVED_CIVZONE |
| 8 | PRISON_ABSTRACT_BUILDING |
| 9 | PRISON_SITE_BUILDING_PROFILE |