Vehicle data structure. More...

#include <vehicle_base.h>

Inheritance diagram for Vehicle:

Data Structures
struct	IterateWrapper
	Iterable ensemble of orders. More...

struct	OrderIterator
	Iterator to iterate orders Supports deletion of current order. More...

Public Member Functions
virtual uint16_t	GetMaxWeight () const
	Calculates the weight value that this vehicle will have when fully loaded with its current cargo. More...

	Vehicle (VehicleType type=VEH_INVALID)
	Vehicle constructor. More...

void	PreDestructor ()
	Destroy all stuff that (still) needs the virtual functions to work properly.

virtual	~Vehicle ()
	We want to 'destruct' the right class.

void	BeginLoading ()
	Prepare everything to begin the loading when arriving at a station. More...

void	CancelReservation (StationID next, Station *st)
	Return all reserved cargo packets to the station and reset all packets staged for transfer. More...

void	LeaveStation ()
	Perform all actions when leaving a station. More...

GroundVehicleCache *	GetGroundVehicleCache ()
	Access the ground vehicle cache of the vehicle. More...

const GroundVehicleCache *	GetGroundVehicleCache () const

uint16_t &	GetGroundVehicleFlags ()
	Access the ground vehicle flags of the vehicle. More...

const uint16_t &	GetGroundVehicleFlags () const

void	DeleteUnreachedImplicitOrders ()
	Delete all implicit orders which were not reached.

void	HandleLoading (bool mode=false)
	Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all other cases. More...

virtual void	MarkDirty ()
	Marks the vehicles to be redrawn and updates cached variables. More...

virtual void	UpdateDeltaXY ()
	Updates the x and y offsets and the size of the sprite used for this vehicle.

uint	GetOldAdvanceSpeed (uint speed)
	Determines the effective direction-specific vehicle movement speed. More...

uint	GetAdvanceDistance ()
	Determines the vehicle "progress" needed for moving a step. More...

virtual ExpensesType	GetExpenseType ([[maybe_unused]] bool income) const
	Sets the expense type associated to this vehicle type. More...

virtual void	PlayLeaveStationSound ([[maybe_unused]] bool force=false) const
	Play the sound associated with leaving the station. More...

virtual bool	IsPrimaryVehicle () const
	Whether this is the primary vehicle in the chain.

const Engine *	GetEngine () const
	Retrieves the engine of the vehicle. More...

virtual void	GetImage ([[maybe_unused]] Direction direction, [[maybe_unused]] EngineImageType image_type, [[maybe_unused]] VehicleSpriteSeq *result) const
	Gets the sprite to show for the given direction. More...

const GRFFile *	GetGRF () const
	Retrieve the NewGRF the vehicle is tied to. More...

uint32_t	GetGRFID () const
	Retrieve the GRF ID of the NewGRF the vehicle is tied to. More...

void	InvalidateNewGRFCache ()
	Invalidates cached NewGRF variables. More...

void	InvalidateNewGRFCacheOfChain ()
	Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle) More...

debug_inline bool	IsGroundVehicle () const
	Check if the vehicle is a ground vehicle. More...

virtual int	GetDisplaySpeed () const
	Gets the speed in km-ish/h that can be sent into SetDParam for string processing. More...

virtual int	GetDisplayMaxSpeed () const
	Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing. More...

virtual int	GetCurrentMaxSpeed () const
	Calculates the maximum speed of the vehicle under its current conditions. More...

virtual Money	GetRunningCost () const
	Gets the running cost of a vehicle. More...

virtual bool	IsInDepot () const
	Check whether the vehicle is in the depot. More...

virtual bool	IsChainInDepot () const
	Check whether the whole vehicle chain is in the depot. More...

bool	IsStoppedInDepot () const
	Check whether the vehicle is in the depot and stopped. More...

virtual bool	Tick ()
	Calls the tick handler of the vehicle. More...

virtual void	OnNewCalendarDay ()
	Calls the new calendar day handler of the vehicle.

virtual void	OnNewEconomyDay ()
	Calls the new economy day handler of the vehicle.

void	ShiftDates (TimerGameEconomy::Date interval)
	Shift all dates by given interval. More...

virtual uint	Crash (bool flooded=false)
	Crash the (whole) vehicle chain. More...

virtual Trackdir	GetVehicleTrackdir () const
	Returns the Trackdir on which the vehicle is currently located. More...

Money	GetDisplayRunningCost () const
	Gets the running cost of a vehicle that can be sent into SetDParam for string processing. More...

Money	GetDisplayProfitThisYear () const
	Gets the profit vehicle had this year. More...

Money	GetDisplayProfitLastYear () const
	Gets the profit vehicle had last year. More...

void	SetNext (Vehicle *next)
	Set the next vehicle of this vehicle. More...

Vehicle *	Next () const
	Get the next vehicle of this vehicle. More...

Vehicle *	Previous () const
	Get the previous vehicle of this vehicle. More...

Vehicle *	First () const
	Get the first vehicle of this vehicle chain. More...

Vehicle *	Last ()
	Get the last vehicle of this vehicle chain. More...

const Vehicle *	Last () const
	Get the last vehicle of this vehicle chain. More...

Vehicle *	Move (int n)
	Get the vehicle at offset n of this vehicle chain. More...

const Vehicle *	Move (int n) const
	Get the vehicle at offset n of this vehicle chain. More...

Order *	GetFirstOrder () const
	Get the first order of the vehicles order list. More...

void	AddToShared (Vehicle *shared_chain)
	Adds this vehicle to a shared vehicle chain. More...

void	RemoveFromShared ()
	Removes the vehicle from the shared order list.

Vehicle *	NextShared () const
	Get the next vehicle of the shared vehicle chain. More...

Vehicle *	PreviousShared () const
	Get the previous vehicle of the shared vehicle chain. More...

Vehicle *	FirstShared () const
	Get the first vehicle of this vehicle chain. More...

bool	IsOrderListShared () const
	Check if we share our orders with another vehicle. More...

VehicleOrderID	GetNumOrders () const
	Get the number of orders this vehicle has. More...

VehicleOrderID	GetNumManualOrders () const
	Get the number of manually added orders this vehicle has. More...

StationIDStack	GetNextStoppingStation () const
	Get the next station the vehicle will stop at. More...

void	ResetRefitCaps ()
	Reset all refit_cap in the consist to cargo_cap.

void	ReleaseUnitNumber ()
	Release the vehicle's unit number.

void	CopyVehicleConfigAndStatistics (Vehicle *src)
	Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The function shall copy everything that cannot be copied by a command (like orders / group etc), and that shall not be resetted for the new vehicle. More...

bool	HandleBreakdown ()
	Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate. More...

bool	NeedsAutorenewing (const Company *c, bool use_renew_setting=true) const
	Function to tell if a vehicle needs to be autorenewed. More...

bool	NeedsServicing () const
	Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for service or replacement. More...

bool	NeedsAutomaticServicing () const
	Checks if the current order should be interrupted for a service-in-depot order. More...

virtual TileIndex	GetOrderStationLocation ([[maybe_unused]] StationID station)
	Determine the location for the station where the vehicle goes to next. More...

virtual TileIndex	GetCargoTile () const

virtual ClosestDepot	FindClosestDepot ()
	Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse. More...

virtual void	SetDestTile (TileIndex tile)

CommandCost	SendToDepot (DoCommandFlag flags, DepotCommand command)
	Send this vehicle to the depot using the given command(s). More...

void	UpdateVisualEffect (bool allow_power_change=true)
	Update the cached visual effect. More...

void	ShowVisualEffect () const
	Draw visual effects (smoke and/or sparks) for a vehicle chain. More...

void	UpdatePosition ()
	Update the position of the vehicle. More...

void	UpdateViewport (bool dirty)
	Update the vehicle on the viewport, updating the right hash and setting the new coordinates. More...

void	UpdateBoundingBoxCoordinates (bool update_cache) const
	Update the bounding box co-ordinates of the vehicle. More...

void	UpdatePositionAndViewport ()
	Update the position of the vehicle, and update the viewport.

bool	MarkAllViewportsDirty () const
	Marks viewports dirty where the vehicle's image is. More...

uint16_t	GetServiceInterval () const

void	SetServiceInterval (uint16_t interval)

bool	ServiceIntervalIsCustom () const

bool	ServiceIntervalIsPercent () const

void	SetServiceIntervalIsCustom (bool on)

void	SetServiceIntervalIsPercent (bool on)

bool	HasFullLoadOrder () const
	Check if the current vehicle has a full load order. More...

bool	HasConditionalOrder () const
	Check if the current vehicle has a conditional order. More...

