OpenTTD Source: src/pathfinder/yapf/yapf.h Source File

OpenTTD Source 12.0-beta1

yapf.h
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 #ifndef YAPF_H
11 #define YAPF_H
12
13 #include "../../direction_type.h"
14 #include "../../track_type.h"
15 #include "../../vehicle_type.h"
16 #include "../../ship.h"
17 #include "../../roadveh.h"
18 #include "../pathfinder_type.h"
19
29 Track YapfShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, ShipPathCache &path_cache);
30
36 bool YapfShipCheckReverse(const Ship *v);
37
47 Trackdir YapfRoadVehicleChooseTrack(const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, TrackdirBits trackdirs, bool &path_found, RoadVehPathCache &path_cache);
48
60 Track YapfTrainChooseTrack(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool reserve_track, struct PBSTileInfo *target);
61
70 FindDepotData YapfRoadVehicleFindNearestDepot(const RoadVehicle *v, int max_penalty);
71
80 FindDepotData YapfTrainFindNearestDepot(const Train *v, int max_distance);
81
87 bool YapfTrainCheckReverse(const Train *v);
88
98 bool YapfTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir td, bool override_railtype);
99
100 #endif /* YAPF_H */
RoadVehicle
Buses, trucks and trams belong to this class.
Definition: roadveh.h:107
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
YapfTrainFindNearestSafeTile
bool YapfTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir td, bool override_railtype)
Try to extend the reserved path of a train to the nearest safe tile using YAPF.
Definition: yapf_rail.cpp:624
FindDepotData
Helper container to find a depot.
Definition: pathfinder_type.h:53
TrackdirBits
TrackdirBits
Enumeration of bitmasks for the TrackDirs.
Definition: track_type.h:101
YapfTrainCheckReverse
bool YapfTrainCheckReverse(const Train *v)
Returns true if it is better to reverse the train before leaving station using YAPF.
Definition: yapf_rail.cpp:546
YapfShipCheckReverse
bool YapfShipCheckReverse(const Ship *v)
Returns true if it is better to reverse the ship before leaving depot using YAPF.
Definition: yapf_ship.cpp:366
YapfTrainFindNearestDepot
FindDepotData YapfTrainFindNearestDepot(const Train *v, int max_distance)
Used when user sends train to the nearest depot or if train needs servicing using YAPF.
Definition: yapf_rail.cpp:605
YapfShipChooseTrack
Track YapfShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, ShipPathCache &path_cache)
Finds the best path for given ship using YAPF.
Definition: yapf_ship.cpp:351
PBSTileInfo
This struct contains information about the end of a reserved path.
Definition: pbs.h:26
YapfRoadVehicleChooseTrack
Trackdir YapfRoadVehicleChooseTrack(const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, TrackdirBits trackdirs, bool &path_found, RoadVehPathCache &path_cache)
Finds the best path for given road vehicle using YAPF.
Definition: yapf_road.cpp:532
Train
'Train' is either a loco or a wagon.
Definition: train.h:86
YapfTrainChooseTrack
Track YapfTrainChooseTrack(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool reserve_track, struct PBSTileInfo *target)
Finds the best path for given train using YAPF.
Definition: yapf_rail.cpp:531
YapfRoadVehicleFindNearestDepot
FindDepotData YapfRoadVehicleFindNearestDepot(const RoadVehicle *v, int max_penalty)
Used when user sends road vehicle to the nearest depot or if road vehicle needs servicing using YAPF.
Definition: yapf_road.cpp:547
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:77
Ship
All ships have this type.
Definition: ship.h:26
RoadVehPathCache
Definition: roadveh.h:85
TrackBits
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:38
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:70
Track
Track
These are used to specify a single track.
Definition: track_type.h:19