From 4d6bf8c37ec97f8940438977fa94439c87ee46a5 Mon Sep 17 00:00:00 2001
From: PatrikLundell <j.patrik.r.lundell@gmail.com>
Date: Fri, 14 Feb 2020 15:14:36 +0100
Subject: [PATCH] field matching to XML. updated history_event_reason

---
 df.history.xml | 204 +++++++++++++++++++++++++++----------------------
 1 file changed, 111 insertions(+), 93 deletions(-)

diff --git a/df.history.xml b/df.history.xml
index a6113f59a..5fdf920b0 100644
--- a/df.history.xml
+++ b/df.history.xml
@@ -824,94 +824,112 @@
         <enum-item name='HF_INTERROGATED' since='v0.47.01'/>
     </enum-type>
 
-    <enum-type type-name='history_event_reason'>
+    <enum-type type-name='history_event_reason' comment="Some of these require at least one parameter of varying type. The text is what DF provides without parameter">
         <enum-item name='none' value='-1'/>
 
-        <enum-item name='insurrection'/>
-        <enum-item name='adventure'/>
-        <enum-item name='guide'/>
-        <enum-item name='rescued'/>
-        <enum-item name='sphere_alignment'/>
-        <enum-item name='maintain_balance_in_universe'/>
-        <enum-item name='highlight_boundaries_between_worlds'/>
-        <enum-item name='sow_the_seeds_of_chaos_in_the_world'/>
-        <enum-item name='provide_opportunities_for_courage'/>
-        <enum-item name='bring_death_to_the_world'/>
-
-        <enum-item name='liked_appearance'/>
-        <enum-item name='because_it_was_destined'/>
-        <enum-item name='great_fortresses_built_and_tested'/>
-        <enum-item name='whim'/>
-        <enum-item name='bring_misery_to_the_world'/>
-        <enum-item name='bring_murder_to_the_world'/>
-        <enum-item name='bring_nightmares_into_reality'/>
-        <enum-item name='bring_thralldom_to_the_world'/>
-        <enum-item name='bring_torture_to_the_world'/>
-        <enum-item name='provide_opportunities_for_acts_of_valor'/>
-
-        <enum-item name='bring_war_to_the_world'/>
-        <enum-item name='find_relative'/>
-        <enum-item name='offer_condolences'/>
-        <enum-item name='be_brought_to_safety'/>
-        <enum-item name='help_with_rescue'/>
-        <enum-item name='insufficient_work'/>
-        <enum-item name='work_request'/>
-        <enum-item name='make_weapon'/>
-        <enum-item name='vent_at_boss'/>
-        <enum-item name='cry_on_boss'/>
-
-        <enum-item name='should_have_reached_goal'/>
-        <enum-item name='insufficient_progress_toward_goal'/>
-        <enum-item name='going_wrong_direction'/>
-        <enum-item name='arrived_at_location'/>
-        <enum-item name='entity_no_longer_rules'/>
-        <enum-item name='left_site'/>
-        <enum-item name='reunited_with_loved_one'/>
-        <enum-item name='violent_disagreement'/>
-        <enum-item name='adopted'/>
-        <enum-item name='true_name_invocation'/>
-
-        <enum-item name='arrived_at_person'/>
-        <enum-item name='eradicate_beasts'/>
-        <enum-item name='entertain_people'/>
-        <enum-item name='make_a_living_as_a_warrior'/>
-        <enum-item name='study'/>
-        <enum-item name='flight'/>
-        <enum-item name='scholarship'/>
-        <enum-item name='be_with_master'/>
-        <enum-item name='become_citizen'/>
-        <enum-item name='prefers_working_alone'/>
-
-        <enum-item name='jealousy'/>
-        <enum-item name='glorify_hf'/>
-        <enum-item name='have_not_performed'/>
-        <enum-item name='prevented_from_leaving'/>
-        <enum-item name='curiosity'/>
-        <enum-item name='hire_on_as_mercenary'/>
-        <enum-item name='hire_on_as_performer'/>
-        <enum-item name='hire_on_as_scholar'/>
-        <enum-item name='drink'/>
-        <enum-item name='admire_architecture'/>
-
-        <enum-item name='pray'/>
-        <enum-item name='relax'/>
-        <enum-item name='danger'/>
-        <enum-item name='cannot_find_artifact'/>
-        <enum-item name='failed_mood'/>
-        <enum-item name='lack_of_sleep'/>
-        <enum-item name='trapped_in_cage'/>
-        <enum-item name='great_deal_of_stress'/>
-        <enum-item name='unable_to_leave_location'/>
-        <enum-item name='sanctify_hf'/>
-
-        <enum-item name='artifact_is_heirloom_of_family_hfid'/>
-        <enum-item name='cement_bonds_of_friendship'/>
-        <enum-item name='as_a_symbol_of_everlasting_peace'/>
-        <enum-item name='on_a_pilgrimage'/>
-        <enum-item name='gather_information'/>
-        <enum-item name='seek_sanctuary'/>
-        <enum-item name='part_of_trade_negotiation'/>
-        <enum-item name='artifact_is_symbol_of_entity_position'/>
+        <enum-item name='insurrection' caption='for an insurrection'/>
+        <enum-item name='adventure' caption='to adventure'/>
+        <enum-item name='guide' caption='as a guide'/>
+        <enum-item name='rescued' caption='in order to be rescued'/>
+        <enum-item name='sphere_alignment' caption='due to their cosmic similarity'/>
+        <enum-item name='maintain_balance_in_universe' caption='in order to maintain balance in the universe'/>
+        <enum-item name='highlight_boundaries_between_worlds' caption='to create a monument to the boundaries between realities'/>
+        <enum-item name='sow_the_seeds_of_chaos_in_the_world' caption='to sow the seeds of chaos within'/>
+        <enum-item name='provide_opportunities_for_courage' caption='to provide opportunities for courage to rise'/>
+        <enum-item name='bring_death_to_the_world' caption='that more might die'/>
+
+        <enum-item name='liked_appearance' caption='that all should gaze upon a truly gruesome visage'/>
+        <enum-item name='because_it_was_destined' caption='because it was destined'/>
+        <enum-item name='great_fortresses_built_and_tested' caption='that great fortresses might be raised and tested in siege'/>
+        <enum-item name='whim' caption='on a whim'/>
+        <enum-item name='bring_misery_to_the_world' caption='that it might bathe in misery forever'/>
+        <enum-item name='bring_murder_to_the_world' caption='that more might be murdered'/>
+        <enum-item name='bring_nightmares_into_reality' caption='in order to make nightmares reality'/>
+        <enum-item name='bring_thralldom_to_the_world' caption='in order to make thralls of everyone'/>
+        <enum-item name='bring_torture_to_the_world' caption='in order that acts of torture be perpetrated'/>
+        <enum-item name='provide_opportunities_for_acts_of_valor' caption='to provide opportunities for acts of valor to be performed'/>
+
+        <enum-item name='bring_war_to_the_world' caption='that war might rage forever'/>
+        <enum-item name='find_relative' caption='in order to find a relative'/>
+        <enum-item name='offer_condolences' caption='to offer condolences'/>
+        <enum-item name='be_brought_to_safety' caption='in order to be brought to safety'/>
+        <enum-item name='help_with_rescue' caption='to help with a rescue'/>
+        <enum-item name='insufficient_work' caption='due to insufficient work'/>
+        <enum-item name='work_request' caption='to request work'/>
+        <enum-item name='make_weapon' caption='that weapons be made'/>
+        <enum-item name='vent_at_boss' caption='to vent at somebody in charge'/>
+        <enum-item name='cry_on_boss' caption='to cry on somebody in charge'/>
+
+        <enum-item name='should_have_reached_goal' caption='as the goal was not reached'/>
+        <enum-item name='insufficient_progress_toward_goal' caption='as insufficient progress was made toward the goal'/>
+        <enum-item name='going_wrong_direction' caption='after going the wrong direction'/>
+        <enum-item name='arrived_at_location' caption='after arriving at the location'/>
+        <enum-item name='entity_no_longer_rules' caption='as the relevant government was no longer in control'/>
+        <enum-item name='left_site' caption='after leaving the site'/>
+        <enum-item name='reunited_with_loved_one' caption='after being reunited with a loved one'/>
+        <enum-item name='violent_disagreement' caption='after a violent disagreement'/>
+        <enum-item name='adopted' caption='after adoption'/>
+        <enum-item name='true_name_invocation' caption='after invocation of the true name'/>
+
+        <enum-item name='arrived_at_person' caption='after finding an unknown creature'/>
+        <enum-item name='eradicate_beasts' caption='in order to eradicate beasts'/>
+        <enum-item name='entertain_people' caption='in order to entertain people'/>
+        <enum-item name='make_a_living_as_a_warrior' caption='in order to make a living as a warrior'/>
+        <enum-item name='study' caption='in order to study'/>
+        <enum-item name='flight' caption='in order to flee'/>
+        <enum-item name='scholarship' caption='in order to pursue scholarship'/>
+        <enum-item name='be_with_master' caption='in order to be with the master'/>
+        <enum-item name='become_citizen' caption='in order to become a citizen'/>
+        <enum-item name='prefers_working_alone' caption='in order to continue working alone'/>
+
+        <enum-item name='jealousy' caption='due to jealousy'/>
+        <enum-item name='glorify_hf' caption='in order to glorify an unknown creature'/>
+        <enum-item name='have_not_performed' caption='due to a lack of performances'/>
+        <enum-item name='prevented_from_leaving' caption='after being prevented from leaving'/>
+        <enum-item name='curiosity' caption='out of curiosity'/>
+        <enum-item name='hire_on_as_mercenary' caption='to fill a role as a mercenary'/>
+        <enum-item name='hire_on_as_performer' caption='to fill a role as a performer'/>
+        <enum-item name='hire_on_as_scholar' caption='to fill a role as a scholar'/>
+        <enum-item name='drink' caption='in order to drink'/>
+        <enum-item name='admire_architecture' caption='in order to admire achitecture'/>
+
+        <enum-item name='pray' caption='in order to pray'/>
+        <enum-item name='relax' caption='in order to relax'/>
+        <enum-item name='danger' caption='to experience danger'/>
+        <enum-item name='cannot_find_artifact' caption='after being unable to find an artifact'/>
+        <enum-item name='failed_mood' caption='after failing to create an artifact'/>
+        <enum-item name='lack_of_sleep' caption='due to a lack of sleep'/>
+        <enum-item name='trapped_in_cage' caption='after being trapped in a cage'/>
+        <enum-item name='great_deal_of_stress' caption='after a great deal of stress'/>
+        <enum-item name='unable_to_leave_location' caption='after being unable to leave a location'/>
+        <enum-item name='sanctify_hf' caption='in order to sanctify an unknown creature'/>
+
+        <enum-item name='artifact_is_heirloom_of_family_hfid' caption='as an heirloom of the an unknown creature family'/>
+        <enum-item name='cement_bonds_of_friendship' caption='in order to cement the bonds of friendship'/>
+        <enum-item name='as_a_symbol_of_everlasting_peace' caption='as a symbol of everlasting peace'/>
+        <enum-item name='on_a_pilgrimage' caption='on a pilgrimage'/>
+        <enum-item name='gather_information' caption='to gather information'/>
+        <enum-item name='seek_sanctuary' caption='in order to find sactuary'/>
+        <enum-item name='part_of_trade_negotiation' caption='as part of a trade negotiation'/>
+        <enum-item name='artifact_is_symbol_of_entity_position' caption='as a symbol of authority within an unknown civilization'/>
+        <enum-item name='fear_of_persecution' since='0.47.01' comment='The ones below were introduced as well' caption='due to fear of persecution'/>
+        <enum-item name='smooth_operation' caption='to smooth the operation of an unknown civilization'/>
+        
+        <enum-item name='nuance_belief' caption='due to a belief in nuances of'/>
+        <enum-item name='shared_interest' caption='due to a shared interest in'/>
+        <enum-item name='envy_living' caption='due to envy of those that live on'/>
+        <enum-item name='death_panic' caption='due to panic about what happens after death'/>
+        <enum-item name='death_fear' caption='due to fear of death'/>
+        <enum-item name='avoid_judgement' caption='unable to face any possible judgment and the afterlife'/>
+        <enum-item name='death_pride' caption='being too proud to give in to death'/>
+        <enum-item name='death_vain' caption='being too vain to give in to death'/>
+        <enum-item name='death_ambition' caption='having ambitions for which death was only a small obstacle'/>
+        <enum-item name='lack_of_funds' caption='due to lack of funds'/>
+        
+        <enum-item name='battle_losses' caption='after taking heavy losses in battle'/>
+        <enum-item name='conviction_exile' caption='after being exiled following a criminal conviction'/>
+        <enum-item name='priest_vent' caption='to vent at a priest'/>
+        <enum-item name='priest_cry' caption='to cry on a priest'/>
     </enum-type>
 
     <struct-type type-name='history_event_context'>
