OpenTTD Source  20241124-master-g9399a92a4f
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 
16 typedef uint32_t VehicleID;
17 
18 static const int GROUND_ACCELERATION = 9800;
19 
21 enum VehicleType : uint8_t {
22  VEH_BEGIN,
23 
24  VEH_TRAIN = VEH_BEGIN,
28 
30 
33 
34  VEH_END,
35  VEH_INVALID = 0xFF,
36 };
39 
40 struct Vehicle;
41 struct Train;
42 struct RoadVehicle;
43 struct Ship;
44 struct Aircraft;
45 struct EffectVehicle;
46 struct DisasterVehicle;
47 
50 {
52 };
53 
54 static const VehicleID INVALID_VEHICLE = 0xFFFFF;
55 
57 enum class DepotCommand : uint8_t {
58  None = 0,
59  Service = (1U << 0),
60  MassSend = (1U << 1),
61  DontCancel = (1U << 2),
62  LocateHangar = (1U << 3),
63 };
65 
66 static const uint MAX_LENGTH_VEHICLE_NAME_CHARS = 32;
67 
69 static const uint VEHICLE_LENGTH = 8;
70 
73  AM_ORIGINAL,
74  AM_REALISTIC,
75 };
76 
79  EIT_ON_MAP = 0x00,
80  EIT_IN_DEPOT = 0x10,
81  EIT_IN_DETAILS = 0x11,
82  EIT_IN_LIST = 0x12,
83  EIT_PURCHASE = 0x20,
84  EIT_PREVIEW = 0x21,
85 };
86 
87 #endif /* VEHICLE_TYPE_H */
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Type (helpers) for enums.
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:18
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Definition: enum_type.hpp:45
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:72
Base vehicle class.
Definition: vehicle_type.h:50
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:51
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:89
Vehicle data structure.
Definition: vehicle_base.h:244
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:78
@ EIT_PURCHASE
Vehicle drawn in purchase list, autoreplace gui, ...
Definition: vehicle_type.h:83
@ EIT_IN_DEPOT
Vehicle drawn in depot.
Definition: vehicle_type.h:80
@ EIT_IN_DETAILS
Vehicle drawn in vehicle details, refit window, ...
Definition: vehicle_type.h:81
@ EIT_ON_MAP
Vehicle drawn in viewport.
Definition: vehicle_type.h:79
@ EIT_IN_LIST
Vehicle drawn in vehicle list, group list, ...
Definition: vehicle_type.h:82
@ EIT_PREVIEW
Vehicle drawn in preview window, news, ...
Definition: vehicle_type.h:84
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
@ VEH_INVALID
Non-existing type of vehicle.
Definition: vehicle_type.h:35
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
@ VEH_DISASTER
Disaster vehicle type.
Definition: vehicle_type.h:32
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
@ VEH_EFFECT
Effect vehicle type (smoke, explosions, sparks, bubbles)
Definition: vehicle_type.h:31
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
@ VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
AccelerationModel
Vehicle acceleration models.
Definition: vehicle_type.h:72
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
static const int GROUND_ACCELERATION
Acceleration due to gravity, 9.8 m/s^2.
Definition: vehicle_type.h:18
static const uint MAX_LENGTH_VEHICLE_NAME_CHARS
The maximum length of a vehicle name in characters including '\0'.
Definition: vehicle_type.h:66
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:54
static const uint VEHICLE_LENGTH
The length of a vehicle in tile units.
Definition: vehicle_type.h:69
DepotCommand
Flags for goto depot commands.
Definition: vehicle_type.h:57
@ LocateHangar
Find another airport if the target one lacks a hangar.
@ None
No special flags.
@ 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)