Fix #10511: Limit 'go to nearest depot' orders

Adds a limit to the 'go to nearest depot' orders, applicable to ships, trains and road vehicles. The limit is based on the current pathfinder selected for that vehicle type and it limits the maximum distance/penalty for the pathfinder in order to lower cpu usage if the calling is constant on a large transport network.

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() override;
+	ClosestDepot FindClosestDepot(bool limited = false) override;
 
 	/**
 	 * Check if the aircraft type is a normal flying device; eg

src/aircraft_cmd.cpp

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

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();
+				ClosestDepot closestDepot = v->FindClosestDepot(true);
 
 				if (closestDepot.found) {
 					/* PBS reservations cannot reverse */

src/roadveh.h

@@ -138,7 +138,7 @@ 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() override;
+	ClosestDepot FindClosestDepot(bool limited = false) override;
 
 	bool IsBus() const;
 

src/roadveh_cmd.cpp

@@ -348,9 +348,17 @@ static FindDepotData FindClosestRoadDepot(const RoadVehicle *v, int max_distance
 	}
 }
 
-ClosestDepot RoadVehicle::FindClosestDepot()
+ClosestDepot RoadVehicle::FindClosestDepot(bool limited)
 {
-	FindDepotData rfdd = FindClosestRoadDepot(this, 0);
+	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();
 
 	return ClosestDepot(rfdd.tile, GetDepotIndex(rfdd.tile));

src/ship.h

@@ -48,7 +48,7 @@ struct Ship FINAL : public SpecializedVehicle<Ship, VEH_SHIP> {
 	void OnNewDay() override;
 	Trackdir GetVehicleTrackdir() const override;
 	TileIndex GetOrderStationLocation(StationID station) override;
-	ClosestDepot FindClosestDepot() override;
+	ClosestDepot FindClosestDepot(bool limited = false) override;
 	void UpdateCache();
 	void SetDestTile(TileIndex tile) override;
 };

src/ship_cmd.cpp

@@ -925,9 +925,17 @@ CommandCost CmdBuildShip(DoCommandFlag flags, TileIndex tile, const Engine *e, V
 	return CommandCost();
 }
 
-ClosestDepot Ship::FindClosestDepot()
+ClosestDepot Ship::FindClosestDepot(bool limited)
 {
-	const Depot *depot = FindClosestShipDepot(this, 0);
+	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);
 	if (depot == nullptr) return ClosestDepot();
 
 	return ClosestDepot(depot->xy, depot->index);

src/train.h

@@ -127,7 +127,7 @@ 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() override;
+	ClosestDepot FindClosestDepot(bool limited = false) override;
 
 	void ReserveTrackUnderConsist() const;
 

src/train_cmd.cpp

@@ -2170,9 +2170,17 @@ static FindDepotData FindClosestTrainDepot(Train *v, int max_distance)
 	}
 }
 
-ClosestDepot Train::FindClosestDepot()
+ClosestDepot Train::FindClosestDepot(bool limited)
 {
-	FindDepotData tfdd = FindClosestTrainDepot(this, 0);
+	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();
 
 	return ClosestDepot(tfdd.tile, GetDepotIndex(tfdd.tile), tfdd.reverse);

src/vehicle_base.h

@@ -783,9 +783,10 @@ 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.
 	 * @return A structure with information about the closest depot, if found.
 	 */
-	virtual ClosestDepot FindClosestDepot() { return {}; }
+	virtual ClosestDepot FindClosestDepot([[maybe_unused]] bool limited = false) { return {}; }
 
 	virtual void SetDestTile(TileIndex tile) { this->dest_tile = tile; }