more investigation, basic letters

Author: Trolldemorted

src/SUMMARY.md

@@ -15,6 +15,7 @@
     - [Bath House Bribe Failure](./operations/0043-bath-house-bribe-failure.md)
     - [Tavern Interaction](./operations/0052-tavern-interaction.md)
 - [Scheduled Tasks](./scheduled-tasks/0000.md)
+    - [Criminal Investigation](./scheduled-tasks/0005-criminal-investigation.md)
     - [Update Shipyard Experience](./scheduled-tasks/0006-update-shipyard-experience.md)
     - [Celebration](./scheduled-tasks/0007-celebration.md)
     - [Update Sailor Pools](./scheduled-tasks/0026-update-sailor-pools.md)
@@ -48,6 +49,9 @@
             - [Range](./ships/sea-battles/projectiles/range.md)
             - [Impact](./ships/sea-battles/projectiles/impact.md)
         - [Reefs](./ships/sea-battles/reefs.md)
+- [Letters](./letters.md)
+    - [Charge](./letters/0a-charge.md)
+    - [Indictment](./letters/19-indictment.md)
 - [Modloader](./modloader.md)
 - [Known Bugs](./bugs.md)
     - [New Settlement Ware Production](./bugs/new-settlement-ware-production.md)

src/ch05-03-reputation.md

@@ -62,7 +62,7 @@ TODO list options
 
 ## Social
 `local_social_rep` is the merchant's social reputation in the town.
-It is changed through by many actions, and degrades over time.
+It is changed through many actions, and degrades over time.
 
 ### Recurring Constants
 The following values appear in multiple calculations, and appear to have fixed values.

src/letters.md

@@ -0,0 +1 @@
+# Letters

src/letters/0a-charge.md

@@ -0,0 +1,15 @@
+# Charge
+Charge letters are sent by criminal investigation scheduled tasks.
+
+## Text
+A charge letter always starts with *Today, you have been charged for the following reason*.
+The following text depends on the crime type:
+
+|Crime Type|Text|
+|-|-|
+|5|*You have been seen behaving indecently.*|
+|6|*You are accused of heresy.*|
+|7|*You have stated that the world is round.*|
+|8|*You stand accused of taking part in a punishable offence, undermining the good of the Hanseatic League.*|
+
+Finally the suffix *We will thoroughly examine this charge and inform you of the outcome of investigations as soon as possible* is appended to every accusation letter.

src/letters/19-indictment.md

@@ -0,0 +1,23 @@
+# Indictment
+Indictment letters are sent by criminal investigation scheduled tasks.
+
+## Text
+The text depends on the crime type:
+
+|Crime Type|Content|
+|-|-|
+|0|*Severe charges have been made against you. The court will be provided with evidence that you met in %s in the town of %s with lawless elements, and obviously made criminal plans with them.*|
+|1|*You are accused of recently committing a breach of the rules of the Hanseatic League by breaking the Boycott of %s. Several traders observed you in this law-breaking deed.*|
+|2|*Several witnesses have sworn that they recognised your ship %s during the recent pirates attack, and that it was flying the pirate's flag.*|
+|3|*A worthless scoundrel was taken into custody in %s today, as he was breaking into the trading office of %s %s in pursuit of his criminal activities. Under careful questioning, he admitted the deed, and said, that you had paid him, to carry out this treacherous burglary.*|
+|4|*A capable trader recently succeeded in boarding a cowardly pirate ship and arrested the captain. At first, he did not admit anything, but couldn't hold out against our penetrating interrogation, and admitted it was your idea and with your support that he did this.*|
+|8|*You stand accused of taking part in a punishable offence, undermining the good of the Hanseatic League.*|
+|9|*Several witnesses to a recent pirate attack, have sworn that they recognised your ship, %s with a pirate flag run up the mast and firing on Hanseatic League ships.*|
+|10|*Several witnesses to a recent pirate attack, have sworn that they recognised your ship %s with a pirate flag run up the mast and plundering Hanseatic League ships.*|
+|11|*Several witnesses to a recent pirate attack, have sworn that they recognised your ship %s with a pirate flag run up the mast and sinking Hanseatic League ships.*|
+|12|*Several witnesses to a recent pirate attack, have sworn that they recognised your ship %s with a pirate flag run up the mast and capturing Hanseatic Leagueague ships.*|
+|13|*Several witnesses to a recent pirate attack on %s have sworn that they recognised your ship %s displaying a pirate flag run up the mast.*|
+|14|*Several witnesses to a recent pirate attack on %s have sworn that they recognised your ship %s displaying a pirate flag run up the mast and firing on the town's defences.*|
+|15|*Several witnesses to a recent pirate attack on %s have sworn that they recognised your ship %s displaying a pirate flag run up the mast, breaching the town's defences and plundering the town's coffers.*|
+
+The suffix *We will investigate this atrocious charge. Expect a message in the near future, which will inform you of the results of our investigations* is appended to every indictment letter.