bool	HasUnbunchingOrder () const
	Check if the current vehicle has an unbunching order. More...

void	LeaveUnbunchingDepot ()
	Leave an unbunching depot and calculate the next departure time for shared order vehicles.

bool	IsWaitingForUnbunching () const
	Check whether a vehicle inside a depot is waiting for unbunching. More...

void	IncrementImplicitOrderIndex ()
	Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI. More...

void	IncrementRealOrderIndex ()
	Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates the GUI. More...

void	UpdateRealOrderIndex ()
	Skip implicit orders until cur_real_order_index is a non-implicit order.

Order *	GetOrder (int index) const
	Returns order 'index' of a vehicle or nullptr when it doesn't exists. More...

Order *	GetLastOrder () const
	Returns the last order of a vehicle, or nullptr if it doesn't exists. More...

bool	IsEngineCountable () const
	Check if a vehicle is counted in num_engines in each company struct. More...

bool	HasEngineType () const
	Check whether Vehicle::engine_type has any meaning. More...

bool	HasDepotOrder () const
	Checks if a vehicle has a depot in its order list. More...

void	HandlePathfindingResult (bool path_found)
	Handle the pathfinding result, especially the lost status. More...

debug_inline bool	IsFrontEngine () const
	Check if the vehicle is a front engine. More...

bool	IsArticulatedPart () const
	Check if the vehicle is an articulated part of an engine. More...

bool	HasArticulatedPart () const
	Check if an engine has an articulated part. More...

Vehicle *	GetNextArticulatedPart () const
	Get the next part of an articulated engine. More...

Vehicle *	GetFirstEnginePart ()
	Get the first part of an articulated engine. More...

const Vehicle *	GetFirstEnginePart () const
	Get the first part of an articulated engine. More...

Vehicle *	GetLastEnginePart ()
	Get the last part of an articulated engine. More...

Vehicle *	GetNextVehicle () const
	Get the next real (non-articulated part) vehicle in the consist. More...

Vehicle *	GetPrevVehicle () const
	Get the previous real (non-articulated part) vehicle in the consist. More...

IterateWrapper	Orders () const
	Returns an iterable ensemble of orders of a vehicle. More...

uint32_t	GetDisplayMaxWeight () const
	Calculates the maximum weight of the ground vehicle when loaded. More...

uint32_t	GetDisplayMinPowerToWeight () const
	Calculates the minimum power-to-weight ratio using the maximum weight of the ground vehicle. More...

Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
void *	operator new (size_t size)
	Allocates space for new Titem. More...

void *	operator new (size_t size, size_t index)
	Allocates space for new Titem with given index. More...

void *	operator new (size_t, void *ptr)
	Allocates space for new Titem at given memory address. More...

void	operator delete (void *p)
	Marks Titem as free. More...

Public Member Functions inherited from BaseConsist
void	CopyConsistPropertiesFrom (const BaseConsist *src)
	Copy properties of other BaseConsist. More...

void	ResetDepotUnbunching ()
	Resets all the data used for depot unbunching.

Static Public Member Functions
static uint	GetAdvanceSpeed (uint speed)
	Determines the effective vehicle movement speed. More...

Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
static bool	CanAllocateItem (size_t n=1)
	Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...

static bool	CleaningPool ()
	Returns current state of pool cleaning - yes or no. More...

static bool	IsValidID (size_t index)
	Tests whether given index can be used to get valid (non-nullptr) Titem. More...

static Titem *	Get (size_t index)
	Returns Titem with given index. More...

static Titem *	GetIfValid (size_t index)
	Returns Titem with given index. More...

static size_t	GetPoolSize ()
	Returns first unused index. More...

static size_t	GetNumItems ()
	Returns number of valid items in the pool. More...

static void	PostDestructor ([[maybe_unused]] size_t index)
	Dummy function called after destructor of each member. More...

static Pool::IterateWrapper< Titem >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid Titem. More...

Data Fields
TileIndex	tile
	Current tile index.

TileIndex	dest_tile
	Heading for this tile. More...

Money	profit_this_year
	Profit this year << 8, low 8 bits are fract.

Money	profit_last_year
	Profit last year << 8, low 8 bits are fract.

Money	value
	Value of the vehicle.

CargoPayment *	cargo_payment
	The cargo payment we're currently in.

Rect	coord
	NOSAVE: Graphical bounding box of the vehicle, i.e. what to redraw on moves.

Vehicle *	hash_viewport_next
	NOSAVE: Next vehicle in the visual location hash.

Vehicle **	hash_viewport_prev
	NOSAVE: Previous vehicle in the visual location hash.

Vehicle *	hash_tile_next
	NOSAVE: Next vehicle in the tile location hash.

Vehicle **	hash_tile_prev
	NOSAVE: Previous vehicle in the tile location hash.

Vehicle **	hash_tile_current
	NOSAVE: Cache of the current hash chain.

SpriteID	colourmap
	NOSAVE: cached colour mapping.

TimerGameCalendar::Year	build_year
	Year the vehicle has been built.

TimerGameCalendar::Date	age
	Age in calendar days.

TimerGameEconomy::Date	economy_age
	Age in economy days.

TimerGameCalendar::Date	max_age
	Maximum age.

TimerGameEconomy::Date	date_of_last_service
	Last economy date the vehicle had a service at a depot.

TimerGameCalendar::Date	date_of_last_service_newgrf
	Last calendar date the vehicle had a service at a depot, unchanged by the date cheat to protect against unsafe NewGRF behavior.

uint16_t	reliability
	Reliability.

uint16_t	reliability_spd_dec
	Reliability decrease speed.

uint8_t	breakdown_ctr
	Counter for managing breakdown events. More...

uint8_t	breakdown_delay
	Counter for managing breakdown length.

uint8_t	breakdowns_since_last_service
	Counter for the amount of breakdowns.

uint8_t	breakdown_chance
	Current chance of breakdowns.

int32_t	x_pos
	x coordinate.

int32_t	y_pos
	y coordinate.

int32_t	z_pos
	z coordinate.

Direction	direction
	facing

Owner	owner
	Which company owns the vehicle?

uint8_t	spritenum
	currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == reserved for another custom sprite

uint8_t	x_extent
	x-extent of vehicle bounding box

uint8_t	y_extent
	y-extent of vehicle bounding box

uint8_t	z_extent
	z-extent of vehicle bounding box

int8_t	x_bb_offs
	x offset of vehicle bounding box

int8_t	y_bb_offs
	y offset of vehicle bounding box

int8_t	x_offs
	x offset for vehicle sprite

int8_t	y_offs
	y offset for vehicle sprite

EngineID	engine_type
	The type of engine used for this vehicle.

TextEffectID	fill_percent_te_id
	a text-effect id to a loading indicator object

UnitID	unitnumber
	unit number, for display purposes only

uint16_t	cur_speed
	current speed

uint8_t	subspeed
	fractional speed

uint8_t	acceleration
	used by train & aircraft

uint32_t	motion_counter
	counter to occasionally play a vehicle sound.

uint8_t	progress
	The percentage (if divided by 256) this vehicle already crossed the tile unit.

uint8_t	waiting_triggers
	Triggers to be yet matched before rerandomizing the random bits.

uint16_t	random_bits
	Bits used for randomized variational spritegroups.

StationID	last_station_visited
	The last station we stopped at.

StationID	last_loading_station
	Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.

TimerGameTick::TickCounter	last_loading_tick
	Last TimerGameTick::counter tick that the vehicle has stopped at a station and could possibly leave with any cargo loaded.

VehicleCargoList	cargo
	The cargo this vehicle is carrying.

CargoID	cargo_type
	type of cargo this vehicle is carrying

uint8_t	cargo_subtype
	Used for livery refits (NewGRF variations)

uint16_t	cargo_cap
	total capacity

uint16_t	refit_cap
	Capacity left over from before last refit.

uint16_t	cargo_age_counter
	Ticks till cargo is aged next.

int8_t	trip_occupancy
	NOSAVE: Occupancy of vehicle of the current trip (updated after leaving a station).

uint8_t	day_counter
	Increased by one for each day.

uint8_t	tick_counter
	Increased by one for each tick.

uint8_t	running_ticks
	Number of ticks this vehicle was not stopped this day.

uint16_t	load_unload_ticks
	Ticks to wait before starting next cycle.

uint8_t	vehstatus
	Status.

uint8_t	subtype
	subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubtypeFlags)

Order	current_order
	The current order (+ status, like: loading)

union {
OrderList * orders
	Pointer to the order list for this vehicle.

Order * old_orders
	Only used during conversion of old save games.

};

