Files
@ r22159:1c3de15ce0f6
Branch filter:
Location: cpp/openttd-patchpack/source/src/engine_type.h - annotation
r22159:1c3de15ce0f6
7.4 KiB
text/x-c
(svn r27332) -Change: Enable YAPF cache debugging with desync debug level 2.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | r8777:59b04e504aa5 r8777:59b04e504aa5 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r13476:add6db25d711 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r9070:e059c65164f3 r9070:e059c65164f3 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r17472:0c79f01bb563 r17472:0c79f01bb563 r17472:0c79f01bb563 r17472:0c79f01bb563 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r9923:fd1b105946d0 r8777:59b04e504aa5 r15298:17db9e039ab9 r15298:17db9e039ab9 r15298:17db9e039ab9 r9720:6d491d07d0a8 r13476:add6db25d711 r8777:59b04e504aa5 r9720:6d491d07d0a8 r11479:dec827fa3319 r11479:dec827fa3319 r11479:dec827fa3319 r11479:dec827fa3319 r11479:dec827fa3319 r11479:dec827fa3319 r15626:21d8c9ada4af r11479:dec827fa3319 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 r9923:fd1b105946d0 r15298:17db9e039ab9 r8777:59b04e504aa5 r8777:59b04e504aa5 r11932:f2bc1b879057 r13183:9f8ce87db9c1 r16504:0f05656995b0 r17838:9b7a4cc981f2 r17838:9b7a4cc981f2 r18024:9fef0937e079 r18024:9fef0937e079 r18024:9fef0937e079 r18024:9fef0937e079 r18024:9fef0937e079 r18024:9fef0937e079 r18024:9fef0937e079 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r17472:0c79f01bb563 r8777:59b04e504aa5 r17472:0c79f01bb563 r17472:0c79f01bb563 r15173:a59afd6301a6 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 r9923:fd1b105946d0 r8777:59b04e504aa5 r17474:de3bcebf8038 r11932:f2bc1b879057 r8777:59b04e504aa5 r15298:17db9e039ab9 r17474:de3bcebf8038 r17474:de3bcebf8038 r18646:67fc6c803d34 r8777:59b04e504aa5 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 r9923:fd1b105946d0 r8777:59b04e504aa5 r13476:add6db25d711 r11932:f2bc1b879057 r15298:17db9e039ab9 r8777:59b04e504aa5 r10982:d76e5db67170 r10982:d76e5db67170 r10982:d76e5db67170 r10982:d76e5db67170 r16504:0f05656995b0 r18303:3e17bd9b946b r8777:59b04e504aa5 r8777:59b04e504aa5 r15610:623a23fb6560 r15610:623a23fb6560 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r17474:de3bcebf8038 r15298:17db9e039ab9 r17474:de3bcebf8038 r9468:a092e2eb1209 r8777:59b04e504aa5 r17474:de3bcebf8038 r12733:799714c0c280 r8777:59b04e504aa5 r8777:59b04e504aa5 r17474:de3bcebf8038 r13026:0c3f00ec0a74 r8777:59b04e504aa5 r8777:59b04e504aa5 r17899:92aaab03ad72 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r15173:a59afd6301a6 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r17217:f3cc4b30e11a r18241:a4322e3af754 r18995:f351efee7911 r19221:9e0441276d88 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r8777:59b04e504aa5 r15173:a59afd6301a6 r8777:59b04e504aa5 r10207:a1fc2f2a33db r8777:59b04e504aa5 r8777:59b04e504aa5 r17569:79cc833a8f35 r8777:59b04e504aa5 r17472:0c79f01bb563 r8777:59b04e504aa5 r8777:59b04e504aa5 | /* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file engine_type.h Types related to engines. */
#ifndef ENGINE_TYPE_H
#define ENGINE_TYPE_H
#include "economy_type.h"
#include "rail_type.h"
#include "cargo_type.h"
#include "date_type.h"
#include "sound_type.h"
#include "strings_type.h"
typedef uint16 EngineID; ///< Unique identification number of an engine.
struct Engine;
/** Available types of rail vehicles. */
enum RailVehicleTypes {
RAILVEH_SINGLEHEAD, ///< indicates a "standalone" locomotive
RAILVEH_MULTIHEAD, ///< indicates a combination of two locomotives
RAILVEH_WAGON, ///< simple wagon, not motorized
};
/** Type of rail engine. */
enum EngineClass {
EC_STEAM, ///< Steam rail engine.
EC_DIESEL, ///< Diesel rail engine.
EC_ELECTRIC, ///< Electric rail engine.
EC_MONORAIL, ///< Mono rail engine.
EC_MAGLEV, ///< Maglev engine.
};
/** Information about a rail vehicle. */
struct RailVehicleInfo {
byte image_index;
RailVehicleTypes railveh_type;
byte cost_factor; ///< Purchase cost factor; For multiheaded engines the sum of both engine prices.
RailTypeByte railtype;
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
byte capacity; ///< Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
byte ai_passenger_only; ///< Bit value to tell AI that this engine is for passenger use only
uint16 pow_wag_power; ///< Extra power applied to consist if wagon should be powered
byte pow_wag_weight; ///< Extra weight applied to consist if wagon should be powered
byte visual_effect; ///< Bitstuffed NewGRF visual effect data
byte shorten_factor; ///< length on main map for this type is 8 - shorten_factor
byte tractive_effort; ///< Tractive effort coefficient
byte air_drag; ///< Coefficient of air drag
byte user_def_data; ///< Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles
};
/** Information about a ship vehicle. */
struct ShipVehicleInfo {
byte image_index;
byte cost_factor;
uint16 max_speed; ///< Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
uint16 capacity;
byte running_cost;
SoundID sfx;
bool old_refittable; ///< Is ship refittable; only used during initialisation. Later use EngineInfo::refit_mask.
byte visual_effect; ///< Bitstuffed NewGRF visual effect data
byte ocean_speed_frac; ///< Fraction of maximum speed for ocean tiles.
byte canal_speed_frac; ///< Fraction of maximum speed for canal/river tiles.
/** Apply ocean/canal speed fraction to a velocity */
uint ApplyWaterClassSpeedFrac(uint raw_speed, bool is_ocean) const
{
/* speed_frac == 0 means no reduction while 0xFF means reduction to 1/256. */
return raw_speed * (256 - (is_ocean ? this->ocean_speed_frac : this->canal_speed_frac)) / 256;
}
};
/**
* AircraftVehicleInfo subtypes, bitmask type.
* If bit 0 is 0 then it is a helicopter, otherwise it is a plane
* in which case bit 1 tells us whether it's a big(fast) plane or not.
*/
enum AircraftSubTypeBits {
AIR_HELI = 0,
AIR_CTOL = 1, ///< Conventional Take Off and Landing, i.e. planes
AIR_FAST = 2
};
/** Information about a aircraft vehicle. */
struct AircraftVehicleInfo {
byte image_index;
byte cost_factor;
byte running_cost;
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; ///< Mail capacity (bags).
uint16 passenger_capacity; ///< Passenger capacity (persons).
uint16 max_range; ///< Maximum range of this aircraft.
};
/** Information about a road vehicle. */
struct RoadVehicleInfo {
byte image_index;
byte cost_factor;
byte running_cost;
Price running_cost_class;
SoundID sfx;
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
uint8 tractive_effort; ///< Coefficient of tractive effort
uint8 air_drag; ///< Coefficient of air drag
byte visual_effect; ///< Bitstuffed NewGRF visual effect data
byte shorten_factor; ///< length on main map for this type is 8 - shorten_factor
};
/**
* Information about a vehicle
* @see table/engines.h
*/
struct EngineInfo {
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). \c 0xFF means infinite life.
byte decay_speed;
byte load_amount;
byte climates; ///< Climates supported by the engine.
CargoID cargo_type;
uint32 refit_mask;
byte refit_cost;
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
uint16 cargo_age_period; ///< Number of ticks before carried cargo is aged.
};
/**
* EngineInfo.misc_flags is a bitmask, with the following values
*/
enum EngineMiscFlags {
EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves
EF_ROAD_TRAM = 0, ///< Road vehicle is a tram/light rail vehicle
EF_USES_2CC = 1, ///< Vehicle uses two company colours
EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)
EF_RAIL_FLIPS = 3, ///< Rail vehicle can be flipped in the depot
EF_AUTO_REFIT = 4, ///< Automatic refitting is allowed
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.
EF_NO_BREAKDOWN_SMOKE = 6, ///< Do not show black smoke during a breakdown.
};
/**
* Engine.flags is a bitmask, with the following values.
*/
enum EngineFlags {
ENGINE_AVAILABLE = 1, ///< This vehicle is available to everyone.
ENGINE_EXCLUSIVE_PREVIEW = 2, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a company.
};
static const uint MAX_LENGTH_ENGINE_NAME_CHARS = 32; ///< The maximum length of an engine name in characters including '\0'
static const EngineID INVALID_ENGINE = 0xFFFF; ///< Constant denoting an invalid engine.
#endif /* ENGINE_TYPE_H */
|