VehicleListIdentifier Struct Reference

The information about a vehicle list. More...

#include <vehiclelist.h>

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

Static Public Member Functions
static VehicleListIdentifier	UnPack (uint32_t data)
	Decode a packed vehicle list identifier into a new one.

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_t	index
	A vehicle list type specific index.

Detailed Description

The information about a vehicle list.

Definition at line 28 of file vehiclelist.h.

Constructor & Destructor Documentation

VehicleListIdentifier() [1/2]

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

inline

Create a simple vehicle list.

Parameters

type	List type.
vtype	Vehicle type associated with this list.
company	Company associated with this list.
index	Optional type specific index.

Definition at line 47 of file vehiclelist.h.

VehicleListIdentifier() [2/2]

VehicleListIdentifier::VehicleListIdentifier ( )

inline

Definition at line 50 of file vehiclelist.h.

Member Function Documentation

Pack()

uint32_t VehicleListIdentifier::Pack

(

)

const

Pack a VehicleListIdentifier in a single uint32.

Returns

The packed identifier.

Definition at line 23 of file vehiclelist.cpp.

References company, index, OWNER_NONE, type, and vtype.

Referenced by CmdAlterGroup(), CmdRemoveAllVehiclesGroup(), CmdRenameDepot(), CmdSetGroupFlag(), VehicleListWindow::OnInvalidateData(), Vehicle::RemoveFromShared(), and ShowCompanyGroup().

UnPack()

VehicleListIdentifier VehicleListIdentifier::UnPack ( uint32_t  data )

static

Decode a packed vehicle list identifier into a new one.

Parameters

data	The data to unpack.

Definition at line 55 of file vehiclelist.cpp.

References UnpackIfValid().

Referenced by VehicleListWindow::OnClick().

UnpackIfValid()

bool VehicleListIdentifier::UnpackIfValid

(

uint32_t

data

)

Unpack a VehicleListIdentifier from a single uint32.

Parameters

data	The data to unpack.

Returns

true iff the data was valid (enough).

Definition at line 40 of file vehiclelist.cpp.

References company, GB(), index, OWNER_NONE, type, and vtype.

Referenced by UnPack().

Valid()

bool VehicleListIdentifier::Valid ( ) const

inline

Definition at line 38 of file vehiclelist.h.

Field Documentation

company

CompanyID VehicleListIdentifier::company

The company associated with this list.

Definition at line 31 of file vehiclelist.h.

Referenced by VehicleGroupWindow::ComputeGroupInfoSize(), VehicleGroupWindow::DrawGroupInfo(), GenerateVehicleSortList(), VehicleGroupWindow::OnPaint(), Pack(), VehicleGroupWindow::SetStringParameters(), and UnpackIfValid().

index

uint32_t VehicleListIdentifier::index

A vehicle list type specific index.

Definition at line 32 of file vehiclelist.h.

Referenced by VehicleGroupWindow::DrawGroupInfo(), VehicleGroupWindow::DrawWidget(), GenerateVehicleSortList(), VehicleGroupWindow::OnClick(), VehicleGroupWindow::OnDropdownSelect(), VehicleListWindow::OnGameTick(), VehicleGroupWindow::OnInvalidateData(), VehicleListWindow::OnInvalidateData(), VehicleGroupWindow::OnPaint(), Pack(), VehicleGroupWindow::SelectGroup(), VehicleGroupWindow::SetStringParameters(), VehicleListWindow::SetStringParameters(), and UnpackIfValid().

type

VehicleListType VehicleListIdentifier::type

The type of vehicle list.

Definition at line 29 of file vehiclelist.h.

Referenced by GenerateVehicleSortList(), VehicleListWindow::OnClick(), VehicleListWindow::OnGameTick(), VehicleListWindow::OnInvalidateData(), VehicleListWindow::OnPaint(), Pack(), VehicleListWindow::SetStringParameters(), UnpackIfValid(), and VehicleListWindow::UpdateWidgetSize().

vtype

VehicleType VehicleListIdentifier::vtype

The vehicle type associated with this list.

Definition at line 30 of file vehiclelist.h.

Referenced by BaseVehicleListWindow::BuildActionDropdownList(), VehicleGroupWindow::BuildGroupList(), CmdMassStartStopVehicle(), VehicleGroupWindow::ComputeGroupInfoSize(), VehicleGroupWindow::DrawGroupInfo(), BaseVehicleListWindow::DrawVehicleListItems(), GenerateVehicleSortList(), BaseVehicleListWindow::GetActionDropdownSize(), VehicleGroupWindow::OnClick(), VehicleListWindow::OnClick(), VehicleGroupWindow::OnDropdownSelect(), VehicleListWindow::OnDropdownSelect(), VehicleListWindow::OnGameTick(), VehicleGroupWindow::OnPaint(), Pack(), VehicleGroupWindow::SetStringParameters(), VehicleListWindow::SetStringParameters(), UnpackIfValid(), VehicleGroupWindow::UpdateWidgetSize(), and VehicleListWindow::UpdateWidgetSize().

---

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

• src/vehiclelist.h
• src/vehiclelist.cpp