diff options
author | terkhen <terkhen@openttd.org> | 2011-06-04 21:19:00 +0000 |
---|---|---|
committer | terkhen <terkhen@openttd.org> | 2011-06-04 21:19:00 +0000 |
commit | 9f68c20d10886074b10b1d96e8cdce0dcc03436a (patch) | |
tree | 48f8f69bb4bb9119c972878a386ee7471c6edbf4 | |
parent | 5bb79b1f46f2428f6416ad6d85b0e903ca9629b4 (diff) | |
download | openttd-9f68c20d10886074b10b1d96e8cdce0dcc03436a.tar.xz |
(svn r22541) -Document: GoodsEntry struct.
-rw-r--r-- | src/station_base.h | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/src/station_base.h b/src/station_base.h index 406baca83..55bf91c4f 100644 --- a/src/station_base.h +++ b/src/station_base.h @@ -23,10 +23,14 @@ extern StationPool _station_pool; static const byte INITIAL_STATION_RATING = 175; +/** + * Stores station stats for a single cargo. + */ struct GoodsEntry { + /** Status of this cargo for the station. */ enum GoodsEntryStatus { - GES_ACCEPTANCE, - GES_PICKUP, + GES_ACCEPTANCE, ///< This cargo is currently being accepted by the station. + GES_PICKUP, ///< This cargo has been picked up at this station at least once. }; GoodsEntry() : @@ -37,11 +41,11 @@ struct GoodsEntry { last_age(255) {} - byte acceptance_pickup; - byte days_since_pickup; - byte rating; - byte last_speed; - byte last_age; + byte acceptance_pickup; ///< Status of this cargo, see #GoodsEntryStatus. + byte days_since_pickup; ///< Number of days since the last pickup for this cargo (up to 255). + byte rating; ///< Station rating for this cargo. + byte last_speed; ///< Maximum speed of the last vehicle that picked up this cargo (up to 255). + byte last_age; ///< Age in years of the last vehicle that picked up this cargo. byte amount_fract; ///< Fractional part of the amount in the cargo list StationCargoList cargo; ///< The cargo packets of cargo waiting in this station }; |