NewGRFCache	grf_cache
	Cache of often used calculated NewGRF values.

VehicleCache	vcache
	Cache of often used vehicle values.

GroupID	group_id
	Index of group Pool array.

MutableSpriteCache	sprite_cache
	Cache of sprites and values related to recalculating them, see MutableSpriteCache.

Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
Tindex	index
	Index of this pool item.

Data Fields inherited from BaseVehicle
VehicleType	type
	Type of vehicle.

Data Fields inherited from BaseConsist
std::string	name
	Name of vehicle.

TimerGameTick::Ticks	current_order_time
	How many ticks have passed since this order started.

TimerGameTick::Ticks	lateness_counter
	How many ticks late (or early if negative) this vehicle is.

TimerGameTick::TickCounter	timetable_start
	At what tick of TimerGameTick::counter the vehicle should start its timetable.

TimerGameTick::TickCounter	depot_unbunching_last_departure
	When the vehicle last left its unbunching depot.

TimerGameTick::TickCounter	depot_unbunching_next_departure
	When the vehicle will next try to leave its unbunching depot.

TimerGameTick::Ticks	round_trip_time
	How many ticks for a single circumnavigation of the orders.

uint16_t	service_interval
	The interval for (automatic) servicing; either in days or %.

VehicleOrderID	cur_real_order_index
	The index to the current real (non-implicit) order.

VehicleOrderID	cur_implicit_order_index
	The index to the current implicit order.

