1 /* 2 * This file is part of OpenTTD. 3 * 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. 4 * 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. 5 * 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/>. 6 */ 7 8 /** @file vehicle_type.h Types related to vehicles. */ 9 10 #ifndef VEHICLE_TYPE_H 11 #define VEHICLE_TYPE_H 12 13 #include "core/enum_type.hpp" 14 15 /** The type all our vehicle IDs have. */ 16 typedef uint32 VehicleID; 17 18 static const int GROUND_ACCELERATION = 9800; ///< Acceleration due to gravity, 9.8 m/s^2 19 20 /** Available vehicle types. It needs to be 8bits, because we save and load it as such */ 21 enum VehicleType : byte { 22 VEH_BEGIN, 23 24 VEH_TRAIN = VEH_BEGIN, ///< %Train vehicle type. 25 VEH_ROAD, ///< Road vehicle type. 26 VEH_SHIP, ///< %Ship vehicle type. 27 VEH_AIRCRAFT, ///< %Aircraft vehicle type. 28 29 VEH_COMPANY_END, ///< Last company-ownable type. 30 31 VEH_EFFECT = VEH_COMPANY_END, ///< Effect vehicle type (smoke, explosions, sparks, bubbles) 32 VEH_DISASTER, ///< Disaster vehicle type. 33 34 VEH_END, 35 VEH_INVALID = 0xFF, ///< Non-existing type of vehicle. 36 }; 37 DECLARE_POSTFIX_INCREMENT(VehicleType) 38 /** Helper information for extract tool. */ 39 template <> struct EnumPropsT<VehicleType> : MakeEnumPropsT<VehicleType, byte, VEH_TRAIN, VEH_END, VEH_INVALID, 3> {}; 40 41 struct Vehicle; 42 struct Train; 43 struct RoadVehicle; 44 struct Ship; 45 struct Aircraft; 46 struct EffectVehicle; 47 struct DisasterVehicle; 48 49 /** Base vehicle class. */ 50 struct BaseVehicle 51 { 52 VehicleType type; ///< Type of vehicle 53 }; 54 55 static const VehicleID INVALID_VEHICLE = 0xFFFFF; ///< Constant representing a non-existing vehicle. 56 57 /** Pathfinding option states */ 58 enum VehiclePathFinders { 59 // Original PathFinder (OPF) used to be 0 60 VPF_NPF = 1, ///< New PathFinder 61 VPF_YAPF = 2, ///< Yet Another PathFinder 62 }; 63 64 /** Flags to add to p1 for goto depot commands. */ 65 enum DepotCommand { 66 DEPOT_SERVICE = (1U << 28), ///< The vehicle will leave the depot right after arrival (service only) 67 DEPOT_MASS_SEND = (1U << 29), ///< Tells that it's a mass send to depot command (type in VLW flag) 68 DEPOT_DONT_CANCEL = (1U << 30), ///< Don't cancel current goto depot command if any 69 DEPOT_LOCATE_HANGAR = (1U << 31), ///< Find another airport if the target one lacks a hangar 70 DEPOT_COMMAND_MASK = 0xFU << 28, 71 }; 72 73 static const uint MAX_LENGTH_VEHICLE_NAME_CHARS = 32; ///< The maximum length of a vehicle name in characters including '\0' 74 75 /** The length of a vehicle in tile units. */ 76 static const uint VEHICLE_LENGTH = 8; 77 78 /** Vehicle acceleration models. */ 79 enum AccelerationModel { 80 AM_ORIGINAL, 81 AM_REALISTIC, 82 }; 83 84 /** Visualisation contexts of vehicles and engines. */ 85 enum EngineImageType { 86 EIT_ON_MAP = 0x00, ///< Vehicle drawn in viewport. 87 EIT_IN_DEPOT = 0x10, ///< Vehicle drawn in depot. 88 EIT_IN_DETAILS = 0x11, ///< Vehicle drawn in vehicle details, refit window, ... 89 EIT_IN_LIST = 0x12, ///< Vehicle drawn in vehicle list, group list, ... 90 EIT_PURCHASE = 0x20, ///< Vehicle drawn in purchase list, autoreplace gui, ... 91 EIT_PREVIEW = 0x21, ///< Vehicle drawn in preview window, news, ... 92 }; 93 94 #endif /* VEHICLE_TYPE_H */ 95