src/vehicle_type.h

   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_t 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 DECLARE_ENUM_AS_ADDABLE(VehicleType)
  39
  40 struct Vehicle;
  41 struct Train;
  42 struct RoadVehicle;
  43 struct Ship;
  44 struct Aircraft;
  45 struct EffectVehicle;
  46 struct DisasterVehicle;
  47
  48 /** Base vehicle class. */
  49 struct BaseVehicle
  50 {
  51         VehicleType type; ///< Type of vehicle
  52 };
  53
  54 static const VehicleID INVALID_VEHICLE = 0xFFFFF; ///< Constant representing a non-existing vehicle.
  55
  56 /** Pathfinding option states */
  57 enum VehiclePathFinders {
  58         // Original PathFinder (OPF) used to be 0
  59         VPF_NPF  = 1, ///< New PathFinder
  60         VPF_YAPF = 2, ///< Yet Another PathFinder
  61 };
  62
  63 /** Flags for goto depot commands. */
  64 enum class DepotCommand : byte {
  65         None         = 0,         ///< No special flags.
  66         Service      = (1U << 0), ///< The vehicle will leave the depot right after arrival (service only)
  67         MassSend     = (1U << 1), ///< Tells that it's a mass send to depot command (type in VLW flag)
  68         DontCancel   = (1U << 2), ///< Don't cancel current goto depot command if any
  69         LocateHangar = (1U << 3), ///< Find another airport if the target one lacks a hangar
  70 };
  71 DECLARE_ENUM_AS_BIT_SET(DepotCommand)
  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 */