uint16_t	vehicle_flags
	Used for gradual loading and other miscellaneous things (. More...

Private Types
typedef std::list< RefitDesc >	RefitList

Private Member Functions
void	SkipToNextRealOrderIndex ()
	Advance cur_real_order_index to the next real order. More...

Private Attributes
Vehicle *	next
	pointer to the next vehicle in the chain

Vehicle *	previous
	NOSAVE: pointer to the previous vehicle in the chain.

Vehicle *	first
	NOSAVE: pointer to the first vehicle in the chain.

Vehicle *	next_shared
	pointer to the next vehicle that shares the order

Vehicle *	previous_shared
	NOSAVE: pointer to the previous vehicle in the shared order chain.

Friends
class	SlVehicleCommon

class	SlVehicleDisaster

void	FixOldVehicles ()
	Convert the old style vehicles into something that resembles the old new style savegames. More...

void	AfterLoadVehicles (bool part_of_load)
	So we can set the previous and first pointers while loading. More...

bool	LoadOldVehicle (LoadgameState *ls, int num)
	So we can set the proper next pointer while loading. More...

void	Ptrs_VEHS ()

Additional Inherited Members
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >	Pool
	Type of the pool this item is going to be part of.

Detailed Description

Vehicle data structure.

Definition at line 244 of file vehicle_base.h.

Constructor & Destructor Documentation

◆ Vehicle()

Vehicle::Vehicle ( VehicleType type = VEH_INVALID )

Vehicle constructor.

Parameters

type	Type of the new vehicle.

Definition at line 361 of file vehicle.cpp.

References coord, DEFAULT_GROUP, fill_percent_te_id, group_id, INVALID_COORD, MutableSpriteCache::old_coord, sprite_cache, and BaseVehicle::type.

Member Function Documentation

◆ AddToShared()

void Vehicle::AddToShared ( Vehicle * shared_chain )

Adds this vehicle to a shared vehicle chain.

Parameters

shared_chain a vehicle of the chain with shared vehicles.

Precondition: !this->IsOrderListShared()

Definition at line 2966 of file vehicle.cpp.

References OrderList::AddVehicle(), next_shared, orders, and previous_shared.

Referenced by CmdSellRailWagon().

◆ BeginLoading()

void Vehicle::BeginLoading ( )

Prepare everything to begin the loading when arriving at a station.

Precondition: IsTileType(this->tile, MP_STATION) || this->type == VEH_SHIP.

Definition at line 2203 of file vehicle.cpp.

References TimerGameTick::counter, current_order, IsTileType(), Order::IsType(), last_loading_tick, MP_STATION, tile, BaseVehicle::type, and VEH_SHIP.

Referenced by TrainEnterStation().

◆ CancelReservation()

void Vehicle::CancelReservation	(	StationID	next,
		Station *	st
	)

Return all reserved cargo packets to the station and reset all packets staged for transfer.

Parameters

st	the station where the reserved packets should go.

Definition at line 2334 of file vehicle.cpp.

References VehicleCargoList::ActionCount(), GoodsEntry::cargo, cargo, cargo_type, Debug, Station::goods, VehicleCargoList::KeepAll(), CargoList< VehicleCargoList, CargoPacketList >::MTA_LOAD, next, VehicleCargoList::Return(), and tile.

Referenced by PreDestructor().

◆ CopyVehicleConfigAndStatistics()

void Vehicle::CopyVehicleConfigAndStatistics ( Vehicle * src )

inline

Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The function shall copy everything that cannot be copied by a command (like orders / group etc), and that shall not be resetted for the new vehicle.

Parameters

src	The old vehicle

Definition at line 765 of file vehicle_base.h.

References BaseConsist::CopyConsistPropertiesFrom(), current_order, dest_tile, profit_last_year, profit_this_year, ReleaseUnitNumber(), and unitnumber.

Referenced by CmdSellRailWagon().

◆ Crash()

uint Vehicle::Crash ( bool flooded = false )

virtual

Crash the (whole) vehicle chain.

Parameters

flooded whether the cause of the crash is flooding or not.

Returns: the number of lost souls.

Reimplemented in RoadVehicle, Train, Aircraft, GroundVehicle< T, Type >, GroundVehicle< Train, VEH_TRAIN >, and GroundVehicle< RoadVehicle, VEH_ROAD >.

Definition at line 280 of file vehicle.cpp.

References cargo_payment, CC_PASSENGERS, GetWindowClassForVehicleType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, InvalidateWindowClassesData(), IsCargoInClass(), IsPrimaryVehicle(), Next(), Previous(), RandomRange(), SetWindowDirty(), SetWindowWidgetDirty(), tile, BaseVehicle::type, vehstatus, VS_CRASHED, VS_STOPPED, WC_VEHICLE_DEPOT, WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW, and WID_VV_START_STOP.

Referenced by Aircraft::Crash(), and FloodVehicle().

◆ FindClosestDepot()

virtual ClosestDepot Vehicle::FindClosestDepot ( )

inlinevirtual

Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse.

Returns: A structure with information about the closest depot, if found.

Reimplemented in RoadVehicle, Train, Aircraft, and Ship.

Definition at line 805 of file vehicle_base.h.

◆ First()

Vehicle* Vehicle::First ( ) const

inline

Get the first vehicle of this vehicle chain.

Returns: the first vehicle of the chain.

Definition at line 645 of file vehicle_base.h.

References first.

Referenced by RefitWindow::BuildRefitList(), CheckCargoCapacity(), CmdRefitVehicle(), CmdSellVehicle(), NewGRFInspectWindow::DrawVehicleChainWidget(), FirstShared(), FloodVehicleProc(), GetIncompatibleRefitOrderIdForAutoreplace(), IsStoppedInDepot(), PositionHelper(), RefitVehicle(), VehicleResolverObject::ResolveReal(), VehicleEnterDepot(), and VerifyAutoreplaceRefitForOrders().

◆ FirstShared()

Vehicle* Vehicle::FirstShared ( ) const

inline

Get the first vehicle of this vehicle chain.

Returns: the first vehicle of the chain.

Definition at line 726 of file vehicle_base.h.

References First(), OrderList::GetFirstSharedVehicle(), and orders.

Referenced by CheckOrders(), OrderBackup::ClearVehicle(), CmdAddSharedVehicleGroup(), CmdAutofillTimetable(), CmdMoveOrder(), CmdSetVehicleOnTime(), DeleteOrder(), InsertOrder(), LeaveUnbunchingDepot(), DepotWindow::OnVehicleSelect(), OrdersWindow::OnVehicleSelect(), OrderBackup::OrderBackup(), OrdersWindow::OrderClick_StopSharing(), and RemoveFromShared().

◆ GetAdvanceDistance()

uint Vehicle::GetAdvanceDistance ( )

inline

Determines the vehicle "progress" needed for moving a step.

Together with GetAdvanceSpeed() this function is a replacement for GetOldAdvanceSpeed().

Returns: distance to drive for a movement step on the map.

Definition at line 457 of file vehicle_base.h.

Referenced by ShipAccelerate().

◆ GetAdvanceSpeed()

static uint Vehicle::GetAdvanceSpeed ( uint speed )

inlinestatic

Determines the effective vehicle movement speed.

Together with GetAdvanceDistance() this function is a replacement for GetOldAdvanceSpeed().

A vehicle progresses independent of it's movement direction. However different amounts of "progress" are needed for moving a step in a specific direction. That way the leftover progress does not need any adaption when changing movement direction.

Parameters

speed Direction-independent unscaled speed.

Returns: speed, scaled to match GetAdvanceDistance().

Definition at line 445 of file vehicle_base.h.

Referenced by GroundVehicle< RoadVehicle, VEH_ROAD >::DoUpdateSpeed(), and ShipAccelerate().

◆ GetCurrentMaxSpeed()

virtual int Vehicle::GetCurrentMaxSpeed ( ) const

inlinevirtual

Calculates the maximum speed of the vehicle under its current conditions.

Returns: Current maximum speed in native units.

Reimplemented in RoadVehicle, Train, Aircraft, and Ship.

Definition at line 536 of file vehicle_base.h.

Referenced by ShowVisualEffect().

◆ GetDisplayMaxSpeed()

virtual int Vehicle::GetDisplayMaxSpeed ( ) const

inlinevirtual

Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.

Returns: the vehicle's maximum speed

Reimplemented in RoadVehicle, Train, Aircraft, and Ship.

Definition at line 530 of file vehicle_base.h.

◆ GetDisplayMaxWeight()

uint32_t Vehicle::GetDisplayMaxWeight ( ) const

Calculates the maximum weight of the ground vehicle when loaded.

Returns: Weight in tonnes

Definition at line 3244 of file vehicle.cpp.

References Next().

Referenced by GetDisplayMinPowerToWeight().

◆ GetDisplayMinPowerToWeight()

uint32_t Vehicle::GetDisplayMinPowerToWeight ( ) const

Calculates the minimum power-to-weight ratio using the maximum weight of the ground vehicle.

Returns: power-to-weight ratio in 10ths of hp(I) per tonne

Definition at line 3259 of file vehicle.cpp.

References GroundVehicleCache::cached_power, GetDisplayMaxWeight(), and GetGroundVehicleCache().

◆ GetDisplayProfitLastYear()

Money Vehicle::GetDisplayProfitLastYear ( ) const

inline

Gets the profit vehicle had last year.

It can be sent into SetDParam for string processing.

Returns: the vehicle's profit last year

Definition at line 623 of file vehicle_base.h.

Referenced by GroupStatistics::AddProfitLastYear(), GroupStatistics::CountVehicle(), VehicleProfitLastYearSorter(), and GroupStatistics::VehicleReachedMinAge().

◆ GetDisplayProfitThisYear()

Money Vehicle::GetDisplayProfitThisYear ( ) const

inline

Gets the profit vehicle had this year.

It can be sent into SetDParam for string processing.

Returns: the vehicle's profit this year

Definition at line 617 of file vehicle_base.h.

Referenced by VehicleProfitThisYearSorter().

◆ GetDisplayRunningCost()

Money Vehicle::GetDisplayRunningCost ( ) const

inline

Gets the running cost of a vehicle that can be sent into SetDParam for string processing.

Returns: the vehicle's running cost

Definition at line 611 of file vehicle_base.h.

References GetRunningCost().

◆ GetDisplaySpeed()

virtual int Vehicle::GetDisplaySpeed ( ) const

inlinevirtual

Gets the speed in km-ish/h that can be sent into SetDParam for string processing.

Returns: the vehicle's speed

Reimplemented in RoadVehicle, Train, Aircraft, and Ship.

Definition at line 524 of file vehicle_base.h.

◆ GetEngine()

const Engine * Vehicle::GetEngine ( ) const

Retrieves the engine of the vehicle.

Returns: Engine of the vehicle.

Precondition: HasEngineType() == true

Definition at line 747 of file vehicle.cpp.

References engine_type, and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get().

Referenced by AgeVehicle(), RefitWindow::BuildRefitList(), CheckConsistencyOfArticulatedVehicle(), GetBestFittingSubType(), GetCargoSummaryOfArticulatedVehicle(), GetGRF(), GetGRFID(), GetLoadAmount(), GetRoadVehLength(), Ship::GetRunningCost(), Aircraft::GetRunningCost(), Train::GetRunningCost(), RoadVehicle::GetRunningCost(), HandleStationRefit(), NeedsServicing(), RefitVehicle(), UpdateVisualEffect(), VehicleLengthChanged(), VehicleServiceInDepot(), and VehiclesHaveSameEngineList().

◆ GetExpenseType()

virtual ExpensesType Vehicle::GetExpenseType ( [[maybe_unused] ] bool income ) const

inlinevirtual

Sets the expense type associated to this vehicle type.

Parameters

income whether this is income or (running) expenses of the vehicle

Definition at line 466 of file vehicle_base.h.

References EXPENSES_OTHER.

Referenced by RefitVehicle().

◆ GetFirstEnginePart() [1/2]

Vehicle* Vehicle::GetFirstEnginePart ( )

inline

Get the first part of an articulated engine.

Returns: First part of the engine.

Definition at line 983 of file vehicle_base.h.

References IsArticulatedPart(), and Previous().

Referenced by GetBestFittingSubType(), and HandleStationRefit().

◆ GetFirstEnginePart() [2/2]

const Vehicle* Vehicle::GetFirstEnginePart ( ) const

inline

Get the first part of an articulated engine.

Returns: First part of the engine.

Definition at line 994 of file vehicle_base.h.

References IsArticulatedPart(), and Previous().

◆ GetFirstOrder()

Order* Vehicle::GetFirstOrder ( ) const

inline

Get the first order of the vehicles order list.

Returns: first order of order list.

Definition at line 705 of file vehicle_base.h.

References OrderList::GetFirstOrder(), and orders.

Referenced by PreviousOrderIsUnbunching(), and VehiclesHaveSameOrderList().

◆ GetGRF()

const GRFFile * Vehicle::GetGRF ( ) const

Retrieve the NewGRF the vehicle is tied to.

This is the GRF providing the Action 3 for the engine type.

Returns: NewGRF associated to the vehicle.

Definition at line 757 of file vehicle.cpp.

References GetEngine(), and Engine::GetGRF().

Referenced by PlayVehicleSound().

◆ GetGRFID()

uint32_t Vehicle::GetGRFID ( ) const

Retrieve the GRF ID of the NewGRF the vehicle is tied to.

This is the GRF providing the Action 3 for the engine type.

Returns: GRF ID of the associated NewGRF.

Definition at line 767 of file vehicle.cpp.

References GetEngine(), and Engine::GetGRFID().

◆ GetGroundVehicleCache()

const GroundVehicleCache * Vehicle::GetGroundVehicleCache ( )

Access the ground vehicle cache of the vehicle.

Precondition: The vehicle is a GroundVehicle.

Returns: GroundVehicleCache of the vehicle.

Definition at line 3155 of file vehicle.cpp.

References SpecializedVehicle< Train, Type >::From(), SpecializedVehicle< RoadVehicle, Type >::From(), GroundVehicle< T, Type >::gcache, IsGroundVehicle(), BaseVehicle::type, and VEH_TRAIN.

Referenced by GetDisplayMinPowerToWeight(), LiveryHelper(), UpdateLoadUnloadTicks(), and VehicleLengthSorter().

◆ GetGroundVehicleFlags()

const uint16_t & Vehicle::GetGroundVehicleFlags ( )

Access the ground vehicle flags of the vehicle.

Precondition: The vehicle is a GroundVehicle.

Returns: GroundVehicleFlags of the vehicle.

Definition at line 3185 of file vehicle.cpp.

◆ GetImage()

virtual void Vehicle::GetImage	(	[[maybe_unused] ] Direction	direction,
		[[maybe_unused] ] EngineImageType	image_type,
		[[maybe_unused] ] VehicleSpriteSeq *	result
	)		const

inlinevirtual

Gets the sprite to show for the given direction.

Parameters

	direction	the direction the vehicle is facing
[out]	result	Vehicle sprite sequence.

Definition at line 486 of file vehicle_base.h.

Referenced by DrawAircraftImage(), DrawShipImage(), and GetSingleVehicleWidth().

◆ GetLastEnginePart()

Vehicle* Vehicle::GetLastEnginePart ( )

inline

Get the last part of an articulated engine.

Returns: Last part of the engine.

Definition at line 1005 of file vehicle_base.h.

References GetNextArticulatedPart(), and HasArticulatedPart().

◆ GetLastOrder()

Order* Vehicle::GetLastOrder ( ) const

inline

Returns the last order of a vehicle, or nullptr if it doesn't exists.

Returns: last order of a vehicle, if available

Definition at line 931 of file vehicle_base.h.

References OrderList::GetLastOrder(), and orders.

Referenced by PreviousOrderIsUnbunching().

◆ GetMaxWeight()

virtual uint16_t Vehicle::GetMaxWeight ( ) const

inlinevirtual

Calculates the weight value that this vehicle will have when fully loaded with its current cargo.

Returns: Weight value in tonnes.

Reimplemented in Train, and RoadVehicle.

Definition at line 374 of file vehicle_base.h.

◆ GetNextArticulatedPart()

Vehicle* Vehicle::GetNextArticulatedPart ( ) const

inline

Get the next part of an articulated engine.

Returns: Next part of the articulated engine.

Precondition: The vehicle is an articulated engine.

Definition at line 973 of file vehicle_base.h.

References HasArticulatedPart(), and Next().

Referenced by GetBestFittingSubType(), GetLastEnginePart(), and GetNextVehicle().

◆ GetNextStoppingStation()

StationIDStack Vehicle::GetNextStoppingStation ( ) const

inline

Get the next station the vehicle will stop at.

Returns: ID of the next station the vehicle will stop at or INVALID_STATION.

Definition at line 750 of file vehicle_base.h.

References orders.

Referenced by PrepareUnload().

◆ GetNextVehicle()

Vehicle* Vehicle::GetNextVehicle ( ) const

inline

Get the next real (non-articulated part) vehicle in the consist.

Returns: Next vehicle in the consist.

Definition at line 1016 of file vehicle_base.h.

References GetNextArticulatedPart(), HasArticulatedPart(), and Next().

Referenced by VehiclesHaveSameEngineList().

◆ GetNumManualOrders()

VehicleOrderID Vehicle::GetNumManualOrders ( ) const

inline

Get the number of manually added orders this vehicle has.

Returns: the number of manually added orders this vehicle has.

Definition at line 744 of file vehicle_base.h.

References OrderList::GetNumManualOrders(), and orders.

Referenced by SkipToNextRealOrderIndex(), and UpdateRealOrderIndex().

◆ GetNumOrders()

VehicleOrderID Vehicle::GetNumOrders ( ) const

inline

Get the number of orders this vehicle has.

Returns: the number of orders this vehicle has.

Definition at line 738 of file vehicle_base.h.

References OrderList::GetNumOrders(), and orders.

Referenced by CmdDeleteOrder(), CmdMoveOrder(), CmdSkipToOrder(), TimetableWindow::DrawArrivalDeparturePanel(), TimetableWindow::DrawTimetablePanel(), FillTimetableArrivalDepartureTable(), IncrementImplicitOrderIndex(), IsWaitingForUnbunching(), TimetableWindow::OnInvalidateData(), OrdersWindow::OnInvalidateData(), TimetableWindow::OnPaint(), OrdersWindow::OnVehicleSelect(), OrdersWindow::OrderClick_Delete(), OrdersWindow::OrderClick_Skip(), OrdersWindow::OrderGetSel(), SkipToNextRealOrderIndex(), VehicleOrderSaver::SwitchToNextOrder(), UpdateOrderDest(), and UpdateRealOrderIndex().

◆ GetOldAdvanceSpeed()

uint Vehicle::GetOldAdvanceSpeed ( uint speed )

inline

Determines the effective direction-specific vehicle movement speed.

This method belongs to the old vehicle movement method: A vehicle moves a step every 256 progress units. The vehicle speed is scaled by 3/4 when moving in X or Y direction due to the longer distance.

However, this method is slightly wrong in corners, as the leftover progress is not scaled correctly when changing movement direction. GetAdvanceSpeed() and GetAdvanceDistance() are better wrt. this.

Parameters

speed Direction-independent unscaled speed.

Returns: speed scaled by movement direction. 256 units are required for each movement step.

Definition at line 428 of file vehicle_base.h.

Referenced by UpdateAircraftSpeed().

◆ GetOrder()

Order* Vehicle::GetOrder ( int index ) const

inline

Returns order 'index' of a vehicle or nullptr when it doesn't exists.

Parameters

index the order to fetch

Returns: the found (or not) order

Definition at line 922 of file vehicle_base.h.

References OrderList::GetOrderAt(), and orders.

Referenced by CmdDeleteOrder(), CmdMoveOrder(), CmdOrderRefit(), FillTimetableArrivalDepartureTable(), IncrementImplicitOrderIndex(), TimetableWindow::OnPaint(), OrdersWindow::OrderClick_FullLoad(), OrdersWindow::OrderClick_Nonstop(), OrdersWindow::OrderClick_Service(), OrdersWindow::OrderClick_Unload(), PreviousOrderIsUnbunching(), LinkRefresher::Run(), SkipToNextRealOrderIndex(), VehicleOrderSaver::SwitchToNextOrder(), and UpdateRealOrderIndex().

◆ GetOrderStationLocation()

virtual TileIndex Vehicle::GetOrderStationLocation ( [[maybe_unused] ] StationID station )

inlinevirtual

Determine the location for the station where the vehicle goes to next.

Things done for example are allocating slots in a road stop or exact location of the platform is determined for ships.

Parameters

station the station to make the next location of the vehicle.

Returns: the location (tile) to aim for.

Definition at line 796 of file vehicle_base.h.

References INVALID_TILE.

◆ GetPrevVehicle()

Vehicle* Vehicle::GetPrevVehicle ( ) const

inline

Get the previous real (non-articulated part) vehicle in the consist.

Returns: Previous vehicle in the consist.

Definition at line 1029 of file vehicle_base.h.

References IsArticulatedPart(), and Previous().

◆ GetRunningCost()

virtual Money Vehicle::GetRunningCost ( ) const

inlinevirtual

Gets the running cost of a vehicle.

Returns: the vehicle's running cost

Reimplemented in RoadVehicle, Train, Aircraft, and Ship.

Definition at line 542 of file vehicle_base.h.

Referenced by GetDisplayRunningCost().

◆ GetVehicleTrackdir()

virtual Trackdir Vehicle::GetVehicleTrackdir ( ) const

inlinevirtual

Returns the Trackdir on which the vehicle is currently located.

Works for trains and ships. Currently works only sortof for road vehicles, since they have a fuzzy concept of being "on" a trackdir. Dunno really what it returns for a road vehicle that is halfway a tile, never really understood that part. For road vehicles that are at the beginning or end of the tile, should just return the diagonal trackdir on which they are driving. I think. For other vehicles types, or vehicles with no clear trackdir (such as those in depots), returns 0xFF.

Returns: the trackdir of the vehicle

Reimplemented in RoadVehicle, Train, and Ship.

Definition at line 605 of file vehicle_base.h.

References INVALID_TRACKDIR.

◆ HandleBreakdown()

bool Vehicle::HandleBreakdown ( )

Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate.

Returns: true iff the vehicle is stopped because of a breakdown

Note: This function always returns false for aircraft, since these never stop for breakdowns

Definition at line 1363 of file vehicle.cpp.

References breakdown_ctr, breakdowns_since_last_service, cur_speed, PlayVehicleSound(), BaseVehicle::type, VEH_AIRCRAFT, VEH_SHIP, VEH_TRAIN, vehstatus, VS_AIRCRAFT_BROKEN, and VSE_BREAKDOWN.

◆ HandleLoading()

void Vehicle::HandleLoading ( bool mode = false )

Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all other cases.

Parameters

mode	is the non-first call for this vehicle in this tick?

Definition at line 2430 of file vehicle.cpp.

References current_order, and Order::GetType().

◆ HandlePathfindingResult()

void Vehicle::HandlePathfindingResult ( bool path_found )

Handle the pathfinding result, especially the lost status.

If the vehicle is now lost and wasn't previously fire an event to the AIs and a news message to the user. If the vehicle is not lost anymore remove the news message.

Parameters

path_found Whether the vehicle has a path to its destination.

Definition at line 791 of file vehicle.cpp.

References _local_company, _settings_client, AddVehicleAdviceNewsItem(), ClrBit(), DeleteVehicleNews(), GetWindowClassForVehicleType(), ClientSettings::gui, HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, InvalidateWindowClassesData(), GUISettings::lost_vehicle_warn, AI::NewEvent(), owner, BaseConsist::ResetDepotUnbunching(), SetBit(), SetDParam(), SetWindowWidgetDirty(), BaseVehicle::type, BaseConsist::vehicle_flags, VF_PATHFINDER_LOST, WC_VEHICLE_VIEW, and WID_VV_START_STOP.

Referenced by ChooseShipTrack().

◆ HasArticulatedPart()

bool Vehicle::HasArticulatedPart ( ) const

inline

Check if an engine has an articulated part.

Returns: True if the engine has an articulated part.

Definition at line 963 of file vehicle_base.h.

References IsArticulatedPart(), and Next().

Referenced by RoadStop::Enter(), GetBestFittingSubType(), GetLastEnginePart(), GetNextArticulatedPart(), RoadStop::GetNextRoadStop(), GetNextVehicle(), VehicleDetailsWindow::GetRoadVehDetailsHeight(), GetVehicleCannotUseStationReason(), and IterateVehicleParts().

◆ HasConditionalOrder()

bool Vehicle::HasConditionalOrder ( ) const

Check if the current vehicle has a conditional order.

Returns: true Iff this vehicle has a conditional order.

Definition at line 2477 of file vehicle.cpp.

References Orders().

Referenced by GetOrderCmdFromTile().

◆ HasDepotOrder()

bool Vehicle::HasDepotOrder ( ) const

Checks if a vehicle has a depot in its order list.

Returns: True iff at least one order is a depot order.

Definition at line 1851 of file order_cmd.cpp.

References Orders().

Referenced by NeedsAutomaticServicing().

◆ HasEngineType()

bool Vehicle::HasEngineType ( ) const

Check whether Vehicle::engine_type has any meaning.

Returns: true if the vehicle has a usable engine type.

Definition at line 731 of file vehicle.cpp.

References SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), Aircraft::IsNormalAircraft(), BaseVehicle::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

