vehiclelist.h File Reference

Functions and type for generating vehicle lists. More...

#include "company_type.h"
#include "group_type.h"
#include "order_type.h"
#include "station_type.h"
#include "tile_type.h"
#include "vehicle_type.h"
#include "window_type.h"

Go to the source code of this file.

Data Structures
struct	VehicleListIdentifier
	The information about a vehicle list. More...

Typedefs
typedef std::vector< const Vehicle * >	VehicleList
	A list of vehicles.

Enumerations
enum	VehicleListType : uint8_t {   VL_STANDARD , VL_SHARED_ORDERS , VL_STATION_LIST , VL_DEPOT_LIST ,   VL_GROUP_LIST , VLT_END }
	Vehicle List type flags. More...

Functions
bool	GenerateVehicleSortList (VehicleList *list, const VehicleListIdentifier &identifier)
	Generate a list of vehicles based on window type.
void	BuildDepotVehicleList (VehicleType type, TileIndex tile, VehicleList *engine_list, VehicleList *wagon_list, bool individual_wagons=false)
	Generate a list of vehicles inside a depot.
uint	GetUnitNumberDigits (VehicleList &vehicles)
	Get the number of digits the biggest unit number of a set of vehicles has.

Detailed Description

Functions and type for generating vehicle lists.

Definition in file vehiclelist.h.

Typedef Documentation

VehicleList

typedef std::vector<const Vehicle *> VehicleList

A list of vehicles.

Definition at line 68 of file vehiclelist.h.

Enumeration Type Documentation

VehicleListType

enum VehicleListType : uint8_t

Vehicle List type flags.

Enumerator
VL_STANDARD	Index is the company.
VL_SHARED_ORDERS	Index is the first vehicle of the shared orders.
VL_STATION_LIST	Index is the station.
VL_DEPOT_LIST	Index is the destination (station for hangar of aircraft, depot for others)
VL_GROUP_LIST	Index is the group.

Definition at line 22 of file vehiclelist.h.

Function Documentation

BuildDepotVehicleList()

void BuildDepotVehicleList	(	VehicleType	type,
		TileIndex	tile,
		VehicleList *	engines,
		VehicleList *	wagons,
		bool	individual_wagons
	)

Generate a list of vehicles inside a depot.

Parameters

type	Type of vehicle
tile	The tile the depot is located on
engines	Pointer to list to add vehicles to
wagons	Pointer to list to add wagons to (can be nullptr)
individual_wagons	If true add every wagon to wagons which is not attached to an engine. If false only add the first wagon of every row.

Definition at line 76 of file vehiclelist.cpp.

References BuildDepotVehicleListProc(), and FindVehicleOnPos().

Referenced by CmdDepotMassAutoReplace(), CmdDepotSellAllVehicles(), and CmdMassStartStopVehicle().

GenerateVehicleSortList()

bool GenerateVehicleSortList	(	VehicleList *	list,
		const VehicleListIdentifier &	vli
	)

Generate a list of vehicles based on window type.

Parameters

list	Pointer to list to add vehicles to
vli	The identifier of this vehicle list.

Returns

false if invalid list is requested

Definition at line 91 of file vehiclelist.cpp.

References ALL_GROUP, VehicleListIdentifier::company, FindVehiclesWithOrder(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::group_id, GroupIsInGroup(), Vehicle::IsPrimaryVehicle(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_vehicle_pool >::Iterate(), Vehicle::NextShared(), ODATFB_NEAREST_DEPOT, Vehicle::owner, BaseVehicle::type, VehicleListIdentifier::type, VL_DEPOT_LIST, VL_GROUP_LIST, VL_SHARED_ORDERS, VL_STANDARD, VL_STATION_LIST, and VehicleListIdentifier::vtype.

Referenced by CmdAddVehicleGroup(), CmdMassStartStopVehicle(), and SendAllVehiclesToDepot().

GetUnitNumberDigits()

uint GetUnitNumberDigits

(

VehicleList &

vehicles

)

Get the number of digits the biggest unit number of a set of vehicles has.

Parameters

vehicles

The list of vehicles.

Returns

The number of digits to allocate space for.

Definition at line 208 of file vehicle_gui.cpp.

References CountDigitsForAllocatingSpace().

Referenced by DepotWindow::OnPaint().