tavern interaction, bath house

Author: Trolldemorted

src/SUMMARY.md

@@ -10,7 +10,8 @@
     - [Storage](./basics/storage.md)
     - [Ship Types](./basics/ships.md)
     - [Ship Artillery](./basics/ship-artillery.md)
-- [Operations](./0010-operations/0000.md)
+- [Operations](./operations.md)
+    - [Tavern Interaction](./operations/0052-tavern-interaction.md)
 - [Scheduled Tasks](./scheduled-tasks/0000.md)
     - [Update Shipyard Experience](./scheduled-tasks/0006-update-shipyard-experience.md)
     - [Celebration](./scheduled-tasks/0007-celebration.md)
@@ -29,6 +30,7 @@
     - [Taxes](./towns/taxes.md)
     - [Tavern](./towns/tavern.md)
         - [Sailors](./towns/tavern/sailors.md)
+    - [Bath House](./towns/bath-house.md)
     - [Sieges](./towns/sieges.md)
         - [Initialization](./towns/sieges/initialization.md)
 - [Merchants](./ch05-00-merchants.md)

src/0010-operations/0000.md src/operations.mdsrc/0010-operations/0000.md renamed to src/operations.md

@@ -87,6 +87,7 @@ The following operations have been identified:
 |0x37|Join Guild|
 |0x39|Bathe|
 |0x41|Form Militia Squad|
+|0x52|Tavern Interaction|
 |0xc2|Autosave|
 |0xc4|Advance Time|
 |0x9f|Start Ship Combat|

src/operations/0052-tavern-interaction.md

@@ -0,0 +1,43 @@
+# Tavern Interaction
+
+The tavern interaction operations are enqueued by the tavern's panel when switching between the tavern's pages.
+The following fields have been identified:
+
+```c
+struct operation_tavern_interaction
+{
+  int field_0_rand;
+  int field_4_merchant_index;
+  int field_8_town_index;
+  tavern_interaction field_C_interaction_type;
+};
+```
+
+Depending on the interaction type, one of the following actions may be done.
+
+## 1
+
+## 3 and 8
+
+## 5
+
+## Weapons Dealer
+If the interaction's merchant index is invalid, the town's weapons dealer is unlocked, and no other action is performed.
+This happens if a merchant navigates from the weapons dealer page to a different page.
+
+Otherwise if the town's weapons dealder is unlocked, it'll be locked to the merchant, and a criminal investigation might be started.
+An investigation is started only if all of the following conditions are met:
+- The merchant is not the alderman
+- The merchant is not the mayor in the particular town
+- The town is not sieged, blocked, boycotted or under pirate attack
+- 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`.
+
+## Burglar
+The burglar is handled like the weapons dealer, except the exceptions for alderman, local mayor and town status don't exist.
+
+## 9
+
+## Leave

src/towns/bath-house.md

@@ -0,0 +1,66 @@
+# Bath House
+
+## Bribes
+Every town with a bathhouse has 4 councillors which can be bribed.
+
+### Attendance
+Between 0 and 4 bribable councillors are present in the bath house.
+The bath house panel has an array of attendance selection timestamps at offset `0xd4`, whose entries denote when the attendance in a given town will be updated.
+These timestamps are updated to `now + 0x100` when
+- the bath house window is closed.
+- fast forward is activated.
+- the options screen is opened.
+- any window is opened after the bath house window has just been closed.
+
+Therefore, continuously opening an individual bath house locks the current attendance.
+
+Attendance is decided as follows:
+```python
+def will_attend(rand: int):
+    return rand % 100 < 7
+```
+so each councillor has a 7% chance to attend.
+
+### Price Formula
+The `town_calculate_expected_bribe` function at `0x00529E20` determines the amount of money the merchant needs to offer for the bribe to be successful.
+
+It defines the following *bribe base factors* for each rank:
+
+|Rank|Bribe Base Factor|
+|-|-|
+|Shopkeeper|0|
+|Trader|1|
+|Merchant|2|
+|Travelling Merchant|3|
+|Councillor|5|
+|Patrician|7|
+|Mayor|10|
+|Alderman|15|
+
+The bribe result is calculated as follows:
+```python
+def calculate_expected_bribe(rank: int, already_bribed: bool):
+    price = 500 * (rand % 11 + 4 * BRIBE_BASE_FACTORS[rank] + 16)
+    if already_bribed:
+        price *= 2
+    return price
+
+def calculate_bribe_result(amount: int, rank: int, already_bribed: bool):
+    price = calculcate_expected_bribe(rank, already_bribed)
+    if amount < price:
+        return BribeResult.OK
+    elif amount >= price * 1.5:
+        return BribeResult.GOOD
+    else:
+        return BribeResult.FAILED
+```
+
+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."|
+
+Both `Ok` and `Good` enqueue a *Bath House Bribe Success* operation, while `Failed` enqueues a *Bath House Bribe Failed* operation.