Referenced by VehicleServiceInDepot().

◆ HasFullLoadOrder()

bool Vehicle::HasFullLoadOrder ( ) const

Check if the current vehicle has a full load order.

Returns: true Iff this vehicle has a full load order.

Definition at line 2465 of file vehicle.cpp.

References Orders().

Referenced by GetOrderCmdFromTile().

◆ HasUnbunchingOrder()

bool Vehicle::HasUnbunchingOrder ( ) const

Check if the current vehicle has an unbunching order.

Returns: true Iff this vehicle has an unbunching order.

Definition at line 2489 of file vehicle.cpp.

References Orders().

Referenced by GetOrderCmdFromTile().

◆ IncrementImplicitOrderIndex()

void Vehicle::IncrementImplicitOrderIndex ( )

inline

Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.

cur_real_order_index is incremented as well, if needed. Note: current_order is not invalidated.

Definition at line 862 of file vehicle_base.h.

References BaseConsist::cur_implicit_order_index, BaseConsist::cur_real_order_index, GetNumOrders(), GetOrder(), and SkipToNextRealOrderIndex().

Referenced by IncrementRealOrderIndex().

◆ IncrementRealOrderIndex()

void Vehicle::IncrementRealOrderIndex ( )

inline

Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates the GUI.

cur_implicit_order_index is incremented as well, if it was equal to cur_real_order_index, i.e. cur_real_order_index is skipped but not any implicit orders. Note: current_order is not invalidated.