@@ -2293,9 +2311,9 @@
     </class-type>
 
     <class-type type-name='history_event_add_hf_entity_honorst' inherits-from='history_event' since='v0.47.01'>
-      <int32_t name='entity' ref-target='historical_entity'/>
-      <int32_t name='hf' ref-target='historical_figure'/>
-      <int32_t comment='index or identifier for the honor?'/>
+      <int32_t name='entity_id' ref-target='historical_entity'/>
+      <int32_t name='hfid' ref-target='historical_figure'/>
+      <int32_t name='honor_id' comment='Name from XML. Currently unknown what it references'/>
     </class-type>
 
     <class-type type-name='history_event_gamblest' inherits-from='history_event' since='v0.47.01'>
@@ -2308,10 +2326,10 @@
 
     <class-type type-name='history_event_entity_dissolvedst' inherits-from='history_event' since='v0.47.01'>
       <int32_t name='entity' ref-target='historical_entity'/>
-      <int32_t/>
-      <int32_t/>
-      <int32_t name='reason' comment='89: due to lack of funds, 90: after taking heavy losses in battle'/> probably new values for history_event_reason
-      <int32_t/>
+      <int32_t name='unk_v47_1' comment="Wouldn't be surprised if unk_v47_1, unk_v47_2, and parameter have similar roles as in unit thoughts"/>
+      <int32_t name='unk_v47_2'/>
+      <int32_t name='reason' ref-targe='history_event_reason'/>
+      <int32_t name='parameter' init-value='-1' comment="Type probably dependent on reason (with 40 it's a hfid)"/>
     </class-type>
 
     <class-type type-name='history_event_entity_equipment_purchasest' inherits-from='history_event' since='v0.47.01'>