Change: Use a max_penalty parameter instead, and add a virtual functi…

…on to get the proper value This virtual function can also be used in CheckIfXXXNeedsService.
OpenTTD · Dec 6, 2023 · c46407b · c46407b
1 parent 24f9ea6
commit c46407b
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 56 deletions.
diff --git a/src/aircraft.h b/src/aircraft.h
@@ -110,7 +110,7 @@ struct Aircraft FINAL : public SpecializedVehicle<Aircraft, VEH_AIRCRAFT> {
 	void OnNewDay() override;
 	uint Crash(bool flooded = false) override;
 	TileIndex GetOrderStationLocation(StationID station) override;
-	ClosestDepot FindClosestDepot(bool limited = false) override;
+	ClosestDepot FindClosestDepot(uint32_t max_penalty = 0) override;
 
 	/**
 	 * Check if the aircraft type is a normal flying device; eg

diff --git a/src/aircraft_cmd.cpp b/src/aircraft_cmd.cpp
@@ -390,7 +390,7 @@ CommandCost CmdBuildAircraft(DoCommandFlag flags, TileIndex tile, const Engine *
 }
 
 
-ClosestDepot Aircraft::FindClosestDepot([[maybe_unused]] bool limited)
+ClosestDepot Aircraft::FindClosestDepot([[maybe_unused]] uint32_t max_penalty)
 {
 	const Station *st = GetTargetAirportIfValid(this);
 	/* If the station is not a valid airport or if it has no hangars */

diff --git a/src/order_cmd.cpp b/src/order_cmd.cpp
@@ -1962,7 +1962,7 @@ bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool
 
 			if (v->current_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) {
 				/* We need to search for the nearest depot (hangar). */
-				ClosestDepot closestDepot = v->FindClosestDepot(true);
+				ClosestDepot closestDepot = v->FindClosestDepot(v->GetMaxDepotSearchPenalty());
 
 				if (closestDepot.found) {
 					/* PBS reservations cannot reverse */

diff --git a/src/roadveh.h b/src/roadveh.h
@@ -138,7 +138,8 @@ struct RoadVehicle FINAL : public GroundVehicle<RoadVehicle, VEH_ROAD> {
 	uint Crash(bool flooded = false) override;
 	Trackdir GetVehicleTrackdir() const override;
 	TileIndex GetOrderStationLocation(StationID station) override;
-	ClosestDepot FindClosestDepot(bool limited = false) override;
+	ClosestDepot FindClosestDepot(uint32_t max_penalty = 0) override;
+	uint32_t GetMaxDepotSearchPenalty() const override;
 
 	bool IsBus() const;
 

diff --git a/src/roadveh_cmd.cpp b/src/roadveh_cmd.cpp
@@ -348,16 +348,8 @@ static FindDepotData FindClosestRoadDepot(const RoadVehicle *v, int max_distance
 	}
 }
 
-ClosestDepot RoadVehicle::FindClosestDepot(bool limited)
+ClosestDepot RoadVehicle::FindClosestDepot(uint32_t max_penalty)
 {
-	uint max_penalty = 0;
-	if (limited) {
-		switch (_settings_game.pf.pathfinder_for_roadvehs) {
-			case VPF_NPF:  max_penalty = _settings_game.pf.npf.maximum_go_to_depot_penalty;  break;
-			case VPF_YAPF: max_penalty = _settings_game.pf.yapf.maximum_go_to_depot_penalty; break;
-			default: NOT_REACHED();
-		}
-	}
 	FindDepotData rfdd = FindClosestRoadDepot(this, max_penalty);
 	if (rfdd.best_length == UINT_MAX) return ClosestDepot();
 
@@ -1679,12 +1671,7 @@ static void CheckIfRoadVehNeedsService(RoadVehicle *v)
 		return;
 	}
 
-	uint max_penalty;
-	switch (_settings_game.pf.pathfinder_for_roadvehs) {
-		case VPF_NPF:  max_penalty = _settings_game.pf.npf.maximum_go_to_depot_penalty;  break;
-		case VPF_YAPF: max_penalty = _settings_game.pf.yapf.maximum_go_to_depot_penalty; break;
-		default: NOT_REACHED();
-	}
+	uint max_penalty = v->GetMaxDepotSearchPenalty();
 
 	FindDepotData rfdd = FindClosestRoadDepot(v, max_penalty);
 	/* Only go to the depot if it is not too far out of our way. */
@@ -1773,3 +1760,12 @@ uint16_t RoadVehicle::GetMaxWeight() const
 
 	return weight;
 }
+
+uint32_t RoadVehicle::GetMaxDepotSearchPenalty() const
+{
+	switch (_settings_game.pf.pathfinder_for_roadvehs) {
+		case VPF_NPF: return _settings_game.pf.npf.maximum_go_to_depot_penalty;
+		case VPF_YAPF: return _settings_game.pf.yapf.maximum_go_to_depot_penalty;
+		default: NOT_REACHED();
+	}
+}
diff --git a/src/ship.h b/src/ship.h
@@ -48,7 +48,8 @@ struct Ship FINAL : public SpecializedVehicle<Ship, VEH_SHIP> {
 	void OnNewDay() override;
 	Trackdir GetVehicleTrackdir() const override;
 	TileIndex GetOrderStationLocation(StationID station) override;
-	ClosestDepot FindClosestDepot(bool limited = false) override;
+	ClosestDepot FindClosestDepot(uint32_t max_penalty = 0) override;
+	uint32_t GetMaxDepotSearchPenalty() const override;
 	void UpdateCache();
 	void SetDestTile(TileIndex tile) override;
 };

diff --git a/src/ship_cmd.cpp b/src/ship_cmd.cpp
@@ -175,14 +175,7 @@ static void CheckIfShipNeedsService(Vehicle *v)
 		return;
 	}
 
-	uint max_distance;
-	switch (_settings_game.pf.pathfinder_for_ships) {
-		case VPF_NPF:  max_distance = _settings_game.pf.npf.maximum_go_to_depot_penalty  / NPF_TILE_LENGTH;  break;
-		case VPF_YAPF: max_distance = _settings_game.pf.yapf.maximum_go_to_depot_penalty / YAPF_TILE_LENGTH; break;
-		default: NOT_REACHED();
-	}
-
-	const Depot *depot = FindClosestShipDepot(v, max_distance);
+	const Depot *depot = FindClosestShipDepot(v, v->GetMaxDepotSearchPenalty());
 
 	if (depot == nullptr) {
 		if (v->current_order.IsType(OT_GOTO_DEPOT)) {
@@ -925,18 +918,19 @@ CommandCost CmdBuildShip(DoCommandFlag flags, TileIndex tile, const Engine *e, V
 	return CommandCost();
 }
 
-ClosestDepot Ship::FindClosestDepot(bool limited)
+ClosestDepot Ship::FindClosestDepot(uint32_t max_penalty)
 {
-	uint max_distance = 0;
-	if (limited) {
-		switch (_settings_game.pf.pathfinder_for_ships) {
-			case VPF_NPF:  max_distance = _settings_game.pf.npf.maximum_go_to_depot_penalty / NPF_TILE_LENGTH;  break;
-			case VPF_YAPF: max_distance = _settings_game.pf.yapf.maximum_go_to_depot_penalty / YAPF_TILE_LENGTH; break;
-			default: NOT_REACHED();
-		}
-	}
-	const Depot *depot = FindClosestShipDepot(this, max_distance);
+	const Depot *depot = FindClosestShipDepot(this, max_penalty);
 	if (depot == nullptr) return ClosestDepot();
 
 	return ClosestDepot(depot->xy, depot->index);
 }
+
+uint32_t Ship::GetMaxDepotSearchPenalty() const
+{
+	switch (_settings_game.pf.pathfinder_for_ships) {
+		case VPF_NPF: return _settings_game.pf.npf.maximum_go_to_depot_penalty / NPF_TILE_LENGTH;
+		case VPF_YAPF: return _settings_game.pf.yapf.maximum_go_to_depot_penalty / YAPF_TILE_LENGTH;
+		default: NOT_REACHED();
+	}
+}
diff --git a/src/train.h b/src/train.h
@@ -127,7 +127,8 @@ struct Train FINAL : public GroundVehicle<Train, VEH_TRAIN> {
 	uint Crash(bool flooded = false) override;
 	Trackdir GetVehicleTrackdir() const override;
 	TileIndex GetOrderStationLocation(StationID station) override;
-	ClosestDepot FindClosestDepot(bool limited = false) override;
+	ClosestDepot FindClosestDepot(uint32_t max_penalty = 0) override;
+	uint32_t GetMaxDepotSearchPenalty() const override;
 
 	void ReserveTrackUnderConsist() const;
 

diff --git a/src/train_cmd.cpp b/src/train_cmd.cpp
@@ -2170,16 +2170,8 @@ static FindDepotData FindClosestTrainDepot(Train *v, int max_distance)
 	}
 }
 
-ClosestDepot Train::FindClosestDepot(bool limited)
+ClosestDepot Train::FindClosestDepot(uint32_t max_penalty)
 {
-	uint max_penalty = 0;
-	if (limited) {
-		switch (_settings_game.pf.pathfinder_for_trains) {
-			case VPF_NPF:  max_penalty = _settings_game.pf.npf.maximum_go_to_depot_penalty;  break;
-			case VPF_YAPF: max_penalty = _settings_game.pf.yapf.maximum_go_to_depot_penalty; break;
-			default: NOT_REACHED();
-		}
-	}
 	FindDepotData tfdd = FindClosestTrainDepot(this, max_penalty);
 	if (tfdd.best_length == UINT_MAX) return ClosestDepot();
 
@@ -4137,12 +4129,7 @@ static void CheckIfTrainNeedsService(Train *v)
 		return;
 	}
 
-	uint max_penalty;
-	switch (_settings_game.pf.pathfinder_for_trains) {
-		case VPF_NPF:  max_penalty = _settings_game.pf.npf.maximum_go_to_depot_penalty;  break;
-		case VPF_YAPF: max_penalty = _settings_game.pf.yapf.maximum_go_to_depot_penalty; break;
-		default: NOT_REACHED();
-	}
+	uint max_penalty = v->GetMaxDepotSearchPenalty();
 
 	FindDepotData tfdd = FindClosestTrainDepot(v, max_penalty);
 	/* Only go to the depot if it is not too far out of our way. */
@@ -4243,3 +4230,12 @@ uint16_t Train::GetMaxWeight() const
 
 	return weight;
 }
+
+uint32_t Train::GetMaxDepotSearchPenalty() const
+{
+	switch (_settings_game.pf.pathfinder_for_trains) {
+		case VPF_NPF: return _settings_game.pf.npf.maximum_go_to_depot_penalty;
+		case VPF_YAPF: return _settings_game.pf.yapf.maximum_go_to_depot_penalty;
+		default: NOT_REACHED();
+	}
+}
diff --git a/src/vehicle_base.h b/src/vehicle_base.h
@@ -783,10 +783,12 @@ struct Vehicle : VehiclePool::PoolItem<&_vehicle_pool>, BaseVehicle, BaseConsist
 	/**
 	 * Find the closest depot for this vehicle and tell us the location,
 	 * DestinationID and whether we should reverse.
-	 * @param limited whether to perform a search within a maximum distance.
+	 * @param max_penalty value used to limit the search within a maximum distance (0 for unlimited).
 	 * @return A structure with information about the closest depot, if found.
 	 */
-	virtual ClosestDepot FindClosestDepot([[maybe_unused]] bool limited = false) { return {}; }
+	virtual ClosestDepot FindClosestDepot([[maybe_unused]] uint32_t max_penalty = 0) { return {}; }
+
+	virtual uint32_t GetMaxDepotSearchPenalty() const { return 0; }
 
 	virtual void SetDestTile(TileIndex tile) { this->dest_tile = tile; }