Definition at line 886 of file vehicle_base.h.

References BaseConsist::cur_implicit_order_index, BaseConsist::cur_real_order_index, IncrementImplicitOrderIndex(), InvalidateVehicleOrder(), and SkipToNextRealOrderIndex().

◆ InvalidateNewGRFCache()

void Vehicle::InvalidateNewGRFCache ( )

inline

Invalidates cached NewGRF variables.

See also: InvalidateNewGRFCacheOfChain

Definition at line 495 of file vehicle_base.h.

References NewGRFCache::cache_valid.

Referenced by RefitWindow::BuildRefitList(), and CheckTrainAttachment().

◆ InvalidateNewGRFCacheOfChain()

void Vehicle::InvalidateNewGRFCacheOfChain ( )

inline

Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle)

See also: InvalidateNewGRFCache

Definition at line 504 of file vehicle_base.h.

References Next().

Referenced by RefitVehicle(), and RoadVehUpdateCache().

◆ IsArticulatedPart()

bool Vehicle::IsArticulatedPart ( ) const

inline

Check if the vehicle is an articulated part of an engine.

Returns: Returns true if the vehicle is an articulated part.

Definition at line 954 of file vehicle_base.h.

References GVSF_ARTICULATED_PART, HasBit(), and IsGroundVehicle().

Referenced by BuildDepotVehicleListProc(), CheckTrainAttachment(), CmdAutoreplaceVehicle(), GetFirstEnginePart(), GetLengthOfArticulatedVehicle(), GetNewEngineType(), GetPrevVehicle(), GetVehicleSet(), HasArticulatedPart(), InsertInConsist(), IsEngineCountable(), RefitVehicle(), ReplaceFreeUnit(), and TransferCargo().

◆ IsChainInDepot()

virtual bool Vehicle::IsChainInDepot ( ) const

inlinevirtual

Check whether the whole vehicle chain is in the depot.

Returns: true if and only if the whole chain is in the depot.

Reimplemented in GroundVehicle< T, Type >.

Definition at line 554 of file vehicle_base.h.

References IsInDepot().

Referenced by CmdAutoreplaceVehicle(), and IsStoppedInDepot().

◆ IsEngineCountable()

bool Vehicle::IsEngineCountable ( ) const

Check if a vehicle is counted in num_engines in each company struct.

Returns: true if the vehicle is counted in num_engines

Definition at line 714 of file vehicle.cpp.

References SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), IsArticulatedPart(), IsFrontEngine(), Aircraft::IsNormalAircraft(), GroundVehicle< T, Type >::IsRearDualheaded(), BaseVehicle::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

◆ IsFrontEngine()

debug_inline bool Vehicle::IsFrontEngine ( ) const

inline

Check if the vehicle is a front engine.

Returns: Returns true if the vehicle is a front engine.

Definition at line 945 of file vehicle_base.h.

Referenced by CmdAutoreplaceVehicle(), CmdCloneVehicle(), CmdSellRailWagon(), Train::Crash(), RoadVehicle::Crash(), FreeTrainTrackReservation(), RoadVehicle::IsBus(), IsEngineCountable(), Train::IsPrimaryVehicle(), RoadVehicle::IsPrimaryVehicle(), NormaliseTrainHead(), RoadVehicle::OnNewCalendarDay(), Train::OnNewEconomyDay(), RoadVehicle::OnNewEconomyDay(), RoadVehUpdateCache(), Train::Tick(), RoadVehicle::Tick(), TrainApproachingCrossingEnum(), TrainApproachingCrossingTile(), TrainController(), TryPathReserve(), Train::UpdateAcceleration(), and UpdateTrainGroupID().

◆ IsGroundVehicle()

debug_inline bool Vehicle::IsGroundVehicle ( ) const

inline

Check if the vehicle is a ground vehicle.

Returns: True iff the vehicle is a train or a road vehicle.

Definition at line 515 of file vehicle_base.h.

Referenced by RefitWindow::BuildRefitList(), DeleteUnreachedImplicitOrders(), GetGroundVehicleCache(), GetOrderCmdFromTile(), GetVehiclePalette(), InsertOrder(), IsArticulatedPart(), IsVehicleRefitable(), LiveryHelper(), OrdersWindow::OrderClick_Nonstop(), and OrdersWindow::UpdateAutoRefitState().

◆ IsInDepot()

virtual bool Vehicle::IsInDepot ( ) const

inlinevirtual

Check whether the vehicle is in the depot.

Returns: true if and only if the vehicle is in the depot.

Reimplemented in RoadVehicle, Train, Aircraft, and Ship.

Definition at line 548 of file vehicle_base.h.

Referenced by BuildDepotVehicleListProc(), IsChainInDepot(), and IsWaitingForUnbunching().

◆ IsOrderListShared()

bool Vehicle::IsOrderListShared ( ) const

inline

Check if we share our orders with another vehicle.

Returns: true if there are other vehicles sharing the same order

Definition at line 732 of file vehicle_base.h.

References OrderList::IsShared(), and orders.

Referenced by DeleteVehicleOrders(), IsWaitingForUnbunching(), OrderBackup::OrderBackup(), and OrdersWindow::OrderClick_StopSharing().

◆ IsStoppedInDepot()

bool Vehicle::IsStoppedInDepot ( ) const

inline

Check whether the vehicle is in the depot and stopped.

Returns: true if and only if the vehicle is in the depot and stopped.

Definition at line 560 of file vehicle_base.h.

References First(), IsChainInDepot(), IsPrimaryVehicle(), and VS_STOPPED.

Referenced by CmdAutoreplaceVehicle(), CmdSellVehicle(), IsVehicleRefitable(), and SendToDepot().

◆ IsWaitingForUnbunching()

bool Vehicle::IsWaitingForUnbunching ( ) const

