bath house bribes blunders

Author: Trolldemorted

src/SUMMARY.md

@@ -11,6 +11,8 @@
     - [Ship Types](./basics/ships.md)
     - [Ship Artillery](./basics/ship-artillery.md)
 - [Operations](./operations.md)
+    - [Bath House Bribe Success](./operations/0042-bath-house-bribe-success.md)
+    - [Bath House Bribe Failure](./operations/0043-bath-house-bribe-failure.md)
     - [Tavern Interaction](./operations/0052-tavern-interaction.md)
 - [Scheduled Tasks](./scheduled-tasks/0000.md)
     - [Update Shipyard Experience](./scheduled-tasks/0006-update-shipyard-experience.md)
@@ -53,6 +55,7 @@
     - [Siege Beggar Satisfaction Bonus](./bugs/siege-beggar-satisfaction-bonus.md)
     - [Damage to Offside Ship Artillery](./bugs/damage-to-offside-ship-artillery.md)
     - [Invulnerable Ship Artillery Slots](./bugs/invulnerable-ship-artillery-slots.md)
+    - [Bath House Bribes Blunders](./bugs/bath-house-bribes-blunders.md)
 - [Patches](./patches.md)
     - [High Res](./patches/high-res.md)
     - [Increase Alderman "Found Settlement" Mission Limit](./patches/increase-alderman-found-settlement-limit.md)

src/bugs/bath-house-bribes-blunders.md

