Introduce advanced tax & wage contribution logic

src/building/building.c

@@ -172,6 +172,21 @@ static void remove_adjacent_types(building *b)
     b->next_of_type = 0;
 }
 
+void initialize_sentiment_cooldown(building *b) {
+    if (b->house_adv_sentiment.cooldown_initialized) {
+        return;
+    }
+
+    b->house_adv_sentiment.cooldown_initialized = 1;
+
+    if (b->type <= BUILDING_HOUSE_GRAND_INSULA) {
+        b->house_adv_sentiment.cooldown = ADVANCED_SENTIMENT_COOLDOWN_MAX_TICKS;
+    } else {
+        // Do not apply cooldown to villas
+        b->house_adv_sentiment.cooldown = 0;
+    }
+}
+
 building *building_create(building_type type, int x, int y)
 {
     building *b;
@@ -205,6 +220,7 @@ building *building_create(building_type type, int x, int y)
 
     // subtype
     if (building_is_house(type)) {
+        initialize_sentiment_cooldown(b);
         b->subtype.house_level = type - BUILDING_HOUSE_VACANT_LOT;
     }
 
@@ -268,7 +284,7 @@ static void building_delete(building *b)
 
 void building_clear_related_data(building *b)
 {
-    if (b->storage_id) {
+    if (building_is_storage_kind(b->type) && b->storage_id) {
         building_storage_delete(b->storage_id);
         b->storage_id = 0;
     }
@@ -424,6 +440,11 @@ int building_is_house(building_type type)
     return type >= BUILDING_HOUSE_VACANT_LOT && type <= BUILDING_HOUSE_LUXURY_PALACE;
 }
 
+int building_is_storage_kind(building_type type)
+{
+    return type == BUILDING_WAREHOUSE || type == BUILDING_GRANARY;
+}
+
 // For Venus GT base bonus
 int building_is_statue_garden_temple(building_type type)
 {

src/building/building.h

@@ -7,13 +7,27 @@
 #include "game/resource.h"
 #include "translation/translation.h"
 
+// Ticks of cooldown before new advanced sentiment logic will be applied
+// for the house building. Each tick is equal to 3 months. That value
+// shouldn't ever exceed 7, since it takes 3 bits of data.
+// To extend or reduce the cooldown duration edit the
+// ADVANCED_SENTIMENT_COOLDOWN_TICK_MONTHS preprocessor definition.
+#define ADVANCED_SENTIMENT_COOLDOWN_MAX_TICKS   7
+#define ADVANCED_SENTIMENT_COOLDOWN_TICK_MONTHS 3
+
 typedef enum order_condition_type {
     ORDER_CONDITION_NEVER = 0,
     ORDER_CONDITION_ALWAYS,
     ORDER_CONDITION_SOURCE_HAS_MORE_THAN,
     ORDER_CONDITION_DESTINATION_HAS_LESS_THAN
 } order_condition_type;
 
+typedef struct advanced_sentiment {
+    uint8_t cooldown_initialized: 1;
+    uint8_t cooldown: 3;
+    uint8_t reserved: 4;
+} advanced_sentiment;
+
 typedef struct order {
     resource_type resource_type;
     int src_storage_id;
@@ -180,6 +194,11 @@ typedef struct building {
         signed char house_happiness;
         signed char native_anger;
     } sentiment;
+    // New advanced sentiment contribution logic requires cooldown for newly built houses.
+    // The new happiness gain/drop logic will not be applied until cooldown expires.
+    // Cooldown ticks get decreased every Jan/Apr/Jul/Oct, which gives 18-20 months in total.
+    // That should be enough to build new housing block and evolve it.
+    struct advanced_sentiment house_adv_sentiment;
     unsigned char show_on_problem_overlay;
     unsigned char house_tavern_wine_access;
     unsigned char house_tavern_food_access;
@@ -220,6 +239,8 @@ building *building_main(building *b);
 
 building *building_next(building *b);
 
+void initialize_sentiment_cooldown(building *b);
+
 building *building_create(building_type type, int x, int y);
 
 void building_clear_related_data(building *b);
@@ -232,6 +253,11 @@ void building_update_state(void);
 
 void building_update_desirability(void);
 
+/**
+ * Checks if building can store goods
+ */
+int building_is_storage_kind(building_type type);
+
 int building_is_house(building_type type);
 
 int building_is_ceres_temple(building_type type);

src/building/state.c

@@ -1,5 +1,7 @@
 #include "state.h"
 
+#include <assert.h>
+
 #include "building/industry.h"
 #include "building/monument.h"
 #include "building/roadblock.h"
@@ -164,6 +166,14 @@ void building_state_save_to_buffer(buffer *buf, const building *b)
     buffer_write_u8(buf, b->is_adjacent_to_water);
     buffer_write_u8(buf, b->storage_id);
     buffer_write_i8(buf, b->sentiment.house_happiness); // which union field we use does not matter
+
+    assert (sizeof(b->house_adv_sentiment) == sizeof(uint8_t));
+    if (building_is_house(b->type)) {
+        buffer_write_raw(buf, &b->house_adv_sentiment, sizeof(b->house_adv_sentiment));
+    } else {
+        buffer_skip(buf, sizeof(b->house_adv_sentiment));
+    }
+
     buffer_write_u8(buf, b->show_on_problem_overlay);
 
     // expanded building data
@@ -486,8 +496,20 @@ void building_state_load_from_buffer(buffer *buf, building *b, int building_buf_
     b->desirability = buffer_read_i8(buf);
     b->is_deleted = buffer_read_u8(buf);
     b->is_adjacent_to_water = buffer_read_u8(buf);
-    b->storage_id = buffer_read_u8(buf);
+    if (building_is_storage_kind(b->type)) {
+        b->storage_id = buffer_read_u8(buf);
+    } else {
+        b->storage_id = 0;
+        buffer_skip(buf, 1); // do not load storage_id for non-storage buildings
+    }
     b->sentiment.house_happiness = buffer_read_i8(buf); // which union field we use does not matter
+    if (save_version >= SAVE_GAME_LAST_ADVANCED_SENTIMENT) {
+        if (building_is_house(b->type)) {
+            buffer_read_raw(buf, &b->house_adv_sentiment, sizeof(b->house_adv_sentiment));
+        } else {
+            buffer_skip(buf, sizeof(b->house_adv_sentiment));
+        }
+    }
     b->show_on_problem_overlay = buffer_read_u8(buf);
 
     // Wharves produce fish and don't need any progress
@@ -687,4 +709,8 @@ void building_state_load_from_buffer(buffer *buf, building *b, int building_buf_
     if (building_buf_size > BUILDING_STATE_CURRENT_BUFFER_SIZE) {
         buffer_skip(buf, building_buf_size - BUILDING_STATE_CURRENT_BUFFER_SIZE);
     }
+
+    if (building_is_house(b->type)) {
+        initialize_sentiment_cooldown(b);
+    }
 }

src/building/state.h

@@ -11,8 +11,9 @@
 #define BUILDING_STATE_TOURISM_BUFFER_SIZE (BUILDING_STATE_ORIGINAL_BUFFER_SIZE + 6) // 134
 #define BUILDING_STATE_VARIANTS_AND_UPGRADES (BUILDING_STATE_TOURISM_BUFFER_SIZE + 2) // 136
 #define BUILDING_STATE_STRIKES (BUILDING_STATE_VARIANTS_AND_UPGRADES + 1) // 137
-#define BUILDING_STATE_SICKNESS (BUILDING_STATE_STRIKES + 5) // 142
-#define BUILDING_STATE_WITHOUT_RESOURCES (BUILDING_STATE_SICKNESS - RESOURCE_MAX_LEGACY) // 126 (plus variable resource size)
+#define BUILDING_STATE_ADV_SENTIMENT (BUILDING_STATE_STRIKES + sizeof(advanced_sentiment)) // 138
+#define BUILDING_STATE_SICKNESS (BUILDING_STATE_ADV_SENTIMENT + 5) // 143
+#define BUILDING_STATE_WITHOUT_RESOURCES (BUILDING_STATE_SICKNESS - RESOURCE_MAX_LEGACY) // 127 (plus variable resource size)
 #define BUILDING_STATE_DYNAMIC_RESOURCES (BUILDING_STATE_WITHOUT_RESOURCES + BUILDING_STATE_NONSTATIC_RESOURCE_SIZE)
 #define BUILDING_STATE_CURRENT_BUFFER_SIZE (BUILDING_STATE_DYNAMIC_RESOURCES + 8)
 

src/city/gods.c

@@ -115,7 +115,7 @@ static void perform_small_curse(god_type god)
             city_message_post(1, MESSAGE_VENUS_IS_UPSET, 0, 0);
             city_data.sentiment.blessing_festival_boost -= 15;
             city_health_change(-10);
-            city_sentiment_update();
+            city_sentiment_update(0);
             break;
     }
 }
@@ -162,7 +162,7 @@ static int perform_large_curse(god_type god)
                 city_health_change(-20);
             }
             city_data.religion.venus_curse_active = 1;
-            city_sentiment_update();
+            city_sentiment_update(0);
             break;
     }
     return 1;