Check whether a vehicle inside a depot is waiting for unbunching.

Returns: True if the vehicle must continue waiting, or false if it may try to leave the depot.

Definition at line 2561 of file vehicle.cpp.

References TimerGameTick::counter, BaseConsist::depot_unbunching_next_departure, GetNumOrders(), IsInDepot(), IsOrderListShared(), and PreviousOrderIsUnbunching().

Referenced by CheckTrainStayInDepot().

◆ Last() [1/2]

Vehicle* Vehicle::Last ( )

inline

Get the last vehicle of this vehicle chain.

Returns: the last vehicle of the chain.

Definition at line 651 of file vehicle_base.h.

References Next().

◆ Last() [2/2]

const Vehicle* Vehicle::Last ( ) const

inline

Get the last vehicle of this vehicle chain.

Returns: the last vehicle of the chain.

Definition at line 662 of file vehicle_base.h.

References Next().

◆ LeaveStation()

void Vehicle::LeaveStation ( )

Perform all actions when leaving a station.

Precondition: this->current_order.IsType(OT_LOADING)

Definition at line 2350 of file vehicle.cpp.

References current_order, and Order::IsType().

◆ MarkAllViewportsDirty()

bool Vehicle::MarkAllViewportsDirty ( ) const

Marks viewports dirty where the vehicle's image is.

Returns: true if at least one viewport has a dirty block

Definition at line 1774 of file vehicle.cpp.

References coord, and MarkAllViewportsDirty().

Referenced by ~Vehicle().

◆ Move() [1/2]

Vehicle* Vehicle::Move ( int n )

inline

Get the vehicle at offset n of this vehicle chain.

Parameters

n	Offset from the current vehicle.

Returns: The new vehicle or nullptr if the offset is out-of-bounds.

Definition at line 674 of file vehicle_base.h.

References Next(), and Previous().

Referenced by NewGRFInspectWindow::GetFeatureIndex(), and NewGRFInspectWindow::ValidateChainIndex().

◆ Move() [2/2]

const Vehicle* Vehicle::Move ( int n ) const

inline

Get the vehicle at offset n of this vehicle chain.

Parameters

n	Offset from the current vehicle.

Returns: The new vehicle or nullptr if the offset is out-of-bounds.

Definition at line 690 of file vehicle_base.h.

References Next(), and Previous().

◆ NeedsAutomaticServicing()

bool Vehicle::NeedsAutomaticServicing ( ) const

Checks if the current order should be interrupted for a service-in-depot order.

See also: NeedsServicing()

Returns: true if the current order should be interrupted.

Definition at line 272 of file vehicle.cpp.

References current_order, HasDepotOrder(), and Order::IsType().

Referenced by CheckIfTrainNeedsService().

◆ NeedsAutorenewing()

bool Vehicle::NeedsAutorenewing	(	const Company *	c,
		bool	use_renew_setting = `true`
	)		const

Function to tell if a vehicle needs to be autorenewed.

Parameters

*c	The vehicle owner
use_renew_setting	Should the company renew setting be considered?

Returns: true if the vehicle is old enough for replacement

Definition at line 145 of file vehicle.cpp.

References age, CompanySettings::engine_renew, CompanySettings::engine_renew_months, SpecializedVehicle< Train, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), max_age, owner, CompanyProperties::settings, BaseVehicle::type, and VEH_TRAIN.

Referenced by GetNewEngineType().

◆ NeedsServicing()

bool Vehicle::NeedsServicing ( ) const

Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for service or replacement.

See also: NeedsAutomaticServicing()

Returns: true if the vehicle should go to a depot if a opportunity presents itself.

Definition at line 190 of file vehicle.cpp.

References _settings_game, cargo_type, TimerGameEconomy::date, date_of_last_service, EconomyTime::DAYS_IN_ECONOMY_MONTH, GameSettings::difficulty, CompanySettings::engine_renew_money, EngineReplacementForCompany(), SpecializedVehicle< Train, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetArticulatedRefitMasks(), GetAvailableMoney(), GetCargoTypesOfArticulatedParts(), GetCargoTypesOfArticulatedVehicle(), GetEngine(), Train::GetNextUnit(), HasAtMostOneBit(), HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, INVALID_ENGINE, IsValidCargoID(), OrderSettings::no_servicing_if_no_breakdowns, GameSettings::order, owner, reliability, CompanyProperties::settings, TimerGameEconomy::UsingWallclockUnits(), VEH_TRAIN, DifficultySettings::vehicle_breakdowns, vehstatus, VS_CRASHED, and VS_STOPPED.

◆ Next()

Vehicle* Vehicle::Next ( ) const

inline

Get the next vehicle of this vehicle.

Note: articulated parts are also counted as vehicles.

Returns: the next vehicle or nullptr when there isn't a next vehicle.

Definition at line 632 of file vehicle_base.h.

References next.

Referenced by AircraftLeaveHangar(), RefitWindow::BuildRefitList(), CargoFilterSingle(), CheckCargoCapacity(), CmdCloneVehicle(), Crash(), NewGRFInspectWindow::DrawVehicleChainWidget(), GetDisplayMaxWeight(), GetNextArticulatedPart(), GetNextVehicle(), LinkRefresher::HandleRefit(), HasArticulatedPart(), IncreaseStats(), InvalidateNewGRFCacheOfChain(), IsVehicleRefitable(), IterateVehicleParts(), Last(), Move(), NewGRFInspectWindow::OnInvalidateData(), PositionHelper(), PrepareUnload(), PropagateChildLivery(), RefitVehicle(), RerouteCargo(), ReserveConsist(), ResetRefitCaps(), SetNext(), TransferCargo(), VehicleCargoSorter(), VehicleServiceInDepot(), VehicleValueSorter(), and ~Vehicle().

◆ NextShared()

Vehicle* Vehicle::NextShared ( ) const

inline

Get the next vehicle of the shared vehicle chain.

Returns: the next shared vehicle or nullptr when there isn't a next vehicle.

Definition at line 714 of file vehicle_base.h.

References next_shared.

Referenced by OrderBackup::ClearVehicle(), CmdAddSharedVehicleGroup(), CmdAutofillTimetable(), CmdMoveOrder(), CmdSetTimetableStart(), CmdSetVehicleOnTime(), DeleteOrder(), FindVehiclesWithOrder(), InsertOrder(), LeaveUnbunchingDepot(), OrderBackup::OrderBackup(), OrdersWindow::OrderClick_StopSharing(), and OrderList::RemoveVehicle().

◆ Orders()

IterateWrapper Vehicle::Orders ( ) const

inline

Returns an iterable ensemble of orders of a vehicle.

Returns: an iterable ensemble of orders of a vehicle

Definition at line 1084 of file vehicle_base.h.

References orders.

Referenced by CheckForValidOrders(), CheckOrders(), CmdMoveOrder(), HasConditionalOrder(), HasDepotOrder(), HasFullLoadOrder(), HasUnbunchingOrder(), OrderBackup::OrderBackup(), and VerifyAutoreplaceRefitForOrders().

◆ PlayLeaveStationSound()

virtual void Vehicle::PlayLeaveStationSound ( [[maybe_unused] ] bool force = false ) const

inlinevirtual

Play the sound associated with leaving the station.

Parameters

force Should we play the sound even if sound effects are muted? (horn hotkey)

Definition at line 472 of file vehicle_base.h.

Referenced by VehicleViewWindow::OnHotkey().

◆ Previous()

Vehicle* Vehicle::Previous ( ) const

inline

Get the previous vehicle of this vehicle.

Note: articulated parts are also counted as vehicles.

Returns: the previous vehicle or nullptr when there isn't a previous vehicle.

Definition at line 639 of file vehicle_base.h.

References previous.

Referenced by AgeVehicle(), Crash(), GetFirstEnginePart(), GetPrevVehicle(), and Move().

◆ PreviousShared()

Vehicle* Vehicle::PreviousShared ( ) const

inline

Get the previous vehicle of the shared vehicle chain.

Returns: the previous shared vehicle or nullptr when there isn't a previous vehicle.

Definition at line 720 of file vehicle_base.h.

References previous_shared.

Referenced by OrdersWindow::OrderClick_StopSharing().

◆ SendToDepot()

CommandCost Vehicle::SendToDepot	(	DoCommandFlag	flags,
		DepotCommand	command
	)

Send this vehicle to the depot using the given command(s).

Parameters

flags	the command flags (like execute and such).
command	the command to execute.

Returns: the cost of the depot action.

Definition at line 2583 of file vehicle.cpp.

