summaryrefslogtreecommitdiff
path: root/src/pathfinder/npf/npf_func.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pathfinder/npf/npf_func.h')
-rw-r--r--src/pathfinder/npf/npf_func.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/pathfinder/npf/npf_func.h b/src/pathfinder/npf/npf_func.h
index 7121ba065..4d38d5807 100644
--- a/src/pathfinder/npf/npf_func.h
+++ b/src/pathfinder/npf/npf_func.h
@@ -12,6 +12,14 @@
#ifndef NPF_FUNC_H
#define NPF_FUNC_H
+/**
+ * Finds the best path for given ship using NPF.
+ * @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 NPFShipChooseTrack(class Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks);
#endif /* NPF_FUNC_H */