summaryrefslogtreecommitdiff
path: root/src/engine_type.h
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2010-06-08 20:16:51 +0000
committerfrosch <frosch@openttd.org>2010-06-08 20:16:51 +0000
commite597ec6bf95ba93e8fb3177f408dadec43e20e95 (patch)
tree34aa1f3cfa7ecc9291eb1fe52d9ceac0efde3745 /src/engine_type.h
parent06ba1c5f5e51932652c2f48c57e6b120c5bfd255 (diff)
downloadopenttd-e597ec6bf95ba93e8fb3177f408dadec43e20e95.tar.xz
(svn r19949) -Doc: Mention tricky units (like speed) more often and more consistently.
Diffstat (limited to 'src/engine_type.h')
-rw-r--r--src/engine_type.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/engine_type.h b/src/engine_type.h
index 6f9db7964..70318be30 100644
--- a/src/engine_type.h
+++ b/src/engine_type.h
@@ -42,9 +42,9 @@ struct RailVehicleInfo {
RailVehicleTypes railveh_type;
byte cost_factor; ///< Purchase cost factor; For multiheaded engines the sum of both engine prices.
RailTypeByte railtype;
- uint16 max_speed;
- uint16 power; ///< Power of engine; For multiheaded engines the sum of both engine powers.
- uint16 weight; ///< Weight of vehicle; For multiheaded engines the weight of each single engine.
+ uint16 max_speed; ///< Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
+ uint16 power; ///< Power of engine (hp); For multiheaded engines the sum of both engine powers.
+ uint16 weight; ///< Weight of vehicle (tons); For multiheaded engines the weight of each single engine.
byte running_cost; ///< Running cost of engine; For multiheaded engines the sum of both running costs.
Price running_cost_class;
EngineClass engclass; ///< Class of engine for this vehicle
@@ -61,7 +61,7 @@ struct RailVehicleInfo {
struct ShipVehicleInfo {
byte image_index;
byte cost_factor;
- uint16 max_speed;
+ uint16 max_speed; ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
uint16 capacity;
byte running_cost;
SoundID sfx;
@@ -84,7 +84,7 @@ struct AircraftVehicleInfo {
byte subtype;
SoundID sfx;
byte acceleration;
- uint16 max_speed;
+ uint16 max_speed; ///< Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
byte mail_capacity;
uint16 passenger_capacity;
};
@@ -95,7 +95,7 @@ struct RoadVehicleInfo {
byte running_cost;
Price running_cost_class;
SoundID sfx;
- uint16 max_speed; ///< Maximum speed in mph/3.2 units
+ uint16 max_speed; ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
byte capacity;
uint8 weight; ///< Weight in 1/4t units
uint8 power; ///< Power in 10hp units
@@ -108,8 +108,8 @@ struct RoadVehicleInfo {
*/
struct EngineInfo {
Date base_intro;
- Year lifelength;
- Year base_life;
+ Year lifelength; ///< Lifetime of a single vehicle
+ Year base_life; ///< Basic duration of engine availability (without random parts)
byte decay_speed;
byte load_amount;
byte climates;