summaryrefslogtreecommitdiff
path: root/src/pathfinder/opf/opf_ship.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pathfinder/opf/opf_ship.h')
-rw-r--r--src/pathfinder/opf/opf_ship.h8
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 */