OpenTTD Source 20250312-master-gcdcc6b491d
vehicle_type.h
Go to the documentation of this file.
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
10#ifndef VEHICLE_TYPE_H
11#define VEHICLE_TYPE_H
12
13#include "core/enum_type.hpp"
14#include "core/pool_type.hpp"
15
18
19static const int GROUND_ACCELERATION = 9800;
20
22enum VehicleType : uint8_t {
23 VEH_BEGIN,
24
25 VEH_TRAIN = VEH_BEGIN,
29
31
34
35 VEH_END,
36 VEH_INVALID = 0xFF,
37};
40
41struct Vehicle;
42struct Train;
43struct RoadVehicle;
44struct Ship;
45struct Aircraft;
46struct EffectVehicle;
47struct DisasterVehicle;
48
53
55enum class DepotCommandFlag : uint8_t {
56 Service,
57 MassSend,
59};
61
62static const uint MAX_LENGTH_VEHICLE_NAME_CHARS = 32;
63
65static const uint VEHICLE_LENGTH = 8;
66
68enum AccelerationModel : uint8_t {
69 AM_ORIGINAL,
70 AM_REALISTIC,
71};
72
74enum EngineImageType : uint8_t {
75 EIT_ON_MAP = 0x00,
76 EIT_IN_DEPOT = 0x10,
78 EIT_IN_LIST = 0x12,
79 EIT_PURCHASE = 0x20,
80 EIT_PREVIEW = 0x21,
81};
82
83#endif /* VEHICLE_TYPE_H */
Enum-as-bit-set wrapper.
Type (helpers) for enums.
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Definition enum_type.hpp:80
#define DECLARE_INCREMENT_DECREMENT_OPERATORS(enum_type)
For some enums it is useful to have pre/post increment/decrement operators.
Definition enum_type.hpp:63
Definition of Pool, structure used to access PoolItems, and PoolItem, base structure for Vehicle,...
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition aircraft.h:72
Base vehicle class.
VehicleType type
Type of vehicle.
Disasters, like submarines, skyrangers and their shadows, belong to this class.
A special vehicle is one of the following:
Buses, trucks and trams belong to this class.
Definition roadveh.h:98
All ships have this type.
Definition ship.h:32
'Train' is either a loco or a wagon.
Definition train.h:90
Vehicle data structure.
EngineImageType
Visualisation contexts of vehicles and engines.
@ EIT_PURCHASE
Vehicle drawn in purchase list, autoreplace gui, ...
@ EIT_IN_DEPOT
Vehicle drawn in depot.
@ EIT_IN_DETAILS
Vehicle drawn in vehicle details, refit window, ...
@ EIT_ON_MAP
Vehicle drawn in viewport.
@ EIT_IN_LIST
Vehicle drawn in vehicle list, group list, ...
@ EIT_PREVIEW
Vehicle drawn in preview window, news, ...
VehicleType
Available vehicle types.
@ VEH_INVALID
Non-existing type of vehicle.
@ VEH_ROAD
Road vehicle type.
@ VEH_DISASTER
Disaster vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_EFFECT
Effect vehicle type (smoke, explosions, sparks, bubbles)
@ VEH_TRAIN
Train vehicle type.
@ VEH_COMPANY_END
Last company-ownable type.
DepotCommandFlag
Flags for goto depot commands.
@ MassSend
Tells that it's a mass send to depot command (type in VLW flag)
@ DontCancel
Don't cancel current goto depot command if any.
@ Service
The vehicle will leave the depot right after arrival (service only)
AccelerationModel
Vehicle acceleration models.
static const int GROUND_ACCELERATION
Acceleration due to gravity, 9.8 m/s^2.
static const uint MAX_LENGTH_VEHICLE_NAME_CHARS
The maximum length of a vehicle name in characters including '\0'.
static const uint VEHICLE_LENGTH
The length of a vehicle in tile units.