OpenTTD

npf_func.h
Go to the documentation of this file.
1 /* $Id: npf_func.h 24481 2012-08-18 11:37:47Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef NPF_FUNC_H
13 #define NPF_FUNC_H
14
15 #include "../../track_type.h"
16 #include "../../direction_type.h"
17 #include "../../vehicle_type.h"
18 #include "../pathfinder_type.h"
19
28 FindDepotData NPFRoadVehicleFindNearestDepot(const RoadVehicle *v, int max_penalty);
29
39 Trackdir NPFRoadVehicleChooseTrack(const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, TrackdirBits trackdirs, bool &path_found);
40
50 Track NPFShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found);
51
57 bool NPFShipCheckReverse(const Ship *v);
58
67 FindDepotData NPFTrainFindNearestDepot(const Train *v, int max_penalty);
68
78 bool NPFTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir td, bool override_railtype);
79
85 bool NPFTrainCheckReverse(const Train *v);
86
98 Track NPFTrainChooseTrack(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool reserve_track, struct PBSTileInfo *target);
99
100 #endif /* NPF_FUNC_H */
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:1198
Track
Track
These are used to specify a single track.
Definition: track_type.h:21
TrackBits
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:41
RoadVehicle
Buses, trucks and trams belong to this class.
Definition: roadveh.h:88
NPFTrainChooseTrack
Track NPFTrainChooseTrack(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 NPF.
Definition: npf.cpp:1260
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:74
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:80
NPFRoadVehicleChooseTrack
Trackdir NPFRoadVehicleChooseTrack(const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, TrackdirBits trackdirs, bool &path_found)
Finds the best path for given road vehicle using NPF.
Definition: npf.cpp:1131
Ship
All ships have this type.
Definition: ship.h:24
NPFShipChooseTrack
Track NPFShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found)
Finds the best path for given ship using NPF.
Definition: npf.cpp:1158
Train
&#39;Train&#39; is either a loco or a wagon.
Definition: train.h:88
PBSTileInfo
This struct contains information about the end of a reserved path.
Definition: pbs.h:28
NPFTrainFindNearestSafeTile
bool NPFTrainFindNearestSafeTile(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 NPF.
Definition: npf.cpp:1220
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
FindDepotData
Helper container to find a depot.
Definition: pathfinder_type.h:46
NPFTrainCheckReverse
bool NPFTrainCheckReverse(const Train *v)
Returns true if it is better to reverse the train before leaving station using NPF.
Definition: npf.cpp:1241
TrackdirBits
TrackdirBits
Enumeration of bitmasks for the TrackDirs.
Definition: track_type.h:106
NPFShipCheckReverse
bool NPFShipCheckReverse(const Ship *v)
Returns true if it is better to reverse the ship before leaving depot using NPF.
Definition: npf.cpp:1178
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:1114