OpenTTD
engine_type.h
Go to the documentation of this file.
1 /* $Id: engine_type.h 27668 2016-10-16 14:59:44Z 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 
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;
23 
24 struct Engine;
25 
31 };
32 
40 };
41 
44  byte image_index;
45  RailVehicleTypes railveh_type;
46  byte cost_factor;
47  RailTypeByte railtype;
48  uint16 max_speed;
49  uint16 power;
50  uint16 weight;
51  byte running_cost;
52  Price running_cost_class;
54  byte capacity;
56  uint16 pow_wag_power;
61  byte air_drag;
63 };
64 
67  byte image_index;
68  byte cost_factor;
69  uint16 max_speed;
70  uint16 capacity;
71  byte running_cost;
72  SoundID sfx;
77 
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 
92  AIR_HELI = 0,
93  AIR_CTOL = 1,
94  AIR_FAST = 2
95 };
96 
99  byte image_index;
100  byte cost_factor;
101  byte running_cost;
102  byte subtype;
103  SoundID sfx;
104  byte acceleration;
105  uint16 max_speed;
108  uint16 max_range;
109 };
110 
113  byte image_index;
114  byte cost_factor;
115  byte running_cost;
116  Price running_cost_class;
117  SoundID sfx;
118  uint16 max_speed;
119  byte capacity;
120  uint8 weight;
121  uint8 power;
123  uint8 air_drag;
126 };
127 
132 struct EngineInfo {
136  byte decay_speed;
137  byte load_amount;
138  byte climates;
139  CargoID cargo_type;
140  uint32 refit_mask;
141  byte refit_cost;
142  byte misc_flags;
147 };
148 
162 };
163 
170 };
171 
172 static const uint MAX_LENGTH_ENGINE_NAME_CHARS = 32;
173 
174 static const EngineID INVALID_ENGINE = 0xFFFF;
175 
176 #endif /* ENGINE_TYPE_H */
Information about a ship vehicle.
Definition: engine_type.h:66
This vehicle is in the exclusive preview stage, either being used or being offered to a company...
Definition: engine_type.h:169
byte ocean_speed_frac
Fraction of maximum speed for ocean tiles.
Definition: engine_type.h:75
Conventional Take Off and Landing, i.e. planes.
Definition: engine_type.h:93
Do not show black smoke during a breakdown.
Definition: engine_type.h:160
EngineFlags
Engine.flags is a bitmask, with the following values.
Definition: engine_type.h:167
Rail vehicle can be flipped in the depot.
Definition: engine_type.h:157
uint ApplyWaterClassSpeedFrac(uint raw_speed, bool is_ocean) const
Apply ocean/canal speed fraction to a velocity.
Definition: engine_type.h:79
byte visual_effect
Bitstuffed NewGRF visual effect data.
Definition: engine_type.h:124
Price
Enumeration of all base prices for use with Prices.
Definition: economy_type.h:67
EngineClass
Type of rail engine.
Definition: engine_type.h:34
Rail vehicle tilts in curves.
Definition: engine_type.h:153
byte pow_wag_weight
Extra weight applied to consist if wagon should be powered.
Definition: engine_type.h:57
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:20
Types related to cargoes...
EngineMiscFlags
EngineInfo.misc_flags is a bitmask, with the following values.
Definition: engine_type.h:152
Date base_intro
Basic date of engine introduction (without random parts).
Definition: engine_type.h:133
Year lifelength
Lifetime of a single vehicle.
Definition: engine_type.h:134
Maglev engine.
Definition: engine_type.h:39
uint16 max_speed
Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
Definition: engine_type.h:105
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
Definition: engine_type.h:69
Mono rail engine.
Definition: engine_type.h:38
Diesel rail engine.
Definition: engine_type.h:36
Information about a vehicle.
Definition: engine_type.h:132
byte subtype
Type of aircraft.
Definition: engine_type.h:102
int8 retire_early
Number of years early to retire vehicle.
Definition: engine_type.h:144
Types related to the economy.
EngineClass engclass
Class of engine for this vehicle.
Definition: engine_type.h:53
uint16 pow_wag_power
Extra power applied to consist if wagon should be powered.
Definition: engine_type.h:56
uint16 max_speed
Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: engine_type.h:48
byte callback_mask
Bitmask of vehicle callbacks that have to be called.
Definition: engine_type.h:143
simple wagon, not motorized
Definition: engine_type.h:30
Rail vehicle is a multiple-unit (DMU/EMU)
Definition: engine_type.h:156
Draw vehicle by stacking multiple sprites.
Definition: engine_type.h:161
Vehicle uses two company colours.
Definition: engine_type.h:155
byte visual_effect
Bitstuffed NewGRF visual effect data.
Definition: engine_type.h:74
byte capacity
Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
Definition: engine_type.h:54
uint8 tractive_effort
Coefficient of tractive effort.
Definition: engine_type.h:122
byte cost_factor
Purchase cost factor; For multiheaded engines the sum of both engine prices.
Definition: engine_type.h:46
byte misc_flags
Miscellaneous flags.
Definition: engine_type.h:142
byte shorten_factor
length on main map for this type is 8 - shorten_factor
Definition: engine_type.h:59
byte air_drag
Coefficient of air drag.
Definition: engine_type.h:61
uint8 weight
Weight in 1/4t units.
Definition: engine_type.h:120
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
uint16 power
Power of engine (hp); For multiheaded engines the sum of both engine powers.
Definition: engine_type.h:49
Information about a rail vehicle.
Definition: engine_type.h:43
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:174
bool old_refittable
Is ship refittable; only used during initialisation. Later use EngineInfo::refit_mask.
Definition: engine_type.h:73
Automatic refitting is allowed.
Definition: engine_type.h:158
Information about a road vehicle.
Definition: engine_type.h:112
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
Definition: engine_type.h:118
indicates a "standalone" locomotive
Definition: engine_type.h:28
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:22
byte tractive_effort
Tractive effort coefficient.
Definition: engine_type.h:60
AircraftSubTypeBits
AircraftVehicleInfo subtypes, bitmask type.
Definition: engine_type.h:91
Information about a aircraft vehicle.
Definition: engine_type.h:98
indicates a combination of two locomotives
Definition: engine_type.h:29
uint8 power
Power in 10hp units.
Definition: engine_type.h:121
uint16 max_range
Maximum range of this aircraft.
Definition: engine_type.h:108
StringID string_id
Default name of engine.
Definition: engine_type.h:145
uint16 weight
Weight of vehicle (tons); For multiheaded engines the weight of each single engine.
Definition: engine_type.h:50
Types related to sounds.
byte shorten_factor
length on main map for this type is 8 - shorten_factor
Definition: engine_type.h:125
Types related to strings.
Types related to the dates in OpenTTD.
Steam rail engine.
Definition: engine_type.h:35
uint8 air_drag
Coefficient of air drag.
Definition: engine_type.h:123
int32 Date
The type to store our dates in.
Definition: date_type.h:16
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
uint16 cargo_age_period
Number of ticks before carried cargo is aged.
Definition: engine_type.h:146
Year base_life
Basic duration of engine availability (without random parts). 0xFF means infinite life...
Definition: engine_type.h:135
Road vehicle is a tram/light rail vehicle.
Definition: engine_type.h:154
static const uint MAX_LENGTH_ENGINE_NAME_CHARS
The maximum length of an engine name in characters including &#39;\0&#39;.
Definition: engine_type.h:172
This vehicle is available to everyone.
Definition: engine_type.h:168
byte ai_passenger_only
Bit value to tell AI that this engine is for passenger use only.
Definition: engine_type.h:55
Use the new capacity algorithm. The default cargotype of the vehicle does not affect capacity multipl...
Definition: engine_type.h:159
byte running_cost
Running cost of engine; For multiheaded engines the sum of both running costs.
Definition: engine_type.h:51
byte climates
Climates supported by the engine.
Definition: engine_type.h:138
byte canal_speed_frac
Fraction of maximum speed for canal/river tiles.
Definition: engine_type.h:76
byte user_def_data
Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles.
Definition: engine_type.h:62
uint16 passenger_capacity
Passenger capacity (persons).
Definition: engine_type.h:107
RailVehicleTypes
Available types of rail vehicles.
Definition: engine_type.h:27
byte mail_capacity
Mail capacity (bags).
Definition: engine_type.h:106
byte visual_effect
Bitstuffed NewGRF visual effect data.
Definition: engine_type.h:58
Electric rail engine.
Definition: engine_type.h:37
The different types of rail.