OpenTTD Source  20241108-master-g80f628063a
vehiclelist.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 VEHICLELIST_H
11 #define VEHICLELIST_H
12 
13 #include "vehicle_type.h"
14 #include "company_type.h"
15 #include "tile_type.h"
16 
18 enum VehicleListType : uint8_t {
19  VL_STANDARD,
20  VL_SHARED_ORDERS,
21  VL_STATION_LIST,
22  VL_DEPOT_LIST,
23  VL_GROUP_LIST,
24  VLT_END
25 };
26 
32  uint32_t index;
33 
34  uint32_t Pack() const;
35  bool UnpackIfValid(uint32_t data);
36  static VehicleListIdentifier UnPack(uint32_t data);
37 
38  bool Valid() const { return this->type < VLT_END; }
39 
49 
50  VehicleListIdentifier() : type(), vtype(), company(), index() {}
51 };
52 
54 typedef std::vector<const Vehicle *> VehicleList;
55 
56 bool GenerateVehicleSortList(VehicleList *list, const VehicleListIdentifier &identifier);
57 void BuildDepotVehicleList(VehicleType type, TileIndex tile, VehicleList *engine_list, VehicleList *wagon_list, bool individual_wagons = false);
58 uint GetUnitNumberDigits(VehicleList &vehicles);
59 
60 #endif /* VEHICLELIST_H */
Types related to companies.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
The information about a vehicle list.
Definition: vehiclelist.h:28
VehicleListType type
The type of vehicle list.
Definition: vehiclelist.h:29
CompanyID company
The company associated with this list.
Definition: vehiclelist.h:31
uint32_t Pack() const
Pack a VehicleListIdentifier in a single uint32.
Definition: vehiclelist.cpp:23
VehicleType vtype
The vehicle type associated with this list.
Definition: vehiclelist.h:30
static VehicleListIdentifier UnPack(uint32_t data)
Decode a packed vehicle list identifier into a new one.
Definition: vehiclelist.cpp:55
VehicleListIdentifier(VehicleListType type, VehicleType vtype, CompanyID company, uint index=0)
Create a simple vehicle list.
Definition: vehiclelist.h:47
uint32_t index
A vehicle list type specific index.
Definition: vehiclelist.h:32
bool UnpackIfValid(uint32_t data)
Unpack a VehicleListIdentifier from a single uint32.
Definition: vehiclelist.cpp:40
Types related to tiles.
Types related to vehicles.
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
uint GetUnitNumberDigits(VehicleList &vehicles)
Get the number of digits the biggest unit number of a set of vehicles has.
std::vector< const Vehicle * > VehicleList
A list of vehicles.
Definition: vehiclelist.h:54
void BuildDepotVehicleList(VehicleType type, TileIndex tile, VehicleList *engine_list, VehicleList *wagon_list, bool individual_wagons=false)
Generate a list of vehicles inside a depot.
bool GenerateVehicleSortList(VehicleList *list, const VehicleListIdentifier &identifier)
Generate a list of vehicles based on window type.
VehicleListType
Vehicle List type flags.
Definition: vehiclelist.h:18