OpenTTD Source: src/vehiclelist.h Source File

OpenTTD Source 13.1

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