References CheckOwnership(), CMD_ERROR, current_order, DC_EXEC, CommandCost::Failed(), IsStoppedInDepot(), Order::IsType(), owner, BaseConsist::ResetDepotUnbunching(), vehstatus, and VS_CRASHED.

Referenced by CmdSendVehicleToDepot().

◆ SetNext()

void Vehicle::SetNext ( Vehicle * next )

Set the next vehicle of this vehicle.

Parameters

next	the next vehicle. nullptr removes the next vehicle.

Definition at line 2937 of file vehicle.cpp.

References first, next, Next(), and previous.

Referenced by CheckTrainAttachment(), DeleteLastRoadVeh(), DeleteLastWagon(), InsertInConsist(), RemoveFromConsist(), RestoreTrainBackup(), and ~Vehicle().

◆ ShiftDates()

void Vehicle::ShiftDates ( TimerGameEconomy::Date interval )

Shift all dates by given interval.

This is useful if the date has been modified with the cheat menu.

Parameters

interval Number of days to be added or substracted.

Definition at line 777 of file vehicle.cpp.

References date_of_last_service.

◆ ShowVisualEffect()

void Vehicle::ShowVisualEffect ( ) const

Draw visual effects (smoke and/or sparks) for a vehicle chain.

Precondition: this->IsPrimaryVehicle()

Definition at line 2787 of file vehicle.cpp.

References _settings_game, SpecializedVehicle< Train, Type >::From(), GetCurrentMaxSpeed(), HasBit(), IsPrimaryVehicle(), VehicleSettings::smoke_amount, BaseVehicle::type, VEH_TRAIN, GameSettings::vehicle, VS_STOPPED, and VS_TRAIN_SLOWING.

◆ SkipToNextRealOrderIndex()

void Vehicle::SkipToNextRealOrderIndex ( )

inlineprivate

Advance cur_real_order_index to the next real order.

cur_implicit_order_index is not touched.

Definition at line 843 of file vehicle_base.h.

References BaseConsist::cur_real_order_index, GetNumManualOrders(), GetNumOrders(), and GetOrder().

Referenced by IncrementImplicitOrderIndex(), and IncrementRealOrderIndex().

◆ Tick()

virtual bool Vehicle::Tick ( )

inlinevirtual

Calls the tick handler of the vehicle.

Returns: is this vehicle still valid?

Reimplemented in RoadVehicle, Train, Aircraft, DisasterVehicle, Ship, and EffectVehicle.

Definition at line 572 of file vehicle_base.h.

◆ UpdateBoundingBoxCoordinates()

void Vehicle::UpdateBoundingBoxCoordinates ( bool update_cache ) const

Update the bounding box co-ordinates of the vehicle.

Parameters

update_cache Update the cached values for previous co-ordinate values

Definition at line 1702 of file vehicle.cpp.

References VehicleSpriteSeq::GetBounds(), RemapCoords(), sprite_cache, MutableSpriteCache::sprite_seq, x_offs, x_pos, y_offs, y_pos, and z_pos.

Referenced by UpdateViewport().

◆ UpdatePosition()

void Vehicle::UpdatePosition ( )

Update the position of the vehicle.

This will update the hash that tells which vehicles are on a tile.

Definition at line 1693 of file vehicle.cpp.

Referenced by ShipMoveUpDownOnLock(), UpdatePositionAndViewport(), and UpdateStatusAfterSwap().

◆ UpdateViewport()

void Vehicle::UpdateViewport ( bool dirty )

Update the vehicle on the viewport, updating the right hash and setting the new coordinates.

Parameters

dirty Mark the (new and old) coordinates of the vehicle as dirty.

Definition at line 1735 of file vehicle.cpp.

References INVALID_COORD, MutableSpriteCache::old_coord, sprite_cache, and UpdateBoundingBoxCoordinates().

Referenced by UpdatePositionAndViewport().

◆ UpdateVisualEffect()

void Vehicle::UpdateVisualEffect ( bool allow_power_change = true )

Update the cached visual effect.

Parameters

allow_power_change true if the wagon-is-powered-state may change.

Definition at line 2664 of file vehicle.cpp.

References VehicleCache::cached_vis_effect, EngineInfo::callback_mask, CBM_VEHICLE_VISUAL_EFFECT, GetEngine(), HasBit(), Engine::type, vcache, VE_DISABLE_EFFECT, VE_DISABLE_WAGON_POWER, VEH_ROAD, VEH_SHIP, VEH_TRAIN, RailVehicleInfo::visual_effect, ShipVehicleInfo::visual_effect, and RoadVehicleInfo::visual_effect.

Friends And Related Function Documentation

◆ AfterLoadVehicles

void AfterLoadVehicles ( bool part_of_load )

friend

So we can set the previous and first pointers while loading.

For instantiating the shared vehicle chain.

Definition at line 255 of file vehicle_sl.cpp.

◆ FixOldVehicles

void FixOldVehicles ( )

friend

Convert the old style vehicles into something that resembles the old new style savegames.

Then AfterLoadGame can handle the rest of the conversion.

Definition at line 163 of file oldloader_sl.cpp.

◆ LoadOldVehicle

bool LoadOldVehicle	(	LoadgameState *	ls,
		int	num
	)

friend

So we can set the proper next pointer while loading.

Parameters

ls	State (buffer) of the currently loaded game.
num	The number of vehicles to load.

Returns: True iff loading went without problems.

Definition at line 1249 of file oldloader_sl.cpp.

Field Documentation

◆ breakdown_ctr

uint8_t Vehicle::breakdown_ctr

Counter for managing breakdown events.

See also: Vehicle::HandleBreakdown

Definition at line 299 of file vehicle_base.h.

Referenced by CmdTurnRoadVeh(), HandleBreakdown(), and TrainCheckIfLineEnds().

◆ dest_tile

TileIndex Vehicle::dest_tile

Heading for this tile.

For airports and train stations this tile does not necessarily belong to the destination station, but it can be used for heuristic purposes to estimate the distance.

Definition at line 271 of file vehicle_base.h.

Referenced by ChooseShipTrack(), CopyVehicleConfigAndStatistics(), ReleaseDisastersTargetingIndustry(), ReleaseDisasterVehicle(), and VehicleOrderSaver::Restore().

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

Data Structures

Public Member Functions

Static Public Member Functions

Data Fields

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Vehicle()

Member Function Documentation

◆ AddToShared()

◆ BeginLoading()

◆ CancelReservation()

◆ CopyVehicleConfigAndStatistics()

◆ Crash()

◆ FindClosestDepot()

◆ First()

◆ FirstShared()

◆ GetAdvanceDistance()

◆ GetAdvanceSpeed()

◆ GetCurrentMaxSpeed()

◆ GetDisplayMaxSpeed()

◆ GetDisplayMaxWeight()

◆ GetDisplayMinPowerToWeight()

◆ GetDisplayProfitLastYear()

◆ GetDisplayProfitThisYear()

◆ GetDisplayRunningCost()

◆ GetDisplaySpeed()

◆ GetEngine()

◆ GetExpenseType()

◆ GetFirstEnginePart() [1/2]

◆ GetFirstEnginePart() [2/2]

◆ GetFirstOrder()

◆ GetGRF()

◆ GetGRFID()

◆ GetGroundVehicleCache()

◆ GetGroundVehicleFlags()

◆ GetImage()

◆ GetLastEnginePart()

◆ GetLastOrder()

◆ GetMaxWeight()

◆ GetNextArticulatedPart()

◆ GetNextStoppingStation()

◆ GetNextVehicle()

◆ GetNumManualOrders()

◆ GetNumOrders()

◆ GetOldAdvanceSpeed()

◆ GetOrder()

◆ GetOrderStationLocation()

◆ GetPrevVehicle()

◆ GetRunningCost()

◆ GetVehicleTrackdir()

◆ HandleBreakdown()

◆ HandleLoading()

◆ HandlePathfindingResult()

◆ HasArticulatedPart()

◆ HasConditionalOrder()

◆ HasDepotOrder()

◆ HasEngineType()

◆ HasFullLoadOrder()

◆ HasUnbunchingOrder()

◆ IncrementImplicitOrderIndex()

◆ IncrementRealOrderIndex()

◆ InvalidateNewGRFCache()

◆ InvalidateNewGRFCacheOfChain()

◆ IsArticulatedPart()

◆ IsChainInDepot()

◆ IsEngineCountable()

◆ IsFrontEngine()

◆ IsGroundVehicle()

◆ IsInDepot()

◆ IsOrderListShared()

◆ IsStoppedInDepot()

◆ IsWaitingForUnbunching()

◆ Last() [1/2]

◆ Last() [2/2]

◆ LeaveStation()