src/operations/0052-tavern-interaction.md

@@ -33,7 +33,7 @@ An investigation is started only if all of the following conditions are met:
 - The following formula is true: `(rand & 0x3ff) < 102`
 - The following formula is true: `weaponsdealer_timestamp < now + 0x200`
 
-If all conditions are met, the investigation scheduled task is scheduled at `(now + 0x200) | 0x80`, and the weapons dealer timestamp is set to `now`.
+If all conditions are met, a criminal investigation scheduled task is scheduled to `(now + 0x200) | 0x80`, and the weapons dealer timestamp is set to `now`.
 
 ## Burglar
 The burglar is handled like the weapons dealer, except the exceptions for alderman, local mayor and town status don't exist.

src/scheduled-tasks/0005-criminal-investigation.md

@@ -0,0 +1,69 @@
+# Criminal Investigation
+
+## Begin
+When a criminal investigation task is executed for the first time, the status is `crime_investigation_status_pending`.
+The task handler sends a *Charge* or *Indictment* letter to the offending merchant, sets the status to `crime_investigation_status_investigating`, and reschedules the task according to the result of the following computation:
+```c
+(now + (((now & 7) + 8) << 8)) | 0x80
+```
+
+The lower 3 bits of the current time are used as a synchronized pseudorandom number ranging from `0` to `7`.
+To that number `8` is added, and the result is shifted by `8` to get a timespan between 8 to 15 days.
+That timespan is added to the current time, and the 8th bit is set to constrain the time of day between 12:00 and 24:00.
+
+Both random fields are filled with the result of `rand()` with a `RAND_MAX` of `32767`.
+
+## Verdict
+TODO
+
+## Scheduled Task Data
+The following task fields have been identified:
+```c
+struct scheduled_task_criminal_investigation
+{
+  unsigned __int8 field_0_merchant_index __tabform(NODUPS);
+  unsigned __int8 field_1_town_index;
+  char field_2;
+  unsigned __int8 field_3_hometown_index;
+  int field_4_timestamp;
+  crime_type field_8_crime_type;
+  crime_investigation_status field_9_status;
+  unsigned __int16 field_A_random1;
+  unsigned __int16 field_C_random2;
+  signed __int16 field_E;
+};
+```
+
+where `crime_type` was found to be:
+```c
+enum crime_type : unsigned __int8
+{
+  crime_type_criminal_plans = 0x0,
+  crime_type_boycott_broken = 0x1,
+  crime_type_pirate_attack = 0x2,
+  crime_type_burglary = 0x3,
+  crime_type_pirate_sponsor = 0x4,
+  crime_type_indecent_behaviour = 0x5,
+  crime_type_heresy = 0x6,
+  crime_type_round_world = 0x7,
+  crime_type_undermining_league = 0x8,
+  crime_type_pirate_firing_on_ships = 0x9,
+  crime_type_pirate_plundering_ships = 0xA,
+  crime_type_pirate_sinking_ships = 0xB,
+  crime_type_pirate_capturing_ships = 0xC,
+  crime_type_pirate_attacking_town = 0xD,
+  crime_type_pirate_firing_on_town = 0xE,
+  crime_type_pirate_plundering_town = 0xF,
+};
+```
+
+and `crime_investigation_status` was found to be:
+```c
+enum crime_investigation_status : unsigned __int8
+{
+  crime_investigation_status_pending = 0x0,
+  crime_investigation_status_investigating = 0x1,
+  crime_investigation_status_confiscation_successful = 0x2,
+  crime_investigation_status_unknown = 0x3,
+};
+```