src/engine_type.h

   1 /* $Id: engine_type.h 24810 2012-12-09 16:55:03Z frosch $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file engine_type.h Types related to engines. */
  11
  12 #ifndef ENGINE_TYPE_H
  13 #define ENGINE_TYPE_H
  14
  15 #include "economy_type.h"
  16 #include "rail_type.h"
  17 #include "cargo_type.h"
  18 #include "date_type.h"
  19 #include "sound_type.h"
  20 #include "strings_type.h"
  21
  22 typedef uint16 EngineID; ///< Unique identification number of an engine.
  23
  24 struct Engine;
  25
  26 /** Available types of rail vehicles. */
  27 enum RailVehicleTypes {
  28         RAILVEH_SINGLEHEAD,  ///< indicates a "standalone" locomotive
  29         RAILVEH_MULTIHEAD,   ///< indicates a combination of two locomotives
  30         RAILVEH_WAGON,       ///< simple wagon, not motorized
  31 };
  32
  33 /** Type of rail engine. */
  34 enum EngineClass {
  35         EC_STEAM,    ///< Steam rail engine.
  36         EC_DIESEL,   ///< Diesel rail engine.
  37         EC_ELECTRIC, ///< Electric rail engine.
  38         EC_MONORAIL, ///< Mono rail engine.
  39         EC_MAGLEV,   ///< Maglev engine.
  40 };
  41
  42 /** Information about a rail vehicle. */
  43 struct RailVehicleInfo {
  44         byte image_index;
  45         RailVehicleTypes railveh_type;
  46         byte cost_factor;               ///< Purchase cost factor;      For multiheaded engines the sum of both engine prices.
  47         RailTypeByte railtype;
  48         uint16 max_speed;               ///< Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
  49         uint16 power;                   ///< Power of engine (hp);      For multiheaded engines the sum of both engine powers.
  50         uint16 weight;                  ///< Weight of vehicle (tons);  For multiheaded engines the weight of each single engine.
  51         byte running_cost;              ///< Running cost of engine;    For multiheaded engines the sum of both running costs.
  52         Price running_cost_class;
  53         EngineClass engclass;           ///< Class of engine for this vehicle
  54         byte capacity;                  ///< Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
  55         byte ai_passenger_only;         ///< Bit value to tell AI that this engine is for passenger use only
  56         uint16 pow_wag_power;           ///< Extra power applied to consist if wagon should be powered
  57         byte pow_wag_weight;            ///< Extra weight applied to consist if wagon should be powered
  58         byte visual_effect;             ///< Bitstuffed NewGRF visual effect data
  59         byte shorten_factor;            ///< length on main map for this type is 8 - shorten_factor
  60         byte tractive_effort;           ///< Tractive effort coefficient
  61         byte air_drag;                  ///< Coefficient of air drag
  62         byte user_def_data;             ///< Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles
  63 };
  64
  65 /** Information about a ship vehicle. */
  66 struct ShipVehicleInfo {
  67         byte image_index;
  68         byte cost_factor;
  69         uint16 max_speed;      ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
  70         uint16 capacity;
  71         byte running_cost;
  72         SoundID sfx;
  73         bool old_refittable;   ///< Is ship refittable; only used during initialisation. Later use EngineInfo::refit_mask.
  74         byte visual_effect;    ///< Bitstuffed NewGRF visual effect data
  75         byte ocean_speed_frac; ///< Fraction of maximum speed for ocean tiles.
  76         byte canal_speed_frac; ///< Fraction of maximum speed for canal/river tiles.
  77
  78         /** Apply ocean/canal speed fraction to a velocity */
  79         uint ApplyWaterClassSpeedFrac(uint raw_speed, bool is_ocean) const
  80         {
  81                 /* speed_frac == 0 means no reduction while 0xFF means reduction to 1/256. */
  82                 return raw_speed * (256 - (is_ocean ? this->ocean_speed_frac : this->canal_speed_frac)) / 256;
  83         }
  84 };
  85
  86 /**
  87  * AircraftVehicleInfo subtypes, bitmask type.
  88  * If bit 0 is 0 then it is a helicopter, otherwise it is a plane
  89  * in which case bit 1 tells us whether it's a big(fast) plane or not.
  90  */
  91 enum AircraftSubTypeBits {
  92         AIR_HELI = 0,
  93         AIR_CTOL = 1, ///< Conventional Take Off and Landing, i.e. planes
  94         AIR_FAST = 2
  95 };
  96
  97 /** Information about a aircraft vehicle. */
  98 struct AircraftVehicleInfo {
  99         byte image_index;
 100         byte cost_factor;
 101         byte running_cost;
 102         byte subtype;               ///< Type of aircraft. @see AircraftSubTypeBits
 103         SoundID sfx;
 104         byte acceleration;
 105         uint16 max_speed;           ///< Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
 106         byte mail_capacity;         ///< Mail capacity (bags).
 107         uint16 passenger_capacity;  ///< Passenger capacity (persons).
 108         uint16 max_range;           ///< Maximum range of this aircraft.
 109 };
 110
 111 /** Information about a road vehicle. */
 112 struct RoadVehicleInfo {
 113         byte image_index;
 114         byte cost_factor;
 115         byte running_cost;
 116         Price running_cost_class;
 117         SoundID sfx;
 118         uint16 max_speed;        ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
 119         byte capacity;
 120         uint8 weight;            ///< Weight in 1/4t units
 121         uint8 power;             ///< Power in 10hp units
 122         uint8 tractive_effort;   ///< Coefficient of tractive effort
 123         uint8 air_drag;          ///< Coefficient of air drag
 124         byte visual_effect;      ///< Bitstuffed NewGRF visual effect data
 125         byte shorten_factor;     ///< length on main map for this type is 8 - shorten_factor
 126 };
 127
 128 /**
 129  * Information about a vehicle
 130  *  @see table/engines.h
 131  */
 132 struct EngineInfo {
 133         Date base_intro;    ///< Basic date of engine introduction (without random parts).
 134         Year lifelength;    ///< Lifetime of a single vehicle
 135         Year base_life;     ///< Basic duration of engine availability (without random parts). \c 0xFF means infinite life.
 136         byte decay_speed;
 137         byte load_amount;
 138         byte climates;      ///< Climates supported by the engine.
 139         CargoID cargo_type;
 140         uint32 refit_mask;
 141         byte refit_cost;
 142         byte misc_flags;    ///< Miscellaneous flags. @see EngineMiscFlags
 143         byte callback_mask; ///< Bitmask of vehicle callbacks that have to be called
 144         int8 retire_early;  ///< Number of years early to retire vehicle
 145         StringID string_id; ///< Default name of engine
 146         uint16 cargo_age_period; ///< Number of ticks before carried cargo is aged.
 147 };
 148
 149 /**
 150  * EngineInfo.misc_flags is a bitmask, with the following values
 151  */
 152 enum EngineMiscFlags {
 153         EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves
 154         EF_ROAD_TRAM  = 0, ///< Road vehicle is a tram/light rail vehicle
 155         EF_USES_2CC   = 1, ///< Vehicle uses two company colours
 156         EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)
 157         EF_RAIL_FLIPS = 3, ///< Rail vehicle can be flipped in the depot
 158         EF_AUTO_REFIT = 4, ///< Automatic refitting is allowed
 159         EF_NO_DEFAULT_CARGO_MULTIPLIER = 5, ///< Use the new capacity algorithm. The default cargotype of the vehicle does not affect capacity multipliers. CB 15 is also called in purchase list.
 160         EF_NO_BREAKDOWN_SMOKE          = 6, ///< Do not show black smoke during a breakdown.
 161         EF_SPRITE_STACK                = 7, ///< Draw vehicle by stacking multiple sprites.
 162 };
 163
 164 /**
 165  * Engine.flags is a bitmask, with the following values.
 166  */
 167 enum EngineFlags {
 168         ENGINE_AVAILABLE         = 1, ///< This vehicle is available to everyone.
 169         ENGINE_EXCLUSIVE_PREVIEW = 2, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a company.
 170 };
 171
 172 static const uint MAX_LENGTH_ENGINE_NAME_CHARS = 32; ///< The maximum length of an engine name in characters including '\0'
 173
 174 static const EngineID INVALID_ENGINE = 0xFFFF; ///< Constant denoting an invalid engine.
 175
 176 #endif /* ENGINE_TYPE_H */