OpenTTD Source  1.11.0-beta2
npf.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../../stdafx.h"
11 #include "../../network/network.h"
12 #include "../../viewport_func.h"
13 #include "../../ship.h"
14 #include "../../roadstop_base.h"
15 #include "../../vehicle_func.h"
16 #include "../pathfinder_func.h"
17 #include "../pathfinder_type.h"
18 #include "../follow_track.hpp"
19 #include "aystar.h"
20 
21 #include "../../safeguards.h"
22 
23 static const uint NPF_HASH_BITS = 12;
24 /* Do no change below values */
25 static const uint NPF_HASH_SIZE = 1 << NPF_HASH_BITS;
26 static const uint NPF_HASH_HALFBITS = NPF_HASH_BITS / 2;
27 static const uint NPF_HASH_HALFMASK = (1 << NPF_HASH_HALFBITS) - 1;
28 
32  StationID station_index;
33  bool reserve_path;
36  const Vehicle *v;
37 };
38 
41  Owner owner;
42  TransportType type;
43  RailTypes railtypes;
44  RoadTypes roadtypes;
45  uint subtype;
46 };
47 
51  NPF_NODE_FLAGS,
52 };
53 
65 };
66 
73  bool res_okay;
74 };
75 
76 static AyStar _npf_aystar;
77 
78 /* The cost of each trackdir. A diagonal piece is the full NPF_TILE_LENGTH,
79  * the shorter piece is sqrt(2)/2*NPF_TILE_LENGTH =~ 0.7071
80  */
81 #define NPF_STRAIGHT_LENGTH (uint)(NPF_TILE_LENGTH * STRAIGHT_TRACK_LENGTH)
82 static const uint _trackdir_length[TRACKDIR_END] = {
83  NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH,
84  0, 0,
85  NPF_TILE_LENGTH, NPF_TILE_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH, NPF_STRAIGHT_LENGTH
86 };
87 
91 static inline bool NPFGetFlag(const AyStarNode *node, NPFNodeFlag flag)
92 {
93  return HasBit(node->user_data[NPF_NODE_FLAGS], flag);
94 }
95 
99 static inline void NPFSetFlag(AyStarNode *node, NPFNodeFlag flag, bool value)
100 {
101  SB(node->user_data[NPF_NODE_FLAGS], flag, 1, value);
102 }
103 
104 bool CheckIgnoreFirstTile(const PathNode *node)
105 {
106  return (node->parent == nullptr && HasBit(node->node.user_data[NPF_NODE_FLAGS], NPF_FLAG_IGNORE_START_TILE));
107 }
108 
116 {
117  const uint dx = Delta(TileX(t0), TileX(t1));
118  const uint dy = Delta(TileY(t0), TileY(t1));
119 
120  const uint straightTracks = 2 * std::min(dx, dy); // The number of straight (not full length) tracks
121  /* OPTIMISATION:
122  * Original: diagTracks = max(dx, dy) - min(dx,dy);
123  * Proof:
124  * (dx+dy) - straightTracks == (min + max) - straightTracks = min + max - 2 * min = max - min */
125  const uint diagTracks = dx + dy - straightTracks; // The number of diagonal (full tile length) tracks.
126 
127  /* Don't factor out NPF_TILE_LENGTH below, this will round values and lose
128  * precision */
129  return diagTracks * NPF_TILE_LENGTH + straightTracks * NPF_TILE_LENGTH * STRAIGHT_TRACK_LENGTH;
130 }
131 
139 static uint NPFHash(uint key1, uint key2)
140 {
141  /* TODO: think of a better hash? */
142  uint part1 = TileX(key1) & NPF_HASH_HALFMASK;
143  uint part2 = TileY(key1) & NPF_HASH_HALFMASK;
144 
145  assert(IsValidTrackdir((Trackdir)key2));
146  assert(IsValidTile(key1));
147  return ((part1 << NPF_HASH_HALFBITS | part2) + (NPF_HASH_SIZE * key2 / TRACKDIR_END)) % NPF_HASH_SIZE;
148 }
149 
150 static int32 NPFCalcZero(AyStar *as, AyStarNode *current, OpenListNode *parent)
151 {
152  return 0;
153 }
154 
155 /* Calculates the heuristic to the target station or tile. For train stations, it
156  * takes into account the direction of approach.
157  */
158 static int32 NPFCalcStationOrTileHeuristic(AyStar *as, AyStarNode *current, OpenListNode *parent)
159 {
160  NPFFindStationOrTileData *fstd = (NPFFindStationOrTileData*)as->user_target;
161  NPFFoundTargetData *ftd = (NPFFoundTargetData*)as->user_path;
162  TileIndex from = current->tile;
163  TileIndex to = fstd->dest_coords;
164  uint dist;
165  AyStarUserData *user = (AyStarUserData *)as->user_data;
166 
167  /* aim for the closest station tile */
168  if (fstd->station_index != INVALID_STATION) {
169  to = CalcClosestStationTile(fstd->station_index, from, fstd->station_type);
170  }
171 
172  if (user->type == TRANSPORT_ROAD) {
173  /* Since roads only have diagonal pieces, we use manhattan distance here */
174  dist = DistanceManhattan(from, to) * NPF_TILE_LENGTH;
175  } else {
176  /* Ships and trains can also go diagonal, so the minimum distance is shorter */
177  dist = NPFDistanceTrack(from, to);
178  }
179 
180  DEBUG(npf, 4, "Calculating H for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), dist);
181 
182  if (dist < ftd->best_bird_dist) {
183  ftd->best_bird_dist = dist;
184  ftd->best_trackdir = (Trackdir)current->user_data[NPF_TRACKDIR_CHOICE];
185  }
186  return dist;
187 }
188 
189 
190 /* Fills AyStarNode.user_data[NPF_TRACKDIRCHOICE] with the chosen direction to
191  * get here, either getting it from the current choice or from the parent's
192  * choice */
193 static void NPFFillTrackdirChoice(AyStarNode *current, OpenListNode *parent)
194 {
195  if (parent->path.parent == nullptr) {
196  Trackdir trackdir = current->direction;
197  /* This is a first order decision, so we'd better save the
198  * direction we chose */
199  current->user_data[NPF_TRACKDIR_CHOICE] = trackdir;
200  DEBUG(npf, 6, "Saving trackdir: 0x%X", trackdir);
201  } else {
202  /* We've already made the decision, so just save our parent's decision */
203  current->user_data[NPF_TRACKDIR_CHOICE] = parent->path.node.user_data[NPF_TRACKDIR_CHOICE];
204  }
205 }
206 
207 /* Will return the cost of the tunnel. If it is an entry, it will return the
208  * cost of that tile. If the tile is an exit, it will return the tunnel length
209  * including the exit tile. Requires that this is a Tunnel tile */
210 static uint NPFTunnelCost(AyStarNode *current)
211 {
212  DiagDirection exitdir = TrackdirToExitdir(current->direction);
213  TileIndex tile = current->tile;
214  if (GetTunnelBridgeDirection(tile) == ReverseDiagDir(exitdir)) {
215  /* We just popped out if this tunnel, since were
216  * facing the tunnel exit */
217  return NPF_TILE_LENGTH * (GetTunnelBridgeLength(current->tile, GetOtherTunnelEnd(current->tile)) + 1);
218  /* @todo: Penalty for tunnels? */
219  } else {
220  /* We are entering the tunnel, the enter tile is just a
221  * straight track */
222  return NPF_TILE_LENGTH;
223  }
224 }
225 
226 static inline uint NPFBridgeCost(AyStarNode *current)
227 {
228  return NPF_TILE_LENGTH * GetTunnelBridgeLength(current->tile, GetOtherBridgeEnd(current->tile));
229 }
230 
231 static uint NPFSlopeCost(AyStarNode *current)
232 {
233  TileIndex next = current->tile + TileOffsByDiagDir(TrackdirToExitdir(current->direction));
234 
235  /* Get center of tiles */
236  int x1 = TileX(current->tile) * TILE_SIZE + TILE_SIZE / 2;
237  int y1 = TileY(current->tile) * TILE_SIZE + TILE_SIZE / 2;
238  int x2 = TileX(next) * TILE_SIZE + TILE_SIZE / 2;
239  int y2 = TileY(next) * TILE_SIZE + TILE_SIZE / 2;
240 
241  int dx4 = (x2 - x1) / 4;
242  int dy4 = (y2 - y1) / 4;
243 
244  /* Get the height on both sides of the tile edge.
245  * Avoid testing the height on the tile-center. This will fail for halftile-foundations.
246  */
247  int z1 = GetSlopePixelZ(x1 + dx4, y1 + dy4);
248  int z2 = GetSlopePixelZ(x2 - dx4, y2 - dy4);
249 
250  if (z2 - z1 > 1) {
251  /* Slope up */
253  }
254  return 0;
255  /* Should we give a bonus for slope down? Probably not, we
256  * could just subtract that bonus from the penalty, because
257  * there is only one level of steepness... */
258 }
259 
260 static uint NPFReservedTrackCost(AyStarNode *current)
261 {
262  TileIndex tile = current->tile;
263  TrackBits track = TrackToTrackBits(TrackdirToTrack(current->direction));
264  TrackBits res = GetReservedTrackbits(tile);
265 
266  if (NPFGetFlag(current, NPF_FLAG_3RD_SIGNAL) || NPFGetFlag(current, NPF_FLAG_LAST_SIGNAL_BLOCK) || ((res & track) == TRACK_BIT_NONE && !TracksOverlap(res | track))) return 0;
267 
268  if (IsTileType(tile, MP_TUNNELBRIDGE)) {
269  DiagDirection exitdir = TrackdirToExitdir(current->direction);
270  if (GetTunnelBridgeDirection(tile) == ReverseDiagDir(exitdir)) {
272  }
273  }
275 }
276 
281 static void NPFMarkTile(TileIndex tile)
282 {
283  if (_debug_npf_level < 1 || _networking) return;
284  switch (GetTileType(tile)) {
285  case MP_RAILWAY:
286  /* DEBUG: mark visited tiles by mowing the grass under them ;-) */
287  if (!IsRailDepot(tile)) {
288  SetRailGroundType(tile, RAIL_GROUND_BARREN);
289  MarkTileDirtyByTile(tile);
290  }
291  break;
292 
293  case MP_ROAD:
294  if (!IsRoadDepot(tile)) {
296  MarkTileDirtyByTile(tile);
297  }
298  break;
299 
300  default:
301  break;
302  }
303 }
304 
305 static Vehicle *CountShipProc(Vehicle *v, void *data)
306 {
307  uint *count = (uint *)data;
308  /* Ignore other vehicles (aircraft) and ships inside depot. */
309  if (v->type == VEH_SHIP && (v->vehstatus & VS_HIDDEN) == 0) (*count)++;
310 
311  return nullptr;
312 }
313 
314 static int32 NPFWaterPathCost(AyStar *as, AyStarNode *current, OpenListNode *parent)
315 {
316  /* TileIndex tile = current->tile; */
317  int32 cost = 0;
318  Trackdir trackdir = current->direction;
319 
320  cost = _trackdir_length[trackdir]; // Should be different for diagonal tracks
321 
322  if (IsBuoyTile(current->tile) && IsDiagonalTrackdir(trackdir)) {
323  cost += _settings_game.pf.npf.npf_buoy_penalty; // A small penalty for going over buoys
324  }
325 
326  if (current->direction != NextTrackdir((Trackdir)parent->path.node.direction)) {
328  }
329 
330  if (IsDockingTile(current->tile)) {
331  /* Check docking tile for occupancy */
332  uint count = 1;
333  HasVehicleOnPos(current->tile, &count, &CountShipProc);
334  cost += count * 3 * _trackdir_length[trackdir];
335  }
336 
337  /* @todo More penalties? */
338 
339  return cost;
340 }
341 
342 /* Determine the cost of this node, for road tracks */
343 static int32 NPFRoadPathCost(AyStar *as, AyStarNode *current, OpenListNode *parent)
344 {
345  TileIndex tile = current->tile;
346  int32 cost = 0;
347 
348  /* Determine base length */
349  switch (GetTileType(tile)) {
350  case MP_TUNNELBRIDGE:
351  cost = IsTunnel(tile) ? NPFTunnelCost(current) : NPFBridgeCost(current);
352  break;
353 
354  case MP_ROAD:
355  cost = NPF_TILE_LENGTH;
356  /* Increase the cost for level crossings */
358  break;
359 
360  case MP_STATION: {
361  cost = NPF_TILE_LENGTH;
362  const RoadStop *rs = RoadStop::GetByTile(tile, GetRoadStopType(tile));
363  if (IsDriveThroughStopTile(tile)) {
364  /* Increase the cost for drive-through road stops */
366  DiagDirection dir = TrackdirToExitdir(current->direction);
368  /* When we're the first road stop in a 'queue' of them we increase
369  * cost based on the fill percentage of the whole queue. */
370  const RoadStop::Entry *entry = rs->GetEntry(dir);
372  }
373  } else {
374  /* Increase cost for filled road stops */
375  cost += _settings_game.pf.npf.npf_road_bay_occupied_penalty * (!rs->IsFreeBay(0) + !rs->IsFreeBay(1)) / 2;
376  }
377  break;
378  }
379 
380  default:
381  break;
382  }
383 
384  /* Determine extra costs */
385 
386  /* Check for slope */
387  cost += NPFSlopeCost(current);
388 
389  /* Check for turns. Road vehicles only really drive diagonal, turns are
390  * represented by non-diagonal tracks */
391  if (!IsDiagonalTrackdir(current->direction)) {
393  }
394 
395  NPFMarkTile(tile);
396  DEBUG(npf, 4, "Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);
397  return cost;
398 }
399 
400 
401 /* Determine the cost of this node, for railway tracks */
402 static int32 NPFRailPathCost(AyStar *as, AyStarNode *current, OpenListNode *parent)
403 {
404  TileIndex tile = current->tile;
405  Trackdir trackdir = current->direction;
406  int32 cost = 0;
407  /* HACK: We create a OpenListNode manually, so we can call EndNodeCheck */
408  OpenListNode new_node;
409 
410  /* Determine base length */
411  switch (GetTileType(tile)) {
412  case MP_TUNNELBRIDGE:
413  cost = IsTunnel(tile) ? NPFTunnelCost(current) : NPFBridgeCost(current);
414  break;
415 
416  case MP_RAILWAY:
417  cost = _trackdir_length[trackdir]; // Should be different for diagonal tracks
418  break;
419 
420  case MP_ROAD: // Railway crossing
421  cost = NPF_TILE_LENGTH;
422  break;
423 
424  case MP_STATION:
425  /* We give a station tile a penalty. Logically we would only want to give
426  * station tiles that are not our destination this penalty. This would
427  * discourage trains to drive through busy stations. But, we can just
428  * give any station tile a penalty, because every possible route will get
429  * this penalty exactly once, on its end tile (if it's a station) and it
430  * will therefore not make a difference. */
432 
433  if (IsRailWaypoint(tile)) {
434  NPFFindStationOrTileData *fstd = (NPFFindStationOrTileData*)as->user_target;
435  if (fstd->v->current_order.IsType(OT_GOTO_WAYPOINT) && GetStationIndex(tile) == fstd->v->current_order.GetDestination()) {
436  /* This waypoint is our destination; maybe this isn't an unreserved
437  * one, so check that and if so see that as the last signal being
438  * red. This way waypoints near stations should work better. */
439  const Train *train = Train::From(fstd->v);
440  CFollowTrackRail ft(train);
441  TileIndex t = tile;
442  Trackdir td = trackdir;
443  while (ft.Follow(t, td)) {
444  assert(t != ft.m_new_tile);
445  t = ft.m_new_tile;
446  if (KillFirstBit(ft.m_new_td_bits) != TRACKDIR_BIT_NONE) {
447  /* We encountered a junction; it's going to be too complex to
448  * handle this perfectly, so just bail out. There is no simple
449  * free path, so try the other possibilities. */
450  td = INVALID_TRACKDIR;
451  break;
452  }
453  td = RemoveFirstTrackdir(&ft.m_new_td_bits);
454  /* If this is a safe waiting position we're done searching for it */
455  if (IsSafeWaitingPosition(train, t, td, true, _settings_game.pf.forbid_90_deg)) break;
456  }
457  if (td == INVALID_TRACKDIR ||
458  !IsSafeWaitingPosition(train, t, td, true, _settings_game.pf.forbid_90_deg) ||
461  }
462  }
463  }
464  break;
465 
466  default:
467  break;
468  }
469 
470  /* Determine extra costs */
471 
472  /* Check for signals */
473  if (IsTileType(tile, MP_RAILWAY)) {
474  if (HasSignalOnTrackdir(tile, trackdir)) {
475  SignalType sigtype = GetSignalType(tile, TrackdirToTrack(trackdir));
476  /* Ordinary track with signals */
477  if (GetSignalStateByTrackdir(tile, trackdir) == SIGNAL_STATE_RED) {
478  /* Signal facing us is red */
479  if (!NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {
480  /* Penalize the first signal we
481  * encounter, if it is red */
482 
483  /* Is this a presignal exit or combo? */
484  if (!IsPbsSignal(sigtype)) {
485  if (sigtype == SIGTYPE_EXIT || sigtype == SIGTYPE_COMBO) {
486  /* Penalise exit and combo signals differently (heavier) */
488  } else {
490  }
491  }
492  }
493  /* Record the state of this signal. Path signals are assumed to
494  * be green as the signal state of them has no meaning for this. */
495  NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, !IsPbsSignal(sigtype));
496  } else {
497  /* Record the state of this signal */
498  NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_RED, false);
499  }
500  if (NPFGetFlag(current, NPF_FLAG_SEEN_SIGNAL)) {
501  if (NPFGetFlag(current, NPF_FLAG_2ND_SIGNAL)) {
502  NPFSetFlag(current, NPF_FLAG_3RD_SIGNAL, true);
503  } else {
504  NPFSetFlag(current, NPF_FLAG_2ND_SIGNAL, true);
505  }
506  } else {
507  NPFSetFlag(current, NPF_FLAG_SEEN_SIGNAL, true);
508  }
509  NPFSetFlag(current, NPF_FLAG_LAST_SIGNAL_BLOCK, !IsPbsSignal(sigtype));
510  }
511 
512  if (HasPbsSignalOnTrackdir(tile, ReverseTrackdir(trackdir)) && !NPFGetFlag(current, NPF_FLAG_3RD_SIGNAL)) {
514  }
515  }
516 
517  /* Penalise the tile if it is a target tile and the last signal was
518  * red */
519  /* HACK: We create a new_node here so we can call EndNodeCheck. Ugly as hell
520  * of course... */
521  new_node.path.node = *current;
522  if (as->EndNodeCheck(as, &new_node) == AYSTAR_FOUND_END_NODE && NPFGetFlag(current, NPF_FLAG_LAST_SIGNAL_RED)) {
524  }
525 
526  /* Check for slope */
527  cost += NPFSlopeCost(current);
528 
529  /* Check for turns */
530  if (current->direction != NextTrackdir((Trackdir)parent->path.node.direction)) {
532  }
533  /* TODO, with realistic acceleration, also the amount of straight track between
534  * curves should be taken into account, as this affects the speed limit. */
535 
536  /* Check for reverse in depot */
537  if (IsRailDepotTile(tile) && as->EndNodeCheck(as, &new_node) != AYSTAR_FOUND_END_NODE) {
538  /* Penalise any depot tile that is not the last tile in the path. This
539  * _should_ penalise every occurrence of reversing in a depot (and only
540  * that) */
542  }
543 
544  /* Check for occupied track */
545  cost += NPFReservedTrackCost(current);
546 
547  NPFMarkTile(tile);
548  DEBUG(npf, 4, "Calculating G for: (%d, %d). Result: %d", TileX(current->tile), TileY(current->tile), cost);
549  return cost;
550 }
551 
552 /* Will find any depot */
553 static int32 NPFFindDepot(const AyStar *as, const OpenListNode *current)
554 {
555  AyStarUserData *user = (AyStarUserData *)as->user_data;
556  /* It's not worth caching the result with NPF_FLAG_IS_TARGET here as below,
557  * since checking the cache not that much faster than the actual check */
558  return IsDepotTypeTile(current->path.node.tile, user->type) ?
560 }
561 
563 static int32 NPFFindSafeTile(const AyStar *as, const OpenListNode *current)
564 {
565  const Train *v = Train::From(((NPFFindStationOrTileData *)as->user_target)->v);
566 
567  return (IsSafeWaitingPosition(v, current->path.node.tile, current->path.node.direction, true, _settings_game.pf.forbid_90_deg) &&
568  IsWaitingPositionFree(v, current->path.node.tile, current->path.node.direction, _settings_game.pf.forbid_90_deg)) ?
570 }
571 
572 /* Will find a station identified using the NPFFindStationOrTileData */
573 static int32 NPFFindStationOrTile(const AyStar *as, const OpenListNode *current)
574 {
575  NPFFindStationOrTileData *fstd = (NPFFindStationOrTileData*)as->user_target;
576  const AyStarNode *node = &current->path.node;
577  TileIndex tile = node->tile;
578 
579  if (fstd->station_index == INVALID_STATION && tile == fstd->dest_coords) return AYSTAR_FOUND_END_NODE;
580 
581  if (fstd->v->type == VEH_SHIP) {
582  /* Ships do not actually reach the destination station, so we check for a docking tile instead. */
584  return AYSTAR_DONE;
585  }
586 
587  if (IsTileType(tile, MP_STATION) && GetStationIndex(tile) == fstd->station_index) {
588  if (fstd->v->type == VEH_TRAIN) return AYSTAR_FOUND_END_NODE;
589 
590  assert(fstd->v->type == VEH_ROAD);
591  /* Only if it is a valid station *and* we can stop there */
592  if (GetStationType(tile) == fstd->station_type && (fstd->not_articulated || IsDriveThroughStopTile(tile))) return AYSTAR_FOUND_END_NODE;
593  }
594  return AYSTAR_DONE;
595 }
596 
604 static const PathNode *FindSafePosition(PathNode *path, const Train *v)
605 {
606  /* If there is no signal, reserve the whole path. */
607  PathNode *sig = path;
608 
609  for (; path->parent != nullptr; path = path->parent) {
610  if (IsSafeWaitingPosition(v, path->node.tile, path->node.direction, true, _settings_game.pf.forbid_90_deg)) {
611  sig = path;
612  }
613  }
614 
615  return sig;
616 }
617 
621 static void ClearPathReservation(const PathNode *start, const PathNode *end)
622 {
623  bool first_run = true;
624  for (; start != end; start = start->parent) {
625  if (IsRailStationTile(start->node.tile) && first_run) {
626  SetRailStationPlatformReservation(start->node.tile, TrackdirToExitdir(start->node.direction), false);
627  } else {
628  UnreserveRailTrack(start->node.tile, TrackdirToTrack(start->node.direction));
629  }
630  first_run = false;
631  }
632 }
633 
640 static void NPFSaveTargetData(AyStar *as, OpenListNode *current)
641 {
642  AyStarUserData *user = (AyStarUserData *)as->user_data;
643  NPFFoundTargetData *ftd = (NPFFoundTargetData*)as->user_path;
644  ftd->best_trackdir = (Trackdir)current->path.node.user_data[NPF_TRACKDIR_CHOICE];
645  ftd->best_path_dist = current->g;
646  ftd->best_bird_dist = 0;
647  ftd->node = current->path.node;
648  ftd->res_okay = false;
649 
650  if (as->user_target != nullptr && ((NPFFindStationOrTileData*)as->user_target)->reserve_path && user->type == TRANSPORT_RAIL) {
651  /* Path reservation is requested. */
652  const Train *v = Train::From(((NPFFindStationOrTileData *)as->user_target)->v);
653 
654  const PathNode *target = FindSafePosition(&current->path, v);
655  ftd->node = target->node;
656 
657  /* If the target is a station skip to platform end. */
658  if (IsRailStationTile(target->node.tile)) {
659  DiagDirection dir = TrackdirToExitdir(target->node.direction);
660  uint len = Station::GetByTile(target->node.tile)->GetPlatformLength(target->node.tile, dir);
661  TileIndex end_tile = TILE_ADD(target->node.tile, (len - 1) * TileOffsByDiagDir(dir));
662 
663  /* Update only end tile, trackdir of a station stays the same. */
664  ftd->node.tile = end_tile;
665  if (!IsWaitingPositionFree(v, end_tile, target->node.direction, _settings_game.pf.forbid_90_deg)) return;
666  SetRailStationPlatformReservation(target->node.tile, dir, true);
667  SetRailStationReservation(target->node.tile, false);
668  } else {
669  if (!IsWaitingPositionFree(v, target->node.tile, target->node.direction, _settings_game.pf.forbid_90_deg)) return;
670  }
671 
672  for (const PathNode *cur = target; cur->parent != nullptr; cur = cur->parent) {
673  if (!TryReserveRailTrack(cur->node.tile, TrackdirToTrack(cur->node.direction))) {
674  /* Reservation failed, undo. */
675  ClearPathReservation(target, cur);
676  return;
677  }
678  }
679 
680  ftd->res_okay = true;
681  }
682 }
683 
693 static bool CanEnterTileOwnerCheck(Owner owner, TileIndex tile, DiagDirection enterdir)
694 {
695  if (IsTileType(tile, MP_RAILWAY) || // Rail tile (also rail depot)
696  HasStationTileRail(tile) || // Rail station tile/waypoint
697  IsRoadDepotTile(tile) || // Road depot tile
698  IsStandardRoadStopTile(tile)) { // Road station tile (but not drive-through stops)
699  return IsTileOwner(tile, owner); // You need to own these tiles entirely to use them
700  }
701 
702  switch (GetTileType(tile)) {
703  case MP_ROAD:
704  /* rail-road crossing : are we looking at the railway part? */
705  if (IsLevelCrossing(tile) &&
706  DiagDirToAxis(enterdir) != GetCrossingRoadAxis(tile)) {
707  return IsTileOwner(tile, owner); // Railway needs owner check, while the street is public
708  }
709  break;
710 
711  case MP_TUNNELBRIDGE:
713  return IsTileOwner(tile, owner);
714  }
715  break;
716 
717  default:
718  break;
719  }
720 
721  return true; // no need to check
722 }
723 
724 
729 {
730  assert(IsDepotTypeTile(tile, type));
731 
732  switch (type) {
733  case TRANSPORT_RAIL: return GetRailDepotDirection(tile);
734  case TRANSPORT_ROAD: return GetRoadDepotDirection(tile);
735  case TRANSPORT_WATER: return GetShipDepotDirection(tile);
736  default: return INVALID_DIAGDIR; // Not reached
737  }
738 }
739 
742 {
743  if (IsNormalRoadTile(tile)) {
744  RoadBits rb = GetRoadBits(tile, RTT_TRAM);
745  switch (rb) {
746  case ROAD_NW: return DIAGDIR_NW;
747  case ROAD_SW: return DIAGDIR_SW;
748  case ROAD_SE: return DIAGDIR_SE;
749  case ROAD_NE: return DIAGDIR_NE;
750  default: break;
751  }
752  }
753  return INVALID_DIAGDIR;
754 }
755 
766 static DiagDirection GetTileSingleEntry(TileIndex tile, TransportType type, uint subtype)
767 {
768  if (type != TRANSPORT_WATER && IsDepotTypeTile(tile, type)) return GetDepotDirection(tile, type);
769 
770  if (type == TRANSPORT_ROAD) {
771  if (IsStandardRoadStopTile(tile)) return GetRoadStopDir(tile);
772  if ((RoadTramType)subtype == RTT_TRAM) return GetSingleTramBit(tile);
773  }
774 
775  return INVALID_DIAGDIR;
776 }
777 
787 static inline bool ForceReverse(TileIndex tile, DiagDirection dir, TransportType type, uint subtype)
788 {
789  DiagDirection single_entry = GetTileSingleEntry(tile, type, subtype);
790  return single_entry != INVALID_DIAGDIR && single_entry != dir;
791 }
792 
801 static bool CanEnterTile(TileIndex tile, DiagDirection dir, AyStarUserData *user)
802 {
803  /* Check tunnel entries and bridge ramps */
804  if (IsTileType(tile, MP_TUNNELBRIDGE) && GetTunnelBridgeDirection(tile) != dir) return false;
805 
806  /* Test ownership */
807  if (!CanEnterTileOwnerCheck(user->owner, tile, dir)) return false;
808 
809  /* check correct rail type (mono, maglev, etc) */
810  switch (user->type) {
811  case TRANSPORT_RAIL: {
812  RailType rail_type = GetTileRailType(tile);
813  if (!HasBit(user->railtypes, rail_type)) return false;
814  break;
815  }
816 
817  case TRANSPORT_ROAD: {
818  RoadType road_type = GetRoadType(tile, (RoadTramType)user->subtype);
819  if (!HasBit(user->roadtypes, road_type)) return false;
820  break;
821  }
822 
823  default: break;
824  }
825 
826  /* Depots, standard roadstops and single tram bits can only be entered from one direction */
827  DiagDirection single_entry = GetTileSingleEntry(tile, user->type, user->subtype);
828  if (single_entry != INVALID_DIAGDIR && single_entry != ReverseDiagDir(dir)) return false;
829 
830  return true;
831 }
832 
845 static TrackdirBits GetDriveableTrackdirBits(TileIndex dst_tile, TileIndex src_tile, Trackdir src_trackdir, TransportType type, uint subtype)
846 {
847  TrackdirBits trackdirbits = TrackStatusToTrackdirBits(GetTileTrackStatus(dst_tile, type, subtype));
848 
849  if (trackdirbits == TRACKDIR_BIT_NONE && type == TRANSPORT_ROAD && (RoadTramType)subtype == RTT_TRAM) {
850  /* GetTileTrackStatus() returns 0 for single tram bits.
851  * As we cannot change it there (easily) without breaking something, change it here */
852  switch (GetSingleTramBit(dst_tile)) {
853  case DIAGDIR_NE:
854  case DIAGDIR_SW:
855  trackdirbits = TRACKDIR_BIT_X_NE | TRACKDIR_BIT_X_SW;
856  break;
857 
858  case DIAGDIR_NW:
859  case DIAGDIR_SE:
860  trackdirbits = TRACKDIR_BIT_Y_NW | TRACKDIR_BIT_Y_SE;
861  break;
862 
863  default: break;
864  }
865  }
866 
867  DEBUG(npf, 4, "Next node: (%d, %d) [%d], possible trackdirs: 0x%X", TileX(dst_tile), TileY(dst_tile), dst_tile, trackdirbits);
868 
869  /* Select only trackdirs we can reach from our current trackdir */
870  trackdirbits &= TrackdirReachesTrackdirs(src_trackdir);
871 
872  /* Filter out trackdirs that would make 90 deg turns for trains */
873  if (type == TRANSPORT_RAIL && Rail90DegTurnDisallowed(GetTileRailType(src_tile), GetTileRailType(dst_tile))) {
874  trackdirbits &= ~TrackdirCrossesTrackdirs(src_trackdir);
875  }
876 
877  DEBUG(npf, 6, "After filtering: (%d, %d), possible trackdirs: 0x%X", TileX(dst_tile), TileY(dst_tile), trackdirbits);
878 
879  return trackdirbits;
880 }
881 
882 
883 /* Will just follow the results of GetTileTrackStatus concerning where we can
884  * go and where not. Uses AyStar.user_data[NPF_TYPE] as the transport type and
885  * an argument to GetTileTrackStatus. Will skip tunnels, meaning that the
886  * entry and exit are neighbours. Will fill
887  * AyStarNode.user_data[NPF_TRACKDIR_CHOICE] with an appropriate value, and
888  * copy AyStarNode.user_data[NPF_NODE_FLAGS] from the parent */
889 static void NPFFollowTrack(AyStar *aystar, OpenListNode *current)
890 {
891  AyStarUserData *user = (AyStarUserData *)aystar->user_data;
892  /* We leave src_tile on track src_trackdir in direction src_exitdir */
893  Trackdir src_trackdir = current->path.node.direction;
894  TileIndex src_tile = current->path.node.tile;
895  DiagDirection src_exitdir = TrackdirToExitdir(src_trackdir);
896 
897  /* Information about the vehicle: TransportType (road/rail/water) and SubType (compatible rail/road types) */
898  TransportType type = user->type;
899  uint subtype = user->subtype;
900 
901  /* Initialize to 0, so we can jump out (return) somewhere an have no neighbours */
902  aystar->num_neighbours = 0;
903  DEBUG(npf, 4, "Expanding: (%d, %d, %d) [%d]", TileX(src_tile), TileY(src_tile), src_trackdir, src_tile);
904 
905  /* We want to determine the tile we arrive, and which choices we have there */
906  TileIndex dst_tile;
907  TrackdirBits trackdirbits;
908 
909  /* Find dest tile */
910  /* Is src_tile valid, and can be used?
911  * When choosing track on a junction src_tile is the tile neighboured to the junction wrt. exitdir.
912  * But we must not check the validity of this move, as src_tile is totally unrelated to the move, if a roadvehicle reversed on a junction. */
913  if (CheckIgnoreFirstTile(&current->path)) {
914  /* Do not perform any checks that involve src_tile */
915  dst_tile = src_tile + TileOffsByDiagDir(src_exitdir);
916  trackdirbits = GetDriveableTrackdirBits(dst_tile, src_tile, src_trackdir, type, subtype);
917  } else if (IsTileType(src_tile, MP_TUNNELBRIDGE) && GetTunnelBridgeDirection(src_tile) == src_exitdir) {
918  /* We drive through the wormhole and arrive on the other side */
919  dst_tile = GetOtherTunnelBridgeEnd(src_tile);
920  trackdirbits = TrackdirToTrackdirBits(src_trackdir);
921  } else if (ForceReverse(src_tile, src_exitdir, type, subtype)) {
922  /* We can only reverse on this tile */
923  dst_tile = src_tile;
924  src_trackdir = ReverseTrackdir(src_trackdir);
925  trackdirbits = TrackdirToTrackdirBits(src_trackdir);
926  } else {
927  /* We leave src_tile in src_exitdir and reach dst_tile */
928  dst_tile = AddTileIndexDiffCWrap(src_tile, TileIndexDiffCByDiagDir(src_exitdir));
929 
930  if (dst_tile != INVALID_TILE && IsNormalRoadTile(dst_tile) && !CanEnterTile(dst_tile, src_exitdir, user)) dst_tile = INVALID_TILE;
931 
932  if (dst_tile == INVALID_TILE) {
933  /* We cannot enter the next tile. Road vehicles can reverse, others reach dead end */
934  if (type != TRANSPORT_ROAD || (RoadTramType)subtype == RTT_TRAM) return;
935 
936  dst_tile = src_tile;
937  src_trackdir = ReverseTrackdir(src_trackdir);
938  }
939 
940  trackdirbits = GetDriveableTrackdirBits(dst_tile, src_tile, src_trackdir, type, subtype);
941 
942  if (trackdirbits == TRACKDIR_BIT_NONE) {
943  /* We cannot enter the next tile. Road vehicles can reverse, others reach dead end */
944  if (type != TRANSPORT_ROAD || (RoadTramType)subtype == RTT_TRAM) return;
945 
946  dst_tile = src_tile;
947  src_trackdir = ReverseTrackdir(src_trackdir);
948 
949  trackdirbits = GetDriveableTrackdirBits(dst_tile, src_tile, src_trackdir, type, subtype);
950  }
951  }
952 
953  if (NPFGetFlag(&current->path.node, NPF_FLAG_IGNORE_RESERVED)) {
954  /* Mask out any reserved tracks. */
955  TrackBits reserved = GetReservedTrackbits(dst_tile);
956  trackdirbits &= ~TrackBitsToTrackdirBits(reserved);
957 
958  Track t;
959  FOR_EACH_SET_TRACK(t, TrackdirBitsToTrackBits(trackdirbits)) {
960  if (TracksOverlap(reserved | TrackToTrackBits(t))) trackdirbits &= ~TrackToTrackdirBits(t);
961  }
962  }
963 
964  /* Enumerate possible track */
965  uint i = 0;
966  while (trackdirbits != TRACKDIR_BIT_NONE) {
967  Trackdir dst_trackdir = RemoveFirstTrackdir(&trackdirbits);
968  DEBUG(npf, 5, "Expanded into trackdir: %d, remaining trackdirs: 0x%X", dst_trackdir, trackdirbits);
969 
970  /* Tile with signals? */
971  if (IsTileType(dst_tile, MP_RAILWAY) && GetRailTileType(dst_tile) == RAIL_TILE_SIGNALS) {
972  if (HasSignalOnTrackdir(dst_tile, ReverseTrackdir(dst_trackdir)) && !HasSignalOnTrackdir(dst_tile, dst_trackdir) && IsOnewaySignal(dst_tile, TrackdirToTrack(dst_trackdir))) {
973  /* If there's a one-way signal not pointing towards us, stop going in this direction. */
974  break;
975  }
976  }
977  {
978  /* We've found ourselves a neighbour :-) */
979  AyStarNode *neighbour = &aystar->neighbours[i];
980  neighbour->tile = dst_tile;
981  neighbour->direction = dst_trackdir;
982  /* Save user data */
983  neighbour->user_data[NPF_NODE_FLAGS] = current->path.node.user_data[NPF_NODE_FLAGS];
984  NPFFillTrackdirChoice(neighbour, current);
985  }
986  i++;
987  }
988  aystar->num_neighbours = i;
989 }
990 
991 /*
992  * Plan a route to the specified target (which is checked by target_proc),
993  * from start1 and if not nullptr, from start2 as well. The type of transport we
994  * are checking is in type. reverse_penalty is applied to all routes that
995  * originate from the second start node.
996  * When we are looking for one specific target (optionally multiple tiles), we
997  * should use a good heuristic to perform aystar search. When we search for
998  * multiple targets that are spread around, we should perform a breadth first
999  * search by specifying CalcZero as our heuristic.
1000  */
1001 static NPFFoundTargetData NPFRouteInternal(AyStarNode *start1, bool ignore_start_tile1, AyStarNode *start2, bool ignore_start_tile2, NPFFindStationOrTileData *target, AyStar_EndNodeCheck target_proc, AyStar_CalculateH heuristic_proc, AyStarUserData *user, uint reverse_penalty, bool ignore_reserved = false, int max_penalty = 0)
1002 {
1003  int r;
1004  NPFFoundTargetData result;
1005 
1006  /* Initialize procs */
1007  _npf_aystar.max_path_cost = max_penalty;
1008  _npf_aystar.CalculateH = heuristic_proc;
1009  _npf_aystar.EndNodeCheck = target_proc;
1010  _npf_aystar.FoundEndNode = NPFSaveTargetData;
1011  _npf_aystar.GetNeighbours = NPFFollowTrack;
1012  switch (user->type) {
1013  default: NOT_REACHED();
1014  case TRANSPORT_RAIL: _npf_aystar.CalculateG = NPFRailPathCost; break;
1015  case TRANSPORT_ROAD: _npf_aystar.CalculateG = NPFRoadPathCost; break;
1016  case TRANSPORT_WATER: _npf_aystar.CalculateG = NPFWaterPathCost; break;
1017  }
1018 
1019  /* Initialize Start Node(s) */
1020  start1->user_data[NPF_TRACKDIR_CHOICE] = INVALID_TRACKDIR;
1021  start1->user_data[NPF_NODE_FLAGS] = 0;
1022  NPFSetFlag(start1, NPF_FLAG_IGNORE_START_TILE, ignore_start_tile1);
1023  NPFSetFlag(start1, NPF_FLAG_IGNORE_RESERVED, ignore_reserved);
1024  _npf_aystar.AddStartNode(start1, 0);
1025  if (start2 != nullptr) {
1026  start2->user_data[NPF_TRACKDIR_CHOICE] = INVALID_TRACKDIR;
1027  start2->user_data[NPF_NODE_FLAGS] = 0;
1028  NPFSetFlag(start2, NPF_FLAG_IGNORE_START_TILE, ignore_start_tile2);
1029  NPFSetFlag(start2, NPF_FLAG_REVERSE, true);
1030  NPFSetFlag(start2, NPF_FLAG_IGNORE_RESERVED, ignore_reserved);
1031  _npf_aystar.AddStartNode(start2, reverse_penalty);
1032  }
1033 
1034  /* Initialize result */
1035  result.best_bird_dist = UINT_MAX;
1036  result.best_path_dist = UINT_MAX;
1038  result.node.tile = INVALID_TILE;
1039  result.res_okay = false;
1040  _npf_aystar.user_path = &result;
1041 
1042  /* Initialize target */
1043  _npf_aystar.user_target = target;
1044 
1045  /* Initialize user_data */
1046  _npf_aystar.user_data = user;
1047 
1048  /* GO! */
1049  r = _npf_aystar.Main();
1050  assert(r != AYSTAR_STILL_BUSY);
1051 
1052  if (result.best_bird_dist != 0) {
1053  if (target != nullptr) {
1054  DEBUG(npf, 1, "Could not find route to tile 0x%X from 0x%X.", target->dest_coords, start1->tile);
1055  } else {
1056  /* Assumption: target == nullptr, so we are looking for a depot */
1057  DEBUG(npf, 1, "Could not find route to a depot from tile 0x%X.", start1->tile);
1058  }
1059 
1060  }
1061  return result;
1062 }
1063 
1064 /* Will search as below, but with two start nodes, the second being the
1065  * reverse. Look at the NPF_FLAG_REVERSE flag in the result node to see which
1066  * direction was taken (NPFGetFlag(result.node, NPF_FLAG_REVERSE)) */
1067 static NPFFoundTargetData NPFRouteToStationOrTileTwoWay(TileIndex tile1, Trackdir trackdir1, bool ignore_start_tile1, TileIndex tile2, Trackdir trackdir2, bool ignore_start_tile2, NPFFindStationOrTileData *target, AyStarUserData *user)
1068 {
1069  AyStarNode start1;
1070  AyStarNode start2;
1071 
1072  start1.tile = tile1;
1073  start2.tile = tile2;
1074  start1.direction = trackdir1;
1075  start2.direction = trackdir2;
1076 
1077  return NPFRouteInternal(&start1, ignore_start_tile1, (IsValidTile(tile2) ? &start2 : nullptr), ignore_start_tile2, target, NPFFindStationOrTile, NPFCalcStationOrTileHeuristic, user, 0);
1078 }
1079 
1080 /* Will search from the given tile and direction, for a route to the given
1081  * station for the given transport type. See the declaration of
1082  * NPFFoundTargetData above for the meaning of the result. */
1083 static NPFFoundTargetData NPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, bool ignore_start_tile, NPFFindStationOrTileData *target, AyStarUserData *user)
1084 {
1085  return NPFRouteToStationOrTileTwoWay(tile, trackdir, ignore_start_tile, INVALID_TILE, INVALID_TRACKDIR, false, target, user);
1086 }
1087 
1088 /* Search using breadth first. Good for little track choice and inaccurate
1089  * heuristic, such as railway/road with two start nodes, the second being the reverse. Call
1090  * NPFGetFlag(result.node, NPF_FLAG_REVERSE) to see from which node the path
1091  * originated. All paths from the second node will have the given
1092  * reverse_penalty applied (NPF_TILE_LENGTH is the equivalent of one full
1093  * tile).
1094  */
1095 static NPFFoundTargetData NPFRouteToDepotBreadthFirstTwoWay(TileIndex tile1, Trackdir trackdir1, bool ignore_start_tile1, TileIndex tile2, Trackdir trackdir2, bool ignore_start_tile2, NPFFindStationOrTileData *target, AyStarUserData *user, uint reverse_penalty, int max_penalty)
1096 {
1097  AyStarNode start1;
1098  AyStarNode start2;
1099 
1100  start1.tile = tile1;
1101  start2.tile = tile2;
1102  start1.direction = trackdir1;
1103  start2.direction = trackdir2;
1104 
1105  /* perform a breadth first search. Target is nullptr,
1106  * since we are just looking for any depot...*/
1107  return NPFRouteInternal(&start1, ignore_start_tile1, (IsValidTile(tile2) ? &start2 : nullptr), ignore_start_tile2, target, NPFFindDepot, NPFCalcZero, user, reverse_penalty, false, max_penalty);
1108 }
1109 
1110 void InitializeNPF()
1111 {
1112  static bool first_init = true;
1113  if (first_init) {
1114  first_init = false;
1115  _npf_aystar.Init(NPFHash, NPF_HASH_SIZE);
1116  } else {
1117  _npf_aystar.Clear();
1118  }
1119  _npf_aystar.loops_per_tick = 0;
1120  _npf_aystar.max_path_cost = 0;
1121  //_npf_aystar.max_search_nodes = 0;
1122  /* We will limit the number of nodes for now, until we have a better
1123  * solution to really fix performance */
1125 }
1126 
1127 static void NPFFillWithOrderData(NPFFindStationOrTileData *fstd, const Vehicle *v, bool reserve_path = false)
1128 {
1129  /* Ships don't really reach their stations, but the tile in front. So don't
1130  * save the station id for ships. For roadvehs we don't store it either,
1131  * because multistop depends on vehicles actually reaching the exact
1132  * dest_tile, not just any stop of that station.
1133  * So only for train orders to stations we fill fstd->station_index, for all
1134  * others only dest_coords */
1135  if (v->current_order.IsType(OT_GOTO_STATION) || v->current_order.IsType(OT_GOTO_WAYPOINT)) {
1137  if (v->type == VEH_TRAIN) {
1138  fstd->station_type = v->current_order.IsType(OT_GOTO_STATION) ? STATION_RAIL : STATION_WAYPOINT;
1139  } else if (v->type == VEH_ROAD) {
1140  fstd->station_type = RoadVehicle::From(v)->IsBus() ? STATION_BUS : STATION_TRUCK;
1141  } else if (v->type == VEH_SHIP) {
1142  fstd->station_type = v->current_order.IsType(OT_GOTO_STATION) ? STATION_DOCK : STATION_BUOY;
1143  }
1144 
1146  /* Let's take the closest tile of the station as our target for vehicles */
1148  } else {
1149  fstd->dest_coords = v->dest_tile;
1150  fstd->station_index = INVALID_STATION;
1151  }
1152  fstd->reserve_path = reserve_path;
1153  fstd->v = v;
1154 }
1155 
1156 /*** Road vehicles ***/
1157 
1159 {
1160  Trackdir trackdir = v->GetVehicleTrackdir();
1161 
1162  AyStarUserData user = { v->owner, TRANSPORT_ROAD, RAILTYPES_NONE, v->compatible_roadtypes, GetRoadTramType(v->roadtype) };
1163  NPFFoundTargetData ftd = NPFRouteToDepotBreadthFirstTwoWay(v->tile, trackdir, false, INVALID_TILE, INVALID_TRACKDIR, false, nullptr, &user, 0, max_penalty);
1164 
1165  if (ftd.best_bird_dist != 0) return FindDepotData();
1166 
1167  /* Found target */
1168  /* Our caller expects a number of tiles, so we just approximate that
1169  * number by this. It might not be completely what we want, but it will
1170  * work for now :-) We can possibly change this when the old pathfinder
1171  * is removed. */
1172  return FindDepotData(ftd.node.tile, ftd.best_path_dist);
1173 }
1174 
1175 Trackdir NPFRoadVehicleChooseTrack(const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, bool &path_found)
1176 {
1178 
1179  NPFFillWithOrderData(&fstd, v);
1180  Trackdir trackdir = DiagDirToDiagTrackdir(enterdir);
1181 
1182  AyStarUserData user = { v->owner, TRANSPORT_ROAD, RAILTYPES_NONE, v->compatible_roadtypes, GetRoadTramType(v->roadtype) };
1183  NPFFoundTargetData ftd = NPFRouteToStationOrTile(tile - TileOffsByDiagDir(enterdir), trackdir, true, &fstd, &user);
1184 
1185  assert(ftd.best_trackdir != INVALID_TRACKDIR);
1186 
1187  /* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
1188  * the direction we need to take to get there, if ftd.best_bird_dist is not 0,
1189  * we did not find our target, but ftd.best_trackdir contains the direction leading
1190  * to the tile closest to our target. */
1191  path_found = (ftd.best_bird_dist == 0);
1192  return ftd.best_trackdir;
1193 }
1194 
1195 /*** Ships ***/
1196 
1197 Track NPFShipChooseTrack(const Ship *v, bool &path_found)
1198 {
1200  Trackdir trackdir = v->GetVehicleTrackdir();
1201  assert(trackdir != INVALID_TRACKDIR); // Check that we are not in a depot
1202 
1203  NPFFillWithOrderData(&fstd, v);
1204 
1206  NPFFoundTargetData ftd = NPFRouteToStationOrTile(v->tile, trackdir, true, &fstd, &user);
1207 
1208  assert(ftd.best_trackdir != INVALID_TRACKDIR);
1209 
1210  /* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
1211  * the direction we need to take to get there, if ftd.best_bird_dist is not 0,
1212  * we did not find our target, but ftd.best_trackdir contains the direction leading
1213  * to the tile closest to our target. */
1214  path_found = (ftd.best_bird_dist == 0);
1215  return TrackdirToTrack(ftd.best_trackdir);
1216 }
1217 
1219 {
1221  NPFFoundTargetData ftd;
1222 
1223  NPFFillWithOrderData(&fstd, v);
1224 
1225  Trackdir trackdir = v->GetVehicleTrackdir();
1226  Trackdir trackdir_rev = ReverseTrackdir(trackdir);
1227  assert(trackdir != INVALID_TRACKDIR);
1228  assert(trackdir_rev != INVALID_TRACKDIR);
1229 
1231  ftd = NPFRouteToStationOrTileTwoWay(v->tile, trackdir, false, v->tile, trackdir_rev, false, &fstd, &user);
1232  /* If we didn't find anything, just keep on going straight ahead, otherwise take the reverse flag */
1233  return ftd.best_bird_dist == 0 && NPFGetFlag(&ftd.node, NPF_FLAG_REVERSE);
1234 }
1235 
1236 /*** Trains ***/
1237 
1239 {
1240  const Train *last = v->Last();
1241  Trackdir trackdir = v->GetVehicleTrackdir();
1242  Trackdir trackdir_rev = ReverseTrackdir(last->GetVehicleTrackdir());
1244  fstd.v = v;
1245  fstd.reserve_path = false;
1246 
1247  assert(trackdir != INVALID_TRACKDIR);
1248  AyStarUserData user = { v->owner, TRANSPORT_RAIL, v->compatible_railtypes, ROADTYPES_NONE, 0 };
1249  NPFFoundTargetData ftd = NPFRouteToDepotBreadthFirstTwoWay(v->tile, trackdir, false, last->tile, trackdir_rev, false, &fstd, &user, NPF_INFINITE_PENALTY, max_penalty);
1250  if (ftd.best_bird_dist != 0) return FindDepotData();
1251 
1252  /* Found target */
1253  /* Our caller expects a number of tiles, so we just approximate that
1254  * number by this. It might not be completely what we want, but it will
1255  * work for now :-) We can possibly change this when the old pathfinder
1256  * is removed. */
1257  return FindDepotData(ftd.node.tile, ftd.best_path_dist, NPFGetFlag(&ftd.node, NPF_FLAG_REVERSE));
1258 }
1259 
1260 bool NPFTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir trackdir, bool override_railtype)
1261 {
1262  assert(v->type == VEH_TRAIN);
1263 
1265  fstd.v = v;
1266  fstd.reserve_path = true;
1267 
1268  AyStarNode start1;
1269  start1.tile = tile;
1270  start1.direction = trackdir;
1271 
1272  RailTypes railtypes = v->compatible_railtypes;
1273  if (override_railtype) railtypes |= GetRailTypeInfo(v->railtype)->compatible_railtypes;
1274 
1275  /* perform a breadth first search. Target is nullptr,
1276  * since we are just looking for any safe tile...*/
1277  AyStarUserData user = { v->owner, TRANSPORT_RAIL, railtypes, ROADTYPES_NONE, 0 };
1278  return NPFRouteInternal(&start1, true, nullptr, false, &fstd, NPFFindSafeTile, NPFCalcZero, &user, 0, true).res_okay;
1279 }
1280 
1282 {
1284  NPFFoundTargetData ftd;
1285  const Train *last = v->Last();
1286 
1287  NPFFillWithOrderData(&fstd, v);
1288 
1289  Trackdir trackdir = v->GetVehicleTrackdir();
1290  Trackdir trackdir_rev = ReverseTrackdir(last->GetVehicleTrackdir());
1291  assert(trackdir != INVALID_TRACKDIR);
1292  assert(trackdir_rev != INVALID_TRACKDIR);
1293 
1294  AyStarUserData user = { v->owner, TRANSPORT_RAIL, v->compatible_railtypes, ROADTYPES_NONE, 0 };
1295  ftd = NPFRouteToStationOrTileTwoWay(v->tile, trackdir, false, last->tile, trackdir_rev, false, &fstd, &user);
1296  /* If we didn't find anything, just keep on going straight ahead, otherwise take the reverse flag */
1297  return ftd.best_bird_dist == 0 && NPFGetFlag(&ftd.node, NPF_FLAG_REVERSE);
1298 }
1299 
1300 Track NPFTrainChooseTrack(const Train *v, bool &path_found, bool reserve_track, struct PBSTileInfo *target)
1301 {
1303  NPFFillWithOrderData(&fstd, v, reserve_track);
1304 
1305  PBSTileInfo origin = FollowTrainReservation(v);
1306  assert(IsValidTrackdir(origin.trackdir));
1307 
1308  AyStarUserData user = { v->owner, TRANSPORT_RAIL, v->compatible_railtypes, ROADTYPES_NONE, 0 };
1309  NPFFoundTargetData ftd = NPFRouteToStationOrTile(origin.tile, origin.trackdir, true, &fstd, &user);
1310 
1311  if (target != nullptr) {
1312  target->tile = ftd.node.tile;
1313  target->trackdir = (Trackdir)ftd.node.direction;
1314  target->okay = ftd.res_okay;
1315  }
1316 
1317  assert(ftd.best_trackdir != INVALID_TRACKDIR);
1318 
1319  /* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
1320  * the direction we need to take to get there, if ftd.best_bird_dist is not 0,
1321  * we did not find our target, but ftd.best_trackdir contains the direction leading
1322  * to the tile closest to our target. */
1323  path_found = (ftd.best_bird_dist == 0);
1324  /* Discard enterdir information, making it a normal track */
1325  return TrackdirToTrack(ftd.best_trackdir);
1326 }
RoadVehicle
Buses, trucks and trams belong to this class.
Definition: roadveh.h:107
PBSTileInfo::okay
bool okay
True if tile is a safe waiting position, false otherwise.
Definition: pbs.h:29
NPFSettings::npf_road_curve_penalty
uint32 npf_road_curve_penalty
the penalty for curves
Definition: settings_type.h:368
CanEnterTile
static bool CanEnterTile(TileIndex tile, DiagDirection dir, AyStarUserData *user)
Tests if a vehicle can enter a tile.
Definition: npf.cpp:801
DIAGDIR_SE
@ DIAGDIR_SE
Southeast.
Definition: direction_type.h:80
NPFTrainFindNearestDepot
FindDepotData NPFTrainFindNearestDepot(const Train *v, int max_penalty)
Used when user sends train to the nearest depot or if train needs servicing using NPF.
Definition: npf.cpp:1238
GetRoadDepotDirection
static DiagDirection GetRoadDepotDirection(TileIndex t)
Get the direction of the exit of a road depot.
Definition: road_map.h:565
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
AddTileIndexDiffCWrap
static TileIndex AddTileIndexDiffCWrap(TileIndex tile, TileIndexDiffC diff)
Add a TileIndexDiffC to a TileIndex and returns the new one.
Definition: map_func.h:300
PathfinderSettings::npf
NPFSettings npf
pathfinder settings for the new pathfinder
Definition: settings_type.h:435
TILE_ADD
#define TILE_ADD(x, y)
Adds to tiles together.
Definition: map_func.h:244
NPFFindStationOrTileData::reserve_path
bool reserve_path
Indicates whether the found path should be reserved.
Definition: npf.cpp:33
TRACK_BIT_NONE
@ TRACK_BIT_NONE
No track.
Definition: track_type.h:39
AYSTAR_DONE
@ AYSTAR_DONE
Not an end-tile, or wrong direction.
Definition: aystar.h:32
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:61
NPFFindStationOrTileData::v
const Vehicle * v
The vehicle we are pathfinding for.
Definition: npf.cpp:36
GetOtherBridgeEnd
TileIndex GetOtherBridgeEnd(TileIndex tile)
Starting at one bridge end finds the other bridge end.
Definition: bridge_map.cpp:59
NPFFoundTargetData
Meant to be stored in AyStar.userpath.
Definition: npf.cpp:68
NPFSettings::npf_road_drive_through_penalty
uint32 npf_road_drive_through_penalty
the penalty for going through a drive-through road stop
Definition: settings_type.h:370
TileOffsByDiagDir
static TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition: map_func.h:341
NPFSettings::npf_rail_slope_penalty
uint32 npf_rail_slope_penalty
the penalty for sloping upwards
Definition: settings_type.h:361
Station::GetPlatformLength
uint GetPlatformLength(TileIndex tile, DiagDirection dir) const override
Determines the REMAINING length of a platform, starting at (and including) the given tile.
Definition: station.cpp:266
NPF_FLAG_SEEN_SIGNAL
@ NPF_FLAG_SEEN_SIGNAL
Used to mark that a signal was seen on the way, for rail only.
Definition: npf.cpp:56
NPFFindStationOrTileData::station_index
StationID station_index
station index we're heading for, or INVALID_STATION when we're heading for a tile
Definition: npf.cpp:32
FindDepotData
Helper container to find a depot.
Definition: pathfinder_type.h:53
RemoveFirstTrackdir
static Trackdir RemoveFirstTrackdir(TrackdirBits *trackdirs)
Removes first Trackdir from TrackdirBits and returns it.
Definition: track_func.h:164
TrackdirBits
TrackdirBits
Enumeration of bitmasks for the TrackDirs.
Definition: track_type.h:101
PathfinderSettings::forbid_90_deg
bool forbid_90_deg
forbid trains to make 90 deg turns
Definition: settings_type.h:425
NPF_FLAG_IGNORE_RESERVED
@ NPF_FLAG_IGNORE_RESERVED
Used to mark that reserved tiles should be considered impassable.
Definition: npf.cpp:64
NPF_INFINITE_PENALTY
static const int NPF_INFINITE_PENALTY
This penalty is the equivalent of "infinite", which means that paths that get this penalty will be ch...
Definition: pathfinder_type.h:24
HasVehicleOnPos
bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Checks whether a vehicle is on a specific location.
Definition: vehicle.cpp:513
GetSingleTramBit
static DiagDirection GetSingleTramBit(TileIndex tile)
Tests if a tile is a road tile with a single tramtrack (tram can reverse)
Definition: npf.cpp:741
RoadStop::Entry::GetOccupied
int GetOccupied() const
Get the amount of occupied space in this drive through stop.
Definition: roadstop_base.h:56
TRANSPORT_RAIL
@ TRANSPORT_RAIL
Transport by train.
Definition: transport_type.h:27
SetRailStationPlatformReservation
void SetRailStationPlatformReservation(TileIndex start, DiagDirection dir, bool b)
Set the reservation for a complete station platform.
Definition: pbs.cpp:57
GetReservedTrackbits
TrackBits GetReservedTrackbits(TileIndex t)
Get the reserved trackbits for any tile, regardless of type.
Definition: pbs.cpp:24
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:94
NPFFoundTargetData::best_trackdir
Trackdir best_trackdir
The trackdir that leads to the shortest path/closest birds dist.
Definition: npf.cpp:71
NPF_FLAG_IGNORE_START_TILE
@ NPF_FLAG_IGNORE_START_TILE
Used to mark that the start tile is invalid, and searching should start from the second tile on.
Definition: npf.cpp:62
DiagDirToAxis
static Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Definition: direction_func.h:214
ROAD_SW
@ ROAD_SW
South-west part.
Definition: road_type.h:53
RAIL_TILE_SIGNALS
@ RAIL_TILE_SIGNALS
Normal rail tile with signals.
Definition: rail_map.h:25
IsRoadDepotTile
static bool IsRoadDepotTile(TileIndex t)
Return whether a tile is a road depot tile.
Definition: road_map.h:115
SetRailStationReservation
static void SetRailStationReservation(TileIndex t, bool b)
Set the reservation state of the rail station.
Definition: station_map.h:405
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:326
FollowTrainReservation
PBSTileInfo FollowTrainReservation(const Train *v, Vehicle **train_on_res)
Follow a train reservation to the last tile.
Definition: pbs.cpp:289
KillFirstBit
static T KillFirstBit(T value)
Clear the first bit in an integer.
Definition: bitmath_func.hpp:239
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
IsDepotTypeTile
static bool IsDepotTypeTile(TileIndex tile, TransportType type)
Check if a tile is a depot and it is a depot of the given type.
Definition: depot_map.h:18
DiagDirToDiagTrackdir
static Trackdir DiagDirToDiagTrackdir(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal trackdir that runs in that direction.
Definition: track_func.h:545
GetDriveableTrackdirBits
static TrackdirBits GetDriveableTrackdirBits(TileIndex dst_tile, TileIndex src_tile, Trackdir src_trackdir, TransportType type, uint subtype)
Returns the driveable Trackdirs on a tile.
Definition: npf.cpp:845
GetRoadStopType
static RoadStopType GetRoadStopType(TileIndex t)
Get the road stop type of this tile.
Definition: station_map.h:56
NPFSetFlag
static void NPFSetFlag(AyStarNode *node, NPFNodeFlag flag, bool value)
Sets the given flag on the given AyStarNode to the given value.
Definition: npf.cpp:99
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition: tile_type.h:42
TracksOverlap
static bool TracksOverlap(TrackBits bits)
Checks if the given tracks overlap, ie form a crossing.
Definition: track_func.h:653
ROADSIDE_BARREN
@ ROADSIDE_BARREN
Road on barren land.
Definition: road_map.h:478
IsStandardRoadStopTile
static bool IsStandardRoadStopTile(TileIndex t)
Is tile t a standard (non-drive through) road stop station?
Definition: station_map.h:223
RoadStop::GetByTile
static RoadStop * GetByTile(TileIndex tile, RoadStopType type)
Find a roadstop at given tile.
Definition: roadstop.cpp:266
IsDriveThroughStopTile
static bool IsDriveThroughStopTile(TileIndex t)
Is tile t a drive through road stop station?
Definition: station_map.h:233
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
NPFSettings::npf_crossing_penalty
uint32 npf_crossing_penalty
the penalty for level crossings
Definition: settings_type.h:369
RAIL_GROUND_BARREN
@ RAIL_GROUND_BARREN
Nothing (dirt)
Definition: rail_map.h:486
GetTileSingleEntry
static DiagDirection GetTileSingleEntry(TileIndex tile, TransportType type, uint subtype)
Tests if a tile can be entered or left only from one side.
Definition: npf.cpp:766
AyStar_EndNodeCheck
int32 AyStar_EndNodeCheck(const AyStar *aystar, const OpenListNode *current)
Check whether the end-tile is found.
Definition: aystar.h:78
RoadStop::GetEntry
const Entry * GetEntry(DiagDirection dir) const
Get the drive through road stop entry struct for the given direction.
Definition: roadstop_base.h:122
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
NPFTrainCheckReverse
bool NPFTrainCheckReverse(const Train *v)
Returns true if it is better to reverse the train before leaving station using NPF.
Definition: npf.cpp:1281
Rail90DegTurnDisallowed
static bool Rail90DegTurnDisallowed(RailType rt1, RailType rt2, bool def=_settings_game.pf.forbid_90_deg)
Test if 90 degree turns are disallowed between two railtypes.
Definition: rail.h:354
DIAGDIR_NW
@ DIAGDIR_NW
Northwest.
Definition: direction_type.h:82
STRAIGHT_TRACK_LENGTH
#define STRAIGHT_TRACK_LENGTH
Approximation of the length of a straight track, relative to a diagonal track (ie the size of a tile ...
Definition: map_type.h:78
NPFSettings::npf_rail_pbs_cross_penalty
uint32 npf_rail_pbs_cross_penalty
the penalty for crossing a reserved rail track
Definition: settings_type.h:364
RoadVehicle::roadtype
RoadType roadtype
Roadtype of this vehicle.
Definition: roadveh.h:117
TransportType
TransportType
Available types of transport.
Definition: transport_type.h:19
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
AyStar::Main
int Main()
This is the function you call to run AyStar.
Definition: aystar.cpp:245
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
RAILTYPES_NONE
@ RAILTYPES_NONE
No rail types.
Definition: rail_type.h:47
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:283
Train::GetVehicleTrackdir
Trackdir GetVehicleTrackdir() const
Get the tracks of the train vehicle.
Definition: train_cmd.cpp:4019
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
MP_ROAD
@ MP_ROAD
A tile with road (or tram tracks)
Definition: tile_type.h:43
IsRailDepot
static bool IsRailDepot(TileIndex t)
Is this rail tile a rail depot?
Definition: rail_map.h:95
GetShipDepotDirection
static DiagDirection GetShipDepotDirection(TileIndex t)
Get the direction of the ship depot.
Definition: water_map.h:261
IsLevelCrossing
static bool IsLevelCrossing(TileIndex t)
Return whether a tile is a level crossing.
Definition: road_map.h:84
GetRailDepotDirection
static DiagDirection GetRailDepotDirection(TileIndex t)
Returns the direction the depot is facing to.
Definition: rail_map.h:171
HasPbsSignalOnTrackdir
static bool HasPbsSignalOnTrackdir(TileIndex tile, Trackdir td)
Is a pbs signal present along the trackdir?
Definition: rail_map.h:463
TrackToTrackBits
static TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition: track_func.h:85
TryReserveRailTrack
bool TryReserveRailTrack(TileIndex tile, Track t, bool trigger_stations)
Try to reserve a specific track on a tile.
Definition: pbs.cpp:80
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
GetTileTrackStatus
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition: landscape.cpp:589
SignalType
SignalType
Type of signal, i.e.
Definition: signal_type.h:23
NPF_FLAG_LAST_SIGNAL_RED
@ NPF_FLAG_LAST_SIGNAL_RED
Used to mark that the last signal on this path was red.
Definition: npf.cpp:60
NPFSettings::npf_road_dt_occupied_penalty
uint32 npf_road_dt_occupied_penalty
the penalty multiplied by the fill percentage of a drive-through road stop
Definition: settings_type.h:371
AyStar::Init
void Init(Hash_HashProc hash, uint num_buckets)
Initialize an AyStar.
Definition: aystar.cpp:293
StationType
StationType
Station types.
Definition: station_type.h:32
TRANSPORT_ROAD
@ TRANSPORT_ROAD
Transport by road vehicle.
Definition: transport_type.h:28
RoadBits
RoadBits
Enumeration for the road parts on a tile.
Definition: road_type.h:50
GetRailTypeInfo
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:304
GetRoadBits
static RoadBits GetRoadBits(TileIndex t, RoadTramType rtt)
Get the present road bits for a specific road type.
Definition: road_map.h:127
NPFSettings::npf_rail_pbs_signal_back_penalty
uint32 npf_rail_pbs_signal_back_penalty
the penalty for passing a pbs signal from the backside
Definition: settings_type.h:365
GameSettings::pf
PathfinderSettings pf
settings for all pathfinders
Definition: settings_type.h:556
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:157
DIAGDIR_SW
@ DIAGDIR_SW
Southwest.
Definition: direction_type.h:81
TrackdirReachesTrackdirs
static TrackdirBits TrackdirReachesTrackdirs(Trackdir trackdir)
Maps a trackdir to the trackdirs that can be reached from it (ie, when entering the next tile.
Definition: track_func.h:592
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:30
UnreserveRailTrack
void UnreserveRailTrack(TileIndex tile, Track t)
Lift the reservation of a specific track on a tile.
Definition: pbs.cpp:141
Vehicle::dest_tile
TileIndex dest_tile
Heading for this tile.
Definition: vehicle_base.h:247
FOR_EACH_SET_TRACK
#define FOR_EACH_SET_TRACK(var, track_bits)
Iterate through each set Track in a TrackBits value.
Definition: track_func.h:27
IsWaitingPositionFree
bool IsWaitingPositionFree(const Train *v, TileIndex tile, Trackdir trackdir, bool forbid_90deg)
Check if a safe position is free.
Definition: pbs.cpp:427
TRACKDIR_BIT_X_NE
@ TRACKDIR_BIT_X_NE
Track x-axis, direction north-east.
Definition: track_type.h:103
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
NPFTrainChooseTrack
Track NPFTrainChooseTrack(const Train *v, bool &path_found, bool reserve_track, struct PBSTileInfo *target)
Finds the best path for given train using NPF.
Definition: npf.cpp:1300
TrackBitsToTrackdirBits
static TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition: track_func.h:327
GetRailTileType
static RailTileType GetRailTileType(TileIndex t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition: rail_map.h:36
PathNode
A path of nodes.
Definition: aystar.h:45
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:240
DEBUG
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
SIGNAL_STATE_RED
@ SIGNAL_STATE_RED
The signal is red.
Definition: signal_type.h:45
NPFFindStationOrTileData::dest_coords
TileIndex dest_coords
An indication of where the station is, for heuristic purposes, or the target tile.
Definition: npf.cpp:31
NPF_HASH_BITS
static const uint NPF_HASH_BITS
The size of the hash used in pathfinding. Just changing this value should be sufficient to change the...
Definition: npf.cpp:23
TrackdirToExitdir
static DiagDirection TrackdirToExitdir(Trackdir trackdir)
Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.
Definition: track_func.h:447
PBSTileInfo
This struct contains information about the end of a reserved path.
Definition: pbs.h:26
ClearPathReservation
static void ClearPathReservation(const PathNode *start, const PathNode *end)
Lift the reservation of the tiles from start till end, excluding end itself.
Definition: npf.cpp:621
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
SIGTYPE_EXIT
@ SIGTYPE_EXIT
presignal block exit
Definition: signal_type.h:26
GetStationType
static StationType GetStationType(TileIndex t)
Get the station type of this tile.
Definition: station_map.h:44
NPFFindStationOrTileData::not_articulated
bool not_articulated
The (road) vehicle is not articulated.
Definition: npf.cpp:35
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:327
PBSTileInfo::trackdir
Trackdir trackdir
The reserved trackdir on the tile.
Definition: pbs.h:28
SIGTYPE_COMBO
@ SIGTYPE_COMBO
presignal inter-block
Definition: signal_type.h:27
HasSignalOnTrackdir
static bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)
Checks for the presence of signals along the given trackdir on the given rail tile.
Definition: rail_map.h:426
AyStar::loops_per_tick
byte loops_per_tick
How many loops are there called before Main() gives control back to the caller. 0 = until done.
Definition: aystar.h:138
RoadTypes
RoadTypes
The different roadtypes we support, but then a bitmask of them.
Definition: road_type.h:36
NPFSaveTargetData
static void NPFSaveTargetData(AyStar *as, OpenListNode *current)
To be called when current contains the (shortest route to) the target node.
Definition: npf.cpp:640
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:80
NPFRoadVehicleFindNearestDepot
FindDepotData NPFRoadVehicleFindNearestDepot(const RoadVehicle *v, int max_penalty)
Used when user sends road vehicle to the nearest depot or if road vehicle needs servicing using NPF.
Definition: npf.cpp:1158
NPF_FLAG_REVERSE
@ NPF_FLAG_REVERSE
Used to mark that this node was reached from the second start node, if applicable.
Definition: npf.cpp:59
ForceReverse
static bool ForceReverse(TileIndex tile, DiagDirection dir, TransportType type, uint subtype)
Tests if a vehicle must reverse on a tile.
Definition: npf.cpp:787
TrackdirCrossesTrackdirs
static TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir)
Maps a trackdir to all trackdirs that make 90 deg turns with it.
Definition: track_func.h:614
NPFFindStationOrTileData::station_type
StationType station_type
The type of station we're heading for.
Definition: npf.cpp:34
ROAD_NE
@ ROAD_NE
North-east part.
Definition: road_type.h:55
HasStationTileRail
static bool HasStationTileRail(TileIndex t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint?
Definition: station_map.h:146
ROAD_SE
@ ROAD_SE
South-east part.
Definition: road_type.h:54
IsRailDepotTile
static bool IsRailDepotTile(TileIndex t)
Is this tile rail tile and a rail depot?
Definition: rail_map.h:105
NPFFoundTargetData::res_okay
bool res_okay
True if a path reservation could be made.
Definition: npf.cpp:73
NPFHash
static uint NPFHash(uint key1, uint key2)
Calculates a hash value for use in the NPF.
Definition: npf.cpp:139
Train
'Train' is either a loco or a wagon.
Definition: train.h:85
IsValidTile
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:161
ReverseDiagDir
static DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
Definition: direction_func.h:118
TRACKDIR_BIT_Y_SE
@ TRACKDIR_BIT_Y_SE
Track y-axis, direction south-east.
Definition: track_type.h:104
IsTileOwner
static bool IsTileOwner(TileIndex tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition: tile_map.h:214
NPFFindStationOrTileData
Meant to be stored in AyStar.targetdata.
Definition: npf.cpp:30
NPF_FLAG_TARGET_RESERVED
@ NPF_FLAG_TARGET_RESERVED
Used to mark that the possible reservation target is already reserved.
Definition: npf.cpp:63
IsSafeWaitingPosition
bool IsSafeWaitingPosition(const Train *v, TileIndex tile, Trackdir trackdir, bool include_line_end, bool forbid_90deg)
Determine whether a certain track on a tile is a safe position to end a path.
Definition: pbs.cpp:381
AYSTAR_STILL_BUSY
@ AYSTAR_STILL_BUSY
Some checking was done, but no path found yet, and there are still items left to try.
Definition: aystar.h:29
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:52
INVALID_DIAGDIR
@ INVALID_DIAGDIR
Flag for an invalid DiagDirection.
Definition: direction_type.h:84
MP_TUNNELBRIDGE
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:50
NPFSettings::npf_road_bay_occupied_penalty
uint32 npf_road_bay_occupied_penalty
the penalty multiplied by the fill percentage of a road bay
Definition: settings_type.h:372
RoadVehicle::compatible_roadtypes
RoadTypes compatible_roadtypes
Roadtypes this consist is powered on.
Definition: roadveh.h:118
NPFDistanceTrack
static uint NPFDistanceTrack(TileIndex t0, TileIndex t1)
Calculates the minimum distance travelled to get from t0 to t1 when only using tracks (ie,...
Definition: npf.cpp:115
INVALID_TRACKDIR
@ INVALID_TRACKDIR
Flag for an invalid trackdir.
Definition: track_type.h:89
IsRoadDepot
static bool IsRoadDepot(TileIndex t)
Return whether a tile is a road depot.
Definition: road_map.h:105
AyStarNode
Node in the search.
Definition: aystar.h:38
CanEnterTileOwnerCheck
static bool CanEnterTileOwnerCheck(Owner owner, TileIndex tile, DiagDirection enterdir)
Finds out if a given company's vehicles are allowed to enter a given tile.
Definition: npf.cpp:693
GetRoadStopDir
static DiagDirection GetRoadStopDir(TileIndex t)
Gets the direction the road stop entrance points towards.
Definition: station_map.h:257
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:77
NPFRoadVehicleChooseTrack
Trackdir NPFRoadVehicleChooseTrack(const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, bool &path_found)
Finds the best path for given road vehicle using NPF.
Definition: npf.cpp:1175
IsRailStationTile
static bool IsRailStationTile(TileIndex t)
Is this tile a station tile and a rail station?
Definition: station_map.h:102
AyStarNodeUserDataType
AyStarNodeUserDataType
Indices into AyStarNode.userdata[].
Definition: npf.cpp:49
IsOnewaySignal
static bool IsOnewaySignal(TileIndex t, Track track)
One-way signals can't be passed the 'wrong' way.
Definition: rail_map.h:319
RoadType
RoadType
The different roadtypes we support.
Definition: road_type.h:22
NPFSettings::npf_rail_depot_reverse_penalty
uint32 npf_rail_depot_reverse_penalty
the penalty for reversing in depots
Definition: settings_type.h:363
NPF_FLAG_LAST_SIGNAL_BLOCK
@ NPF_FLAG_LAST_SIGNAL_BLOCK
Used to mark that the last signal on this path was a block signal.
Definition: npf.cpp:61
OpenListNode
Internal node.
Definition: aystar.h:55
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
ROAD_NW
@ ROAD_NW
North-west part.
Definition: road_type.h:52
GetTunnelBridgeDirection
static DiagDirection GetTunnelBridgeDirection(TileIndex t)
Get the direction pointing to the other end.
Definition: tunnelbridge_map.h:26
CalcClosestStationTile
static TileIndex CalcClosestStationTile(StationID station, TileIndex tile, StationType station_type)
Calculates the tile of given station that is closest to a given tile for this we assume the station i...
Definition: pathfinder_func.h:25
Ship::GetVehicleTrackdir
Trackdir GetVehicleTrackdir() const
Returns the Trackdir on which the vehicle is currently located.
Definition: ship_cmd.cpp:250
FindSafePosition
static const PathNode * FindSafePosition(PathNode *path, const Train *v)
Find the node containing the first signal on the path.
Definition: npf.cpp:604
AyStar::Clear
void Clear()
This function make the memory go back to zero.
Definition: aystar.cpp:222
PBSTileInfo::tile
TileIndex tile
Tile the path ends, INVALID_TILE if no valid path was found.
Definition: pbs.h:27
TRACKDIR_BIT_NONE
@ TRACKDIR_BIT_NONE
No track build.
Definition: track_type.h:102
IsBuoyTile
static bool IsBuoyTile(TileIndex t)
Is tile t a buoy tile?
Definition: station_map.h:316
NPF_FLAG_3RD_SIGNAL
@ NPF_FLAG_3RD_SIGNAL
Used to mark that three signals were seen, rail only.
Definition: npf.cpp:58
Ship
All ships have this type.
Definition: ship.h:26
NPFFoundTargetData::node
AyStarNode node
The node within the target the search led us to.
Definition: npf.cpp:72
NPFSettings::npf_rail_firstred_exit_penalty
uint32 npf_rail_firstred_exit_penalty
the penalty for when the first signal is red (and it is an exit or combo signal)
Definition: settings_type.h:358
NPFSettings::npf_rail_station_penalty
uint32 npf_rail_station_penalty
the penalty for station tiles
Definition: settings_type.h:360
AYSTAR_FOUND_END_NODE
@ AYSTAR_FOUND_END_NODE
An end node was found.
Definition: aystar.h:27
IsRailWaypoint
static bool IsRailWaypoint(TileIndex t)
Is this station tile a rail waypoint?
Definition: station_map.h:113
AyStar
AyStar search algorithm struct.
Definition: aystar.h:116
GetDepotDirection
static DiagDirection GetDepotDirection(TileIndex tile, TransportType type)
Returns the direction the exit of the depot on the given tile is facing.
Definition: npf.cpp:728
SpecializedVehicle< Train, Type >::From
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1162
TRACKDIR_BIT_Y_NW
@ TRACKDIR_BIT_Y_NW
Track y-axis, direction north-west.
Definition: track_type.h:111
IsTunnel
static bool IsTunnel(TileIndex t)
Is this a tunnel (entrance)?
Definition: tunnel_map.h:23
NPFShipCheckReverse
bool NPFShipCheckReverse(const Ship *v)
Returns true if it is better to reverse the ship before leaving depot using NPF.
Definition: npf.cpp:1218
NPFTrainFindNearestSafeTile
bool NPFTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir trackdir, bool override_railtype)
Try to extend the reserved path of a train to the nearest safe tile using NPF.
Definition: npf.cpp:1260
PathNode::parent
PathNode * parent
The parent of this item.
Definition: aystar.h:47
GetSignalStateByTrackdir
static SignalState GetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir)
Gets the state of the signal along the given trackdir.
Definition: rail_map.h:438
TrackToTrackdirBits
static TrackdirBits TrackToTrackdirBits(Track track)
Returns a TrackdirBit mask from a given Track.
Definition: track_func.h:302
MarkTileDirtyByTile
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Definition: viewport.cpp:1985
RoadStop::IsDriveThroughRoadStopContinuation
static bool IsDriveThroughRoadStopContinuation(TileIndex rs, TileIndex next)
Checks whether the 'next' tile is still part of the road same drive through stop 'rs' in the same dir...
Definition: roadstop.cpp:305
TRANSPORT_WATER
@ TRANSPORT_WATER
Transport over water.
Definition: transport_type.h:29
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:46
SpecializedStation< Station, false >::GetByTile
static Station * GetByTile(TileIndex tile)
Get the station belonging to a specific tile.
Definition: base_station_base.h:238
GetStationIndex
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:28
Vehicle::HasArticulatedPart
bool HasArticulatedPart() const
Check if an engine has an articulated part.
Definition: vehicle_base.h:913
NPF_TILE_LENGTH
static const int NPF_TILE_LENGTH
Length (penalty) of one tile with NPF.
Definition: pathfinder_type.h:16
AyStarUserData
Indices into AyStar.userdata[].
Definition: npf.cpp:40
NPFFindSafeTile
static int32 NPFFindSafeTile(const AyStar *as, const OpenListNode *current)
Find any safe and free tile.
Definition: npf.cpp:563
TRACKDIR_END
@ TRACKDIR_END
Used for iterations.
Definition: track_type.h:88
TrackStatusToTrackdirBits
static TrackdirBits TrackStatusToTrackdirBits(TrackStatus ts)
Returns the present-trackdir-information of a TrackStatus.
Definition: track_func.h:360
RoadStop::Entry::GetLength
int GetLength() const
Get the length of this drive through stop.
Definition: roadstop_base.h:47
NPF_TRACKDIR_CHOICE
@ NPF_TRACKDIR_CHOICE
The trackdir chosen to get here.
Definition: npf.cpp:50
NPFShipChooseTrack
Track NPFShipChooseTrack(const Ship *v, bool &path_found)
Finds the best path for given ship using NPF.
Definition: npf.cpp:1197
GetOtherTunnelEnd
TileIndex GetOtherTunnelEnd(TileIndex tile)
Gets the other end of the tunnel.
Definition: tunnel_map.cpp:22
TrackBits
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:38
IsDockingTile
static bool IsDockingTile(TileIndex t)
Checks whether the tile is marked as a dockling tile.
Definition: water_map.h:365
TrackdirToTrackdirBits
static TrackdirBits TrackdirToTrackdirBits(Trackdir trackdir)
Maps a Trackdir to the corresponding TrackdirBits value.
Definition: track_func.h:119
GetTunnelBridgeLength
static uint GetTunnelBridgeLength(TileIndex begin, TileIndex end)
Calculates the length of a tunnel or a bridge (without end tiles)
Definition: tunnelbridge.h:25
NPFSettings::npf_max_search_nodes
uint32 npf_max_search_nodes
The maximum amount of search nodes a single NPF run should take.
Definition: settings_type.h:354
RailtypeInfo::compatible_railtypes
RailTypes compatible_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel
Definition: rail.h:188
IsShipDestinationTile
bool IsShipDestinationTile(TileIndex tile, StationID station)
Test if a tile is a docking tile for the given station.
Definition: ship_cmd.cpp:604
RoadStop::IsFreeBay
bool IsFreeBay(uint nr) const
Checks whether the given bay is free in this road stop.
Definition: roadstop_base.h:93
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:83
IsNormalRoadTile
static bool IsNormalRoadTile(TileIndex t)
Return whether a tile is a normal road tile.
Definition: road_map.h:73
RoadVehicle::IsBus
bool IsBus() const
Check whether a roadvehicle is a bus.
Definition: roadveh_cmd.cpp:79
GetTileRailType
RailType GetTileRailType(TileIndex tile)
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
Definition: rail.cpp:155
SetRoadside
static void SetRoadside(TileIndex tile, Roadside s)
Set the decorations of a road.
Definition: road_map.h:503
AyStar::max_path_cost
uint max_path_cost
If the g-value goes over this number, it stops searching, 0 = infinite.
Definition: aystar.h:139
GetCrossingRoadAxis
static Axis GetCrossingRoadAxis(TileIndex t)
Get the road axis of a level crossing.
Definition: road_map.h:325
TRACKDIR_BIT_X_SW
@ TRACKDIR_BIT_X_SW
Track x-axis, direction south-west.
Definition: track_type.h:110
GetOtherTunnelBridgeEnd
static TileIndex GetOtherTunnelBridgeEnd(TileIndex t)
Determines type of the wormhole and returns its other end.
Definition: tunnelbridge_map.h:78
ReverseTrackdir
static Trackdir ReverseTrackdir(Trackdir trackdir)
Maps a trackdir to the reverse trackdir.
Definition: track_func.h:255
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:70
NPFNodeFlag
NPFNodeFlag
Flags for AyStarNode.userdata[NPF_NODE_FLAGS].
Definition: npf.cpp:55
NextTrackdir
static Trackdir NextTrackdir(Trackdir trackdir)
Maps a trackdir to the trackdir that you will end up on if you go straight ahead.
Definition: track_func.h:411
GetTileType
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
AyStar_CalculateH
int32 AyStar_CalculateH(AyStar *aystar, AyStarNode *current, OpenListNode *parent)
Calculate the H-value for the AyStar algorithm.
Definition: aystar.h:93
RoadStop
A Stop for a Road Vehicle.
Definition: roadstop_base.h:22
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
Track
Track
These are used to specify a single track.
Definition: track_type.h:19
NPFSettings::npf_rail_curve_penalty
uint32 npf_rail_curve_penalty
the penalty for curves
Definition: settings_type.h:362
NPFFoundTargetData::best_path_dist
uint best_path_dist
The shortest path. Is UINT_MAX if no path is found.
Definition: npf.cpp:70
GetTunnelBridgeTransportType
static TransportType GetTunnelBridgeTransportType(TileIndex t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
Definition: tunnelbridge_map.h:39
TrackdirBitsToTrackBits
static TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition: track_func.h:316
DIAGDIR_NE
@ DIAGDIR_NE
Northeast, upper right on your monitor.
Definition: direction_type.h:79
RoadStop::Entry
Container for each entry point of a drive through road stop.
Definition: roadstop_base.h:32
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
ROADTYPES_NONE
@ ROADTYPES_NONE
No roadtypes.
Definition: road_type.h:37
AyStar::AddStartNode
void AddStartNode(AyStarNode *start_node, uint g)
Adds a node from where to start an algorithm.
Definition: aystar.cpp:280
NPFSettings::npf_rail_firstred_penalty
uint32 npf_rail_firstred_penalty
the penalty for when the first signal is red (and it is not an exit or combo signal)
Definition: settings_type.h:357
RailTypes
RailTypes
The different railtypes we support, but then a bitmask of them.
Definition: rail_type.h:46
TileIndexDiffCByDiagDir
static TileIndexDiffC TileIndexDiffCByDiagDir(DiagDirection dir)
Returns the TileIndexDiffC offset from a DiagDirection.
Definition: map_func.h:268
NPFSettings::npf_water_curve_penalty
uint32 npf_water_curve_penalty
the penalty for curves
Definition: settings_type.h:367
SpecializedVehicle::Last
T * Last()
Get the last vehicle in the chain.
Definition: vehicle_base.h:1065
aystar.h
NPFGetFlag
static bool NPFGetFlag(const AyStarNode *node, NPFNodeFlag flag)
Returns the current value of the given flag on the given AyStarNode.
Definition: npf.cpp:91
NPFFoundTargetData::best_bird_dist
uint best_bird_dist
The best heuristic found. Is 0 if the target was found.
Definition: npf.cpp:69
IsValidTrackdir
static bool IsValidTrackdir(Trackdir trackdir)
Checks if a Trackdir is valid for non-road vehicles.
Definition: track_func.h:60
NPFSettings::npf_buoy_penalty
uint32 npf_buoy_penalty
the penalty for going over (through) a buoy
Definition: settings_type.h:366
NPFMarkTile
static void NPFMarkTile(TileIndex tile)
Mark tiles by mowing the grass when npf debug level >= 1.
Definition: npf.cpp:281
CFollowTrackT
Track follower helper template class (can serve pathfinders and vehicle controllers).
Definition: follow_track.hpp:29
RoadVehicle::GetVehicleTrackdir
Trackdir GetVehicleTrackdir() const
Returns the Trackdir on which the vehicle is currently located.
Definition: roadveh_cmd.cpp:1726
NPFSettings::npf_rail_lastred_penalty
uint32 npf_rail_lastred_penalty
the penalty for when the last signal is red
Definition: settings_type.h:359
IsDiagonalTrackdir
static bool IsDiagonalTrackdir(Trackdir trackdir)
Checks if a given Trackdir is diagonal.
Definition: track_func.h:639
TrackdirToTrack
static Track TrackdirToTrack(Trackdir trackdir)
Returns the Track that a given Trackdir represents.
Definition: track_func.h:270
Delta
static T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
Definition: math_func.hpp:170
NPF_FLAG_2ND_SIGNAL
@ NPF_FLAG_2ND_SIGNAL
Used to mark that two signals were seen, rail only.
Definition: npf.cpp:57
AyStar::max_search_nodes
uint max_search_nodes
The maximum number of nodes that will be expanded, 0 = infinite.
Definition: aystar.h:140