vehicle_type.h

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef VEHICLE_TYPE_H
#define VEHICLE_TYPE_H
 
#include "core/enum_type.hpp"
#include "core/pool_type.hpp"

using VehicleID = PoolID<uint32_t, struct VehicleIDTag, 0xFF000, 0xFFFFF>;
 
static const int GROUND_ACCELERATION = 9800; 

enum class VehicleType : uint8_t {
  Begin, 
 
  Train = VehicleType::Begin, 
  Road, 
  Ship, 
  Aircraft, 
 
  CompanyEnd, 
 
  Effect = VehicleType::CompanyEnd, 
  Disaster, 
  End, 
 
  Invalid = 0xFF, 
};
DECLARE_INCREMENT_DECREMENT_OPERATORS(VehicleType)
DECLARE_ENUM_AS_ADDABLE(VehicleType)
 
struct Vehicle;
struct Train;
struct RoadVehicle;
struct Ship;
struct Aircraft;
struct EffectVehicle;
struct DisasterVehicle;

struct BaseVehicle {
  VehicleType type = VehicleType::Invalid; 
};

enum class DepotCommandFlag : uint8_t {
  Service, 
  MassSend, 
  DontCancel, 
};

using DepotCommandFlags = EnumBitSet<DepotCommandFlag, uint8_t>;
 
static const uint MAX_LENGTH_VEHICLE_NAME_CHARS = 32; 

static const uint VEHICLE_LENGTH = 8;

enum class AccelerationModel : uint8_t {
  Original, 
  Realistic, 
};

enum class EngineImageType : uint8_t {
  OnMap = 0x00, 
  InDepot = 0x10, 
  InDetails = 0x11, 
  InList = 0x12, 
  Purchase = 0x20, 
  Preview = 0x21, 
};

enum class VehicleRandomTrigger : uint8_t {
  NewCargo, 
  Depot, 
  Empty, 
  AnyNewCargo, 
  Callback32, 
};

using VehicleRandomTriggers = EnumBitSet<VehicleRandomTrigger, uint8_t>;

template <typename T, VehicleType Tend = VehicleType::CompanyEnd>
using VehicleTypeIndexArray = EnumIndexArray<T, VehicleType, Tend>;

enum class GroundVehicleFlag : uint8_t {
  GoingUp = 0, 
  GoingDown = 1, 
  SuppressImplicitOrders = 2, 
};

using GroundVehicleFlags = EnumBitSet<GroundVehicleFlag, uint16_t>;
 
#endif /* VEHICLE_TYPE_H */