OpenTTD
Public Member Functions | Static Public Member Functions | Data Fields
VehicleListIdentifier Struct Reference

The information about a vehicle list. More...

#include <vehiclelist.h>

Public Member Functions

uint32 Pack () const
 Pack a VehicleListIdentifier in a single uint32. More...
 
bool UnpackIfValid (uint32 data)
 Unpack a VehicleListIdentifier from a single uint32. More...
 
 VehicleListIdentifier (VehicleListType type, VehicleType vtype, CompanyID company, uint index=0)
 Create a simple vehicle list. More...
 

Static Public Member Functions

static VehicleListIdentifier UnPack (uint32 data)
 Decode a packed vehicle list identifier into a new one. More...
 

Data Fields

VehicleListType type
 The type of vehicle list.
 
VehicleType vtype
 The vehicle type associated with this list.
 
CompanyID company
 The company associated with this list.
 
uint32 index
 A vehicle list type specific index.
 

Detailed Description

The information about a vehicle list.

Definition at line 31 of file vehiclelist.h.

Constructor & Destructor Documentation

◆ VehicleListIdentifier()

VehicleListIdentifier::VehicleListIdentifier ( VehicleListType  type,
VehicleType  vtype,
CompanyID  company,
uint  index = 0 
)
inline

Create a simple vehicle list.

Parameters
typeList type.
vtypeVehicle type associated with this list.
companyCompany associated with this list.
indexOptional type specific index.

Definition at line 48 of file vehiclelist.h.

References company, index, type, and vtype.

Member Function Documentation

◆ Pack()

uint32 VehicleListIdentifier::Pack ( ) const

Pack a VehicleListIdentifier in a single uint32.

Returns
The packed identifier.

Definition at line 23 of file vehiclelist.cpp.

References company, and OWNER_NONE.

◆ UnPack()

VehicleListIdentifier VehicleListIdentifier::UnPack ( uint32  data)
static

Decode a packed vehicle list identifier into a new one.

Parameters
dataThe data to unpack.

Definition at line 55 of file vehiclelist.cpp.

References UnpackIfValid().

◆ UnpackIfValid()

bool VehicleListIdentifier::UnpackIfValid ( uint32  data)

Unpack a VehicleListIdentifier from a single uint32.

Parameters
dataThe data to unpack.
Returns
true iff the data was valid (enough).

Definition at line 40 of file vehiclelist.cpp.

References company, GB(), and OWNER_NONE.

Referenced by CmdMassStartStopVehicle(), CmdSendVehicleToDepot(), and UnPack().


The documentation for this struct was generated from the following files: