OpenTTD

vehicle_type.h
Go to the documentation of this file.
1 /* $Id: vehicle_type.h 23080 2011-11-01 16:51:47Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef VEHICLE_TYPE_H
13 #define VEHICLE_TYPE_H
14
15 #include "core/enum_type.hpp"
16
18 typedef uint32 VehicleID;
19
21 enum VehicleType {
22 VEH_BEGIN,
23
24 VEH_TRAIN = VEH_BEGIN,
25 VEH_ROAD,
26 VEH_SHIP,
27 VEH_AIRCRAFT,
28
29 VEH_COMPANY_END,
30
31 VEH_EFFECT = VEH_COMPANY_END,
32 VEH_DISASTER,
33
34 VEH_END,
35 VEH_INVALID = 0xFF,
36 };
37 DECLARE_POSTFIX_INCREMENT(VehicleType)
39 template <> struct EnumPropsT<VehicleType> : MakeEnumPropsT<VehicleType, byte, VEH_TRAIN, VEH_END, VEH_INVALID, 3> {};
41 typedef SimpleTinyEnumT<VehicleType, byte> VehicleTypeByte;
42
43 struct Vehicle;
44 struct Train;
45 struct RoadVehicle;
46 struct Ship;
47 struct Aircraft;
48 struct EffectVehicle;
49 struct DisasterVehicle;
50
52 struct BaseVehicle
53 {
54 VehicleTypeByte type;
55 };
56
57 static const VehicleID INVALID_VEHICLE = 0xFFFFF;
58
60 enum VehiclePathFinders {
61 VPF_OPF = 0,
62 VPF_NPF = 1,
63 VPF_YAPF = 2,
64 };
65
67 enum DepotCommand {
68 DEPOT_SERVICE = (1U << 28),
69 DEPOT_MASS_SEND = (1U << 29),
70 DEPOT_DONT_CANCEL = (1U << 30),
71 DEPOT_LOCATE_HANGAR = (1U << 31),
72 DEPOT_COMMAND_MASK = 0xFU << 28,
73 };
74
75 static const uint MAX_LENGTH_VEHICLE_NAME_CHARS = 32;
76
78 static const uint VEHICLE_LENGTH = 8;
79
81 enum AccelerationModel {
82 AM_ORIGINAL,
83 AM_REALISTIC,
84 };
85
87 enum EngineImageType {
88 EIT_ON_MAP = 0x00,
89 EIT_IN_DEPOT = 0x10,
90 EIT_IN_DETAILS = 0x11,
91 EIT_IN_LIST = 0x12,
92 EIT_PURCHASE = 0x20,
93 EIT_PREVIEW = 0x21,
94 };
95
96 #endif /* VEHICLE_TYPE_H */
MakeEnumPropsT
Helper template class that makes basic properties of given enumeration type visible from outsize...
Definition: enum_type.hpp:66
VEH_INVALID
Non-existing type of vehicle.
Definition: vehicle_type.h:35
VPF_YAPF
Yet Another PathFinder.
Definition: vehicle_type.h:63
DEPOT_DONT_CANCEL
Don&#39;t cancel current goto depot command if any.
Definition: vehicle_type.h:70
EIT_ON_MAP
Vehicle drawn in viewport.
Definition: vehicle_type.h:88
VEH_DISASTER
Disaster vehicle type.
Definition: vehicle_type.h:32
VPF_OPF
The Original PathFinder (only for ships)
Definition: vehicle_type.h:61
VEH_COMPANY_END
Last company-ownable type.
Definition: vehicle_type.h:29
Aircraft
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:74
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:212
EffectVehicle
A special vehicle is one of the following:
Definition: effectvehicle_base.h:26
EIT_PURCHASE
Vehicle drawn in purchase list, autoreplace gui, ...
Definition: vehicle_type.h:92
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:57
EIT_IN_DEPOT
Vehicle drawn in depot.
Definition: vehicle_type.h:89
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:87
DEPOT_LOCATE_HANGAR
Find another airport if the target one lacks a hangar.
Definition: vehicle_type.h:71
enum_type.hpp
Type (helpers) for enums.
DepotCommand
DepotCommand
Flags to add to p1 for goto depot commands.
Definition: vehicle_type.h:67
EIT_IN_DETAILS
Vehicle drawn in vehicle details, refit window, ...
Definition: vehicle_type.h:90
RoadVehicle
Buses, trucks and trams belong to this class.
Definition: roadveh.h:88
VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
MAX_LENGTH_VEHICLE_NAME_CHARS
static const uint MAX_LENGTH_VEHICLE_NAME_CHARS
The maximum length of a vehicle name in characters including &#39;\0&#39;.
Definition: vehicle_type.h:75
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
DEPOT_MASS_SEND
Tells that it&#39;s a mass send to depot command (type in VLW flag)
Definition: vehicle_type.h:69
VEHICLE_LENGTH
static const uint VEHICLE_LENGTH
The length of a vehicle in tile units.
Definition: vehicle_type.h:78
EnumPropsT
Informative template class exposing basic enumeration properties used by several other templates belo...
Definition: enum_type.hpp:52
EIT_PREVIEW
Vehicle drawn in preview window, news, ...
Definition: vehicle_type.h:93
VEH_EFFECT
Effect vehicle type (smoke, explosions, sparks, bubbles)
Definition: vehicle_type.h:31
VPF_NPF
New PathFinder.
Definition: vehicle_type.h:62
VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
SimpleTinyEnumT< VehicleType, byte >
Ship
All ships have this type.
Definition: ship.h:24
VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
Train
&#39;Train&#39; is either a loco or a wagon.
Definition: train.h:88
DEPOT_SERVICE
The vehicle will leave the depot right after arrival (serivce only)
Definition: vehicle_type.h:68
EIT_IN_LIST
Vehicle drawn in vehicle list, group list, ...
Definition: vehicle_type.h:91
VehiclePathFinders
VehiclePathFinders
Pathfinding option states.
Definition: vehicle_type.h:60
AccelerationModel
AccelerationModel
Vehicle acceleration models.
Definition: vehicle_type.h:81
DisasterVehicle
Disasters, like submarines, skyrangers and their shadows, belong to this class.
Definition: disaster_vehicle.h:39
BaseVehicle
Base vehicle class.
Definition: vehicle_type.h:52
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:16
BaseVehicle::type
VehicleTypeByte type
Type of vehicle.
Definition: vehicle_type.h:54
VehicleTypeByte
SimpleTinyEnumT< VehicleType, byte > VehicleTypeByte
It needs to be 8bits, because we save and load it as such.
Definition: vehicle_type.h:41
VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24