diff options
author | rubidium <rubidium@openttd.org> | 2009-12-02 00:01:07 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2009-12-02 00:01:07 +0000 |
commit | 9d5ff5def0790ead791b7ef09727d3ad3b41e565 (patch) | |
tree | 9320a45ecc7c0657d387d786fc55b18e9a705174 /src/pathfinder/opf/opf_ship.h | |
parent | 76fe20cdccd68679f4681e3f378b7695d161e8a8 (diff) | |
download | openttd-9d5ff5def0790ead791b7ef09727d3ad3b41e565.tar.xz |
(svn r18368) -Fix: alignment of comment and 'add' some missing comments
Diffstat (limited to 'src/pathfinder/opf/opf_ship.h')
-rw-r--r-- | src/pathfinder/opf/opf_ship.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/pathfinder/opf/opf_ship.h b/src/pathfinder/opf/opf_ship.h index 99050c33f..829417b38 100644 --- a/src/pathfinder/opf/opf_ship.h +++ b/src/pathfinder/opf/opf_ship.h @@ -12,6 +12,14 @@ #ifndef OPF_SHIP_H #define OPF_SHIP_H +/** + * Finds the best path for given ship using OPF. + * @param v the ship that needs to find a path + * @param tile the tile to find the path from (should be next tile the ship is about to enter) + * @param enterdir diagonal direction which the ship will enter this new tile from + * @param tracks available tracks on the new tile (to choose from) + * @return the best trackdir for next turn or INVALID_TRACK if the path could not be found + */ Track OPFShipChooseTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks); #endif /* OPF_SHIP_H */ |