summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2008-12-20 11:51:52 +0000
committerfrosch <frosch@openttd.org>2008-12-20 11:51:52 +0000
commit74ed0b5efc3098770f806ba694f7ac538f202716 (patch)
tree89d8da25c5a77a29f19e524329934b98c02395b7
parent4ed946bca29ea5b12c5ff8c3d19720bf300d54a1 (diff)
downloadopenttd-74ed0b5efc3098770f806ba694f7ac538f202716.tar.xz
(svn r14702) -Documentation: Add a note about the meaning and validity of Vehicle::dest_tile.
-rw-r--r--src/vehicle_base.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/vehicle_base.h b/src/vehicle_base.h
index cee6c4d5b..6df247c15 100644
--- a/src/vehicle_base.h
+++ b/src/vehicle_base.h
@@ -217,7 +217,13 @@ public:
char *name; ///< Name of vehicle
TileIndex tile; ///< Current tile index
- TileIndex dest_tile; ///< Heading for this tile
+
+ /**
+ * Heading for this tile.
+ * For airports and train stations this tile does not necessarily belong to the destination station,
+ * but it can be used for heuristical purposes to estimate the distance.
+ */
+ TileIndex dest_tile;
Money profit_this_year; ///< Profit this year << 8, low 8 bits are fract
Money profit_last_year; ///< Profit last year << 8, low 8 bits are fract