@@ -0,0 +1,75 @@
+# Bath House Bribes Blunders
+
+## Summary
+The bath house bribes are affected by three different bugs:
+- If a merchant's offer is lower than the councillor's expectations and the councillor hasn't been bribed by anyone else, the councillor is bribed by the merchant with the index `1`.
+- Annoying a councillor in one town affects councillors in all towns.
+- Limits on the bribability don't have any effect.
+
+## Details
+
+### Attribution to Merchant `1`
+The `handle_operation_bath_house_bribe_failure` function at `0x0053AD10` sets the councillor's briber to `1`, if the councillor was not already bribed by anyone.
+
+This also prevents you from getting the *"Are you there again?! Let me have my bath in peace, please."* line you are supposed to get with annoyed councillors.
+Instead you'll get the *"Ah! You're here as well, John Doe? I have only very recently spoken to one of your competitors."* line, since the councillor is now bribed by merchant `1`.
+
+### Unforgiving Bath Houses
+The bath house remembers only the index of annoyed local councillors (0-3), and not to which town they belong.
+If you annoy the first councillor in one town, the first councillor in every town will stop talking to you, and so forth.
+
+While the annoyed *"Are you there again?! Let me have my bath in peace, please."* line is unreachable in the correct town due to the attribution bug, you do get it if you encounter a councillor with the same index in a different town.
+
+### Limitless Corruption
+The `handle_operation_bath_house_bribe_success` function at `0x0053AC50` applies the briber only if a particular value is smaller than 2:
+```c
+bribed_councillors = 0;
+previous_bribing_merchant = static_game_world.field_68_towns[town_index].field_6DC_councillor_bribes[this->args.unknown.arg1];
+v6 = 4;
+do
+{
+    if (previous_bribing_merchant == merchant_index)
+        ++bribed_councillors;
+    --v6;
+}
+while (v6);
+merchant = get_merchant(&static_game_world, merchant_index);
+old_recent_donations = merchant->field_4BC_recent_donations;
+merchant->field_0_money -= this->args.unknown.arg3;
+merchant->field_4BC_recent_donations = this->args.unknown.arg3 + old_recent_donations;
+merchant_bribe_success_increase_social_reputation(merchant, this->args.unknown.arg4, this->args.unknown.arg3);
+if (bribed_councillors < 2) {
+    static_game_world.field_68_towns[this->args.unknown.arg4].field_6DC_councillor_bribes[this->args.unknown.arg1] = this->args.unknown.arg2;
+}
+```
+
+Since neither `previous_bribing_merchant` nor `merchant_index` change during the loop, the final value of `bribed_councillors` is always either 0 or 4.
+This doesn't make any sense as it is, so it is assumed that `bribed_councillors` was intended to be the amount of already bribed councillors in that town, and that the comparison with 2 was intended to prevent a player from bribing the majority of councillors in one town.
+
+## Fix
+All bugs are fixed by the [fox-bath-house-bribe-blunders](https://github.com/P3Modding/p3-lib/tree/master/mod-fix-bath-house-bribe-blunders) mod.
+
+### Attribution to Merchant `1`
+The councillor's briber must be set to `-1` instead of `1` if the bribe fails and the councillor is not bribed by anyone else.
+The original instruction:
+```asm
+.text:0053AD85                 mov     byte ptr [ecx], 1
+```
+must be replaced with:
+```asm
+.text:0053AD85                 mov     byte ptr [ecx], -1
+```
+
+### Unforgiving Bath Houses
+This cannot be properly fixed easily.
+However, resetting the annoyance when opening the bath house is just a small change.
+Since the annoyances are reset if the bath house is not opened for 256 ticks, one can replace the conditional jump around the reset code with nops:
+```asm
+.text:005B17B7 jbe     short loc_5B17CC
+```
+
+### Limitless Corruption
+This issue is fixed by moving the `previous_bribing_merchant` assignment into the loop and using the loop counter instead of the argument to index the bribes array.
+
+## Footnotes
+Since the probability of each councillor appearing is just 7%, you can use the [debug bath house IDC script](https://github.com/P3Modding/p3_ida_scripts) to change it to 100%.

src/operations.md

@@ -87,6 +87,8 @@ The following operations have been identified:
 |0x37|Join Guild|
 |0x39|Bathe|
 |0x41|Form Militia Squad|
+|0x42|Bath House Bribe Success|
+|0x43|Bath House Bribe Failure|
 |0x52|Tavern Interaction|
 |0xc2|Autosave|
 |0xc4|Advance Time|

src/operations/0042-bath-house-bribe-success.md

@@ -0,0 +1,2 @@
+# Bath House Bribe Success
+The `handle_operation_bath_house_bribe_success` function at `0x0053AC50` applies the effects of a successful bribe.

src/operations/0043-bath-house-bribe-failure.md

@@ -0,0 +1,7 @@
+# Bath House Bribe Failure
+The `handle_operation_bath_house_bribe_failure` function at `0x0053AD10` applies the effects of a failed bribe.
+
+The merchant's social reputation in the corresponding town is decreased by `2.0`.
+
+**If the councillor was already successfully bribed by the merchant or not bribed by any merchant, he will now be bribed by the merchant with the index 1.
+This is wrong, as discussed in the Known Bugs chapter.**

src/ships/sea-battles/hitboxes.md

@@ -51,4 +51,4 @@ The jump table at `0x0060AD69` maps intersections of the projectile's path with
 This defines the following line-to-location mapping:
 ![](hitboxes_impact_location.png)
 
-**The mapping is incorrect, as discussed in the Known Bugs chapter**.
+**The mapping is incorrect, as discussed in the Known Bugs chapter.**

src/towns/bath-house.md

@@ -55,12 +55,29 @@ def calculate_bribe_result(amount: int, rank: int, already_bribed: bool):
         return BribeResult.FAILED
 ```
 
+### Result
 The result can be identified by the councillor's response:
 
 |Result|Response|
 |-|-|
-|Ok|"Aha, a bribe eh! But all right, I'll take your gold. We'll see what I can do for you at the appointed time."|
-|Good|"Oh, that's a very enticing sum. You can be certain of my loyalty."|
-|Failed|"What am I supposed to do with this pittance? You ought to realise yourself, that a man in my position expects a little more from someone of your standing."|
+|Ok|*"Aha, a bribe eh! But all right, I'll take your gold. We'll see what I can do for you at the appointed time."*|
+|Good|*"Oh, that's a very enticing sum. You can be certain of my loyalty."*|
+|Failed|*"What am I supposed to do with this pittance? You ought to realise yourself, that a man in my position expects a little more from someone of your standing."*|
 
-Both `Ok` and `Good` enqueue a *Bath House Bribe Success* operation, while `Failed` enqueues a *Bath House Bribe Failed* operation.
+Both `Ok` and `Good` enqueue a *Bath House Bribe Success* operation, while `Failed` enqueues a *Bath House Bribe Failure* operation.
+**The failure operation is bugged, as discussed in the Known Bugs chapter.**
+
+### Status
+The current status of a councillor can be inferred by his lines:
+
+|Status|Response|
+|-|-|
+|Bribed by merchant|*"So we meet again, John Doe. I can very well remember how pleasant our last meeting was."*|
+|Bribed by other merchant|*"Ah! You're here as well, John Doe? I have only very recently spoken to one of your competitors."*|
+|Not bribed by anyone, annoyed|*"Are you there again?! Let me have my bath in peace, please."*|
+
+**The annoyance of the councillor with a given index is bugged and saved globally, as discussed in the Known Bugs chapter.**
+
+### Limits
+The success operation has a check which probably should prevent a merchant from bribing more than 2 councillors in one town.
+**However, this check is bugged, as discussed in the Known Bugs chapter.**

src/towns/population.md

@@ -33,6 +33,7 @@ At `0x00672860` there is a table that contains the daily consumptions for 100 ci
 |Carbine|0|0|0|0|
 
 If a town is not under siege and a ware is in oversupply, more of it is consumed.
+**TODO clarify**
 **TODO pitch consumption (sieged and unsieged), winter/famine/plague modifiers**
 
 ## Satisfaction