summaryrefslogtreecommitdiff
path: root/src/engine_type.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2011-03-13 16:43:00 +0000
committeralberth <alberth@openttd.org>2011-03-13 16:43:00 +0000
commitbb4d83214685f5ae62ed8c9377c2f028e2e08c2b (patch)
tree2eec6c733284bf19d0e25230874a902d56496a31 /src/engine_type.h
parent911dfa52bbb92b1f3e1122b45f30227ff456a53b (diff)
downloadopenttd-bb4d83214685f5ae62ed8c9377c2f028e2e08c2b.tar.xz
(svn r22239) -Doc: Further engine doxyment additions.
Diffstat (limited to 'src/engine_type.h')
-rw-r--r--src/engine_type.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/engine_type.h b/src/engine_type.h
index 4b148b07c..65ba029b2 100644
--- a/src/engine_type.h
+++ b/src/engine_type.h
@@ -90,12 +90,12 @@ struct AircraftVehicleInfo {
byte image_index;
byte cost_factor;
byte running_cost;
- byte subtype;
+ byte subtype; ///< Type of aircraft. @see AircraftSubTypeBits
SoundID sfx;
byte acceleration;
uint16 max_speed; ///< Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
- byte mail_capacity;
- uint16 passenger_capacity;
+ byte mail_capacity; ///< Mail capacity (bags).
+ uint16 passenger_capacity; ///< Passenger capacity (persons).
};
/** Information about a road vehicle. */
@@ -119,16 +119,16 @@ struct RoadVehicleInfo {
* @see table/engines.h
*/
struct EngineInfo {
- Date base_intro;
+ Date base_intro; ///< Basic date of engine introduction (without random parts).
Year lifelength; ///< Lifetime of a single vehicle
- Year base_life; ///< Basic duration of engine availability (without random parts)
+ Year base_life; ///< Basic duration of engine availability (without random parts). \c 0xFF means infinite life.
byte decay_speed;
byte load_amount;
- byte climates;
+ byte climates; ///< Climates supported by the engine.
CargoID cargo_type;
uint32 refit_mask;
byte refit_cost;
- byte misc_flags;
+ byte misc_flags; ///< Miscellaneous flags. @see EngineMiscFlags
byte callback_mask; ///< Bitmask of vehicle callbacks that have to be called
int8 retire_early; ///< Number of years early to retire vehicle
StringID string_id; ///< Default name of engine