Merge pull request #1984 from SneakBug8/feature/unit-upgrades

Regiment & ship construction time application

Author: schombert

docs/features/regiment-recruitment.md

@@ -0,0 +1,20 @@
+# US1. Regiment recruitment
+
+**As a Nation,**
+**I want to recruit a regiment,**
+**So that it appears in my army.**
+
+**Acceptance Criteria:**
+| AC1 | Regiment of a particular type is recruited in a province by a nation |
+| AC2 | Regiment can be recruited only if one of the province pops allow new recruitment |
+| AC3 | Regiment of a type can be recruited only if that type is available to the nation |
+| AC4 | Regiment recruitment finishes when all goods for the recruitment have been purchased and consumed by the construction |
+| AC5 | Regiment recruitment cannot be finished faster than unit construction time |
+| AC7 | When several regiment constructions happen in a province simultaneously, they all progress simultaneously |
+
+**Definition of Done:**
+- [X] All acceptance criteria are met.
+- [X] Code is reviewed and approved.
+- [ ] Necessary tests are written and pass.
+- [X] Documentation is updated, if applicable.
+- [x] Feature is available in release versions of PA.

docs/features/ship-construction.md

@@ -0,0 +1,21 @@
+# US2. Ship construction
+
+**As a Nation,**
+**I want to construct a ship,**
+**So that it appears in my navy.**
+
+**Acceptance Criteria:**
+| AC1 | Ship of a particular type is recruited in a province by a nation |
+| AC2 | Ship can be recruited only in coastal provinces |
+| AC3 | Ship of a type can be recruited only if that type is available to the nation |
+| AC4 | Ship recruitment finishes when all goods for the recruitment have been purchased and consumed by the construction |
+| AC5 | Ship recruitment cannot be finished faster than unit construction time |
+| AC6 | Big ships can be recruited only in provinces with appropriate naval base level |
+| AC7 | When several ship constructions happen in a province simultaneously, they progress one at a time |
+
+**Definition of Done:**
+- [X] All acceptance criteria are met.
+- [X] Code is reviewed and approved.
+- [ ] Necessary tests are written and pass.
+- [X] Documentation is updated, if applicable.
+- [x] Feature is available in release versions of PA.

src/ai/ai.cpp

@@ -537,8 +537,7 @@ void build_ships(sys::state& state) {
 						if((overseas_allowed || !province::is_overseas(state, owned_ports[j]))
 							&& state.world.province_get_building_level(owned_ports[j], uint8_t(economy::province_building_type::naval_base)) >= level_req) {
 							assert(command::can_start_naval_unit_construction(state, n, owned_ports[j], best_transport));
-							auto c = fatten(state.world, state.world.try_create_province_naval_construction(owned_ports[j], n));
-							c.set_type(best_transport);
+							command::execute_start_naval_unit_construction(state, n, owned_ports[j], best_transport);
 							constructing_fleet_cap += supply_pts;
 						}
 					}
@@ -551,8 +550,7 @@ void build_ships(sys::state& state) {
 						if((overseas_allowed || !province::is_overseas(state, owned_ports[j]))
 							&& state.world.province_get_building_level(owned_ports[j], uint8_t(economy::province_building_type::naval_base)) >= level_req) {
 							assert(command::can_start_naval_unit_construction(state, n, owned_ports[j], best_transport));
-							auto c = fatten(state.world, state.world.try_create_province_naval_construction(owned_ports[j], n));
-							c.set_type(best_transport);
+							command::execute_start_naval_unit_construction(state, n, owned_ports[j], best_transport);
 							++num_transports;
 							constructing_fleet_cap += supply_pts;
 						}
@@ -577,8 +575,7 @@ void build_ships(sys::state& state) {
 					if((overseas_allowed || !province::is_overseas(state, owned_ports[j]))
 						&& state.world.province_get_building_level(owned_ports[j], uint8_t(economy::province_building_type::naval_base)) >= level_req) {
 						assert(command::can_start_naval_unit_construction(state, n, owned_ports[j], best_light));
-						auto c = fatten(state.world, state.world.try_create_province_naval_construction(owned_ports[j], n));
-						c.set_type(best_light);
+						command::execute_start_naval_unit_construction(state, n, owned_ports[j], best_light);
 						free_small_points -= supply_pts;
 					}
 				}
@@ -592,8 +589,7 @@ void build_ships(sys::state& state) {
 					if((overseas_allowed || !province::is_overseas(state, owned_ports[j]))
 						&& state.world.province_get_building_level(owned_ports[j], uint8_t(economy::province_building_type::naval_base)) >= level_req) {
 						assert(command::can_start_naval_unit_construction(state, n, owned_ports[j], best_big));
-						auto c = fatten(state.world, state.world.try_create_province_naval_construction(owned_ports[j], n));
-						c.set_type(best_big);
+						command::execute_start_naval_unit_construction(state, n, owned_ports[j], best_big);
 						free_big_points -= supply_pts;
 					}
 				}
@@ -2232,8 +2228,7 @@ void update_land_constructions(sys::state& state) {
 							while(num_to_make_local > 0 && num_to_build_nation > 0) {
 								auto t = decide_type(pop.get_pop().get_is_primary_or_accepted_culture());
 								assert(command::can_start_land_unit_construction(state, n, pop.get_province(), pop.get_pop().get_culture(), t));
-								auto c = fatten(state.world, state.world.try_create_province_land_construction(pop.get_pop().id, n));
-								c.set_type(t);
+								command::execute_start_land_unit_construction(state, n, pop.get_province(), pop.get_pop().get_culture(), t);
 								--num_to_make_local;
 								--num_to_build_nation;
 							}
@@ -2255,8 +2250,7 @@ void update_land_constructions(sys::state& state) {
 							while(num_to_make_local > 0 && num_to_build_nation > 0) {
 								auto t = decide_type(pop.get_pop().get_is_primary_or_accepted_culture());
 								assert(command::can_start_land_unit_construction(state, n, pop.get_province(), pop.get_pop().get_culture(), t));
-								auto c = fatten(state.world, state.world.try_create_province_land_construction(pop.get_pop().id, n));
-								c.set_type(t);
+								command::execute_start_land_unit_construction(state, n, pop.get_province(), pop.get_pop().get_culture(), t);
 								--num_to_make_local;
 								--num_to_build_nation;
 							}
@@ -2278,8 +2272,7 @@ void update_land_constructions(sys::state& state) {
 							while(num_to_make_local > 0 && num_to_build_nation > 0) {
 								auto t = decide_type(pop.get_pop().get_is_primary_or_accepted_culture());
 								assert(command::can_start_land_unit_construction(state, n, pop.get_province(), pop.get_pop().get_culture(), t));
-								auto c = fatten(state.world, state.world.try_create_province_land_construction(pop.get_pop().id, n));
-								c.set_type(t);
+								command::execute_start_land_unit_construction(state, n, pop.get_province(), pop.get_pop().get_culture(), t);
 								--num_to_make_local;
 								--num_to_build_nation;
 							}

src/economy/economy.cpp

@@ -5087,7 +5087,10 @@ float unit_construction_progress(sys::state& state, dcon::province_land_construc
 		purchased += cgoods.commodity_amounts[i];
 	}
 
-	return total > 0.0f ? purchased / total : 0.0f;
+	auto construction_time = state.military_definitions.unit_base_definitions[state.world.province_land_construction_get_type(c)].build_time;
+	auto time_progress = (float) sys::days_difference(state.world.province_land_construction_get_start_date(c).to_ymd(state.start_date), state.current_date.to_ymd(state.start_date)) / (float) construction_time;
+	
+	return std::min(time_progress, purchased / total);
 }
 
 float unit_construction_progress(sys::state& state, dcon::province_naval_construction_id c) {
@@ -5163,30 +5166,39 @@ void change_factory_type_in_province(sys::state& state, dcon::province_id p, dco
 }
 
 void resolve_constructions(sys::state& state) {
-
+	// US1. Regiment construction
+	// US1AC7.
 	for(auto c : state.world.in_province_land_construction) {
 		auto pop = state.world.province_land_construction_get_pop(c);
 		auto province = state.world.pop_get_province_from_pop_location(pop);
 		float cost_factor = economy::build_cost_multiplier(state, province, false);
 
 		auto& base_cost = state.military_definitions.unit_base_definitions[c.get_type()].build_cost;
 		auto& current_purchased = c.get_purchased_goods();
-		float construction_time = float(state.military_definitions.unit_base_definitions[c.get_type()].build_time);
+		auto construction_time = state.military_definitions.unit_base_definitions[c.get_type()].build_time;
 
-		bool all_finished = true;
+		// US1AC4. All goods costs must be built
+		bool ready_for_deployment = true;
 		if(!(c.get_nation().get_is_player_controlled() && state.cheat_data.instant_army)) {
-			for(uint32_t j = 0; j < commodity_set::set_size && all_finished; ++j) {
+			for(uint32_t j = 0; j < commodity_set::set_size && ready_for_deployment; ++j) {
 				if(base_cost.commodity_type[j]) {
 					if(current_purchased.commodity_amounts[j] < base_cost.commodity_amounts[j] * cost_factor) {
-						all_finished = false;
+						ready_for_deployment = false;
 					}
 				} else {
 					break;
 				}
 			}
 		}
 
-		if(all_finished) {
+		// US1AC5. But no faster than construction_time
+		if(!state.cheat_data.instant_army) {
+			if(state.current_date < c.get_start_date() + construction_time) {
+				ready_for_deployment = false;
+			}
+		}
+
+		if(ready_for_deployment) {
 			auto pop_location = c.get_pop().get_province_from_pop_location();
 
 			auto new_reg = military::create_new_regiment(state, c.get_nation(), c.get_type());
@@ -5212,6 +5224,8 @@ void resolve_constructions(sys::state& state) {
 		}
 	}
 
+	// US2 Ships construction
+	// US2AC7
 	province::for_each_land_province(state, [&](dcon::province_id p) {
 		auto rng = state.world.province_get_province_naval_construction(p);
 		if(rng.begin() != rng.end()) {
@@ -5222,22 +5236,30 @@ void resolve_constructions(sys::state& state) {
 
 			auto& base_cost = state.military_definitions.unit_base_definitions[c.get_type()].build_cost;
 			auto& current_purchased = c.get_purchased_goods();
-			float construction_time = float(state.military_definitions.unit_base_definitions[c.get_type()].build_time);
+			auto construction_time = state.military_definitions.unit_base_definitions[c.get_type()].build_time;
 
-			bool all_finished = true;
+			// US2AC4.
+			bool ready_for_deployment = true;
 			if(!(c.get_nation().get_is_player_controlled() && state.cheat_data.instant_navy)) {
-				for(uint32_t i = 0; i < commodity_set::set_size && all_finished; ++i) {
+				for(uint32_t i = 0; i < commodity_set::set_size && ready_for_deployment; ++i) {
 					if(base_cost.commodity_type[i]) {
 						if(current_purchased.commodity_amounts[i] < base_cost.commodity_amounts[i] * cost_factor) {
-							all_finished = false;
+							ready_for_deployment = false;
 						}
 					} else {
 						break;
 					}
 				}
 			}
 
-			if(all_finished) {
+			// US2AC5. But no faster than construction_time
+			if(!state.cheat_data.instant_army) {
+				if(state.current_date < c.get_start_date() + construction_time) {
+					ready_for_deployment = false;
+				}
+			}
+
+			if(ready_for_deployment) {
 				auto new_ship = military::create_new_ship(state, c.get_nation(), c.get_type());
 				auto a = fatten(state.world, state.world.create_navy());
 				a.set_controller_from_navy_control(c.get_nation());
@@ -5260,6 +5282,7 @@ void resolve_constructions(sys::state& state) {
 		}
 	});
 
+	// Construction of province buildings
 	for(auto c : state.world.in_province_building_construction) {
 		auto for_province = c.get_province();
 		float cost_factor = economy::build_cost_multiplier(state, for_province, c.get_is_pop_project());
@@ -5327,6 +5350,7 @@ void resolve_constructions(sys::state& state) {
 		}
 	}
 
+	// Construction of factories
 	for(auto c : state.world.in_factory_construction) {
 		auto n = state.world.factory_construction_get_nation(c);
 		auto type = state.world.factory_construction_get_type(c);

src/gamestate/commands.cpp

@@ -784,6 +784,7 @@ bool can_start_naval_unit_construction(sys::state& state, dcon::nation_id source
 void execute_start_naval_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::unit_type_id type, dcon::province_id template_province) {
 	auto c = fatten(state.world, state.world.try_create_province_naval_construction(location, source));
 	c.set_type(type);
+	c.set_start_date(state.current_date);
 	c.set_template_province(template_province);
 }
 
@@ -833,6 +834,7 @@ void execute_start_land_unit_construction(sys::state& state, dcon::nation_id sou
 	auto soldier = military::find_available_soldier(state, location, soldier_culture);
 
 	auto c = fatten(state.world, state.world.try_create_province_land_construction(soldier, source));
+	c.set_start_date(state.current_date);
 	c.set_type(type);
 	c.set_template_province(template_province);
 }

src/gamestate/commands.hpp

@@ -600,9 +600,11 @@ bool can_cancel_factory_building_construction(sys::state& state, dcon::nation_id
 
 void start_naval_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::unit_type_id type, dcon::province_id template_province = dcon::province_id{});
 bool can_start_naval_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::unit_type_id type, dcon::province_id template_province = dcon::province_id{});
+void execute_start_naval_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::unit_type_id type, dcon::province_id template_province = dcon::province_id{});
 
 void start_land_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::culture_id soldier_culture, dcon::unit_type_id type, dcon::province_id template_province = dcon::province_id{});
 bool can_start_land_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::culture_id soldier_culture, dcon::unit_type_id type, dcon::province_id template_province = dcon::province_id{});
+void execute_start_land_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::culture_id soldier_culture, dcon::unit_type_id type, dcon::province_id template_province = dcon::province_id{});
 
 void cancel_naval_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::unit_type_id type);
 bool can_cancel_naval_unit_construction(sys::state& state, dcon::nation_id source, dcon::province_id location, dcon::unit_type_id type);

src/gamestate/dcon_generated.txt

@@ -4909,6 +4909,11 @@ relationship{
 		type{ province_id }
 		tag{ save }
 	}
+	property{
+		name{ start_date }
+		type{ sys::date }
+		tag{ save }
+	}
 }
 
 relationship{
@@ -4945,6 +4950,11 @@ relationship{
 		type{ province_id }
 		tag{ save }
 	}
+	property{
+		name{ start_date }
+		type{ sys::date }
+		tag{ save }
+	}
 }
 
 relationship{

src/military/military.cpp

@@ -198,7 +198,7 @@ bool will_have_shortages_building_unit(sys::state& state, dcon::nation_id n, dco
 
 	for(uint32_t i = 0; i < economy::commodity_set::set_size; ++i) {
 		if(def.build_cost.commodity_type[i]) {
-			if(m.get_demand_satisfaction(def.build_cost.commodity_type[i]) < 0.1f && m.get_demand(def.build_cost.commodity_type[i]) > 0.1f)
+			if(m.get_demand_satisfaction(def.build_cost.commodity_type[i]) < 0.1f && m.get_demand(def.build_cost.commodity_type[i]) > 0.01f)
 				lacking_input = true;
 		} else {
 			break;