Base implementations of all vehicles. More...

#include "stdafx.h"
#include "error.h"
#include "roadveh.h"
#include "ship.h"
#include "spritecache.h"
#include "timetable.h"
#include "viewport_func.h"
#include "news_func.h"
#include "command_func.h"
#include "company_func.h"
#include "train.h"
#include "aircraft.h"
#include "newgrf_debug.h"
#include "newgrf_sound.h"
#include "newgrf_station.h"
#include "group_gui.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "vehicle_func.h"
#include "autoreplace_func.h"
#include "autoreplace_gui.h"
#include "station_base.h"
#include "ai/ai.hpp"
#include "depot_func.h"
#include "network/network.h"
#include "core/pool_func.hpp"
#include "economy_base.h"
#include "articulated_vehicles.h"
#include "roadstop_base.h"
#include "core/random_func.hpp"
#include "core/backup_type.hpp"
#include "core/container_func.hpp"
#include "order_backup.h"
#include "sound_func.h"
#include "effectvehicle_func.h"
#include "effectvehicle_base.h"
#include "vehiclelist.h"
#include "bridge_map.h"
#include "tunnel_map.h"
#include "depot_map.h"
#include "gamelog.h"
#include "linkgraph/linkgraph.h"
#include "linkgraph/refresh.h"
#include "framerate_type.h"
#include "autoreplace_cmd.h"
#include "misc_cmd.h"
#include "train_cmd.h"
#include "vehicle_cmd.h"
#include "newgrf_roadstop.h"
#include "timer/timer.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_economy.h"
#include "timer/timer_game_tick.h"
#include "table/strings.h"
#include "safeguards.h"

Macros
#define	GEN_HASHX(x) GB((x), GEN_HASHX_BUCKET_BITS + ZOOM_BASE_SHIFT, GEN_HASHX_BITS)

#define	GEN_HASHY(y) (GB((y), GEN_HASHY_BUCKET_BITS + ZOOM_BASE_SHIFT, GEN_HASHY_BITS) << GEN_HASHX_BITS)

#define	GEN_HASH(x, y) (GEN_HASHY(y) + GEN_HASHX(x))

Typedefs
using	AutoreplaceMap = std::map< VehicleID, bool >
	List of vehicles that should check for autoreplace this tick. More...

Functions
void	VehicleServiceInDepot (Vehicle *v)
	Service a vehicle and all subsequent vehicles in the consist. More...

void	ShowNewGrfVehicleError (EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical)
	Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking. More...

void	VehicleLengthChanged (const Vehicle *u)
	Logs a bug in GRF and shows a warning message if this is for the first time this happened. More...

static Vehicle *	VehicleFromTileHash (int xl, int yl, int xu, int yu, void data, VehicleFromPosProc proc, bool find_first)

static Vehicle *	VehicleFromPosXY (int x, int y, void data, VehicleFromPosProc proc, bool find_first)
	Helper function for FindVehicleOnPos/HasVehicleOnPos. More...

void	FindVehicleOnPosXY (int x, int y, void data, VehicleFromPosProc proc)
	Find a vehicle from a specific location. More...

bool	HasVehicleOnPosXY (int x, int y, void data, VehicleFromPosProc proc)
	Checks whether a vehicle in on a specific location. More...

static Vehicle *	VehicleFromPos (TileIndex tile, void data, VehicleFromPosProc proc, bool find_first)
	Helper function for FindVehicleOnPos/HasVehicleOnPos. More...

void	FindVehicleOnPos (TileIndex tile, void data, VehicleFromPosProc proc)
	Find a vehicle from a specific location. More...

bool	HasVehicleOnPos (TileIndex tile, void data, VehicleFromPosProc proc)
	Checks whether a vehicle is on a specific location. More...

static Vehicle *	EnsureNoVehicleProcZ (Vehicle v, void data)
	Callback that returns 'real' vehicles lower or at height ``(int)data . More...

CommandCost	EnsureNoVehicleOnGround (TileIndex tile)
	Ensure there is no vehicle at the ground at the given position. More...

static Vehicle *	GetVehicleTunnelBridgeProc (Vehicle v, void data)
	Procedure called for every vehicle found in tunnel/bridge in the hash map.

CommandCost	TunnelBridgeIsFree (TileIndex tile, TileIndex endtile, const Vehicle *ignore)
	Finds vehicle in tunnel / bridge. More...

static Vehicle *	EnsureNoTrainOnTrackProc (Vehicle v, void data)

CommandCost	EnsureNoTrainOnTrackBits (TileIndex tile, TrackBits track_bits)
	Tests if a vehicle interacts with the specified track bits. More...

static void	UpdateVehicleTileHash (Vehicle *v, bool remove)

static void	UpdateVehicleViewportHash (Vehicle *v, int x, int y, int old_x, int old_y)

void	ResetVehicleHash ()

void	ResetVehicleColourMap ()

void	InitializeVehicles ()

uint	CountVehiclesInChain (const Vehicle *v)

void	VehicleEnteredDepotThisTick (Vehicle *v)
	Adds a vehicle to the list of vehicles that visited a depot this tick. More...

void	RunVehicleCalendarDayProc ()
	Age all vehicles, spreading out the action using the current TimerGameCalendar::date_fract.

static void	RunEconomyVehicleDayProc ()
	Increases the day counter for all vehicles and calls 1-day and 32-day handlers. More...

void	CallVehicleTicks ()

static void	DoDrawVehicle (const Vehicle *v)
	Add vehicle sprite for drawing to the screen. More...

void	ViewportAddVehicles (DrawPixelInfo *dpi)
	Add the vehicle sprites that should be drawn at a part of the screen. More...

Vehicle *	CheckClickOnVehicle (const Viewport *vp, int x, int y)
	Find the vehicle close to the clicked coordinates. More...

void	DecreaseVehicleValue (Vehicle *v)
	Decrease the value of a vehicle. More...

void	CheckVehicleBreakdown (Vehicle *v)

void	EconomyAgeVehicle (Vehicle *v)
	Update economy age of a vehicle. More...

void	AgeVehicle (Vehicle *v)
	Update age of a vehicle. More...

uint8_t	CalcPercentVehicleFilled (const Vehicle front, StringID colour)
	Calculates how full a vehicle is. More...

void	VehicleEnterDepot (Vehicle *v)
	Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it, etc. More...

GetNewVehiclePosResult	GetNewVehiclePos (const Vehicle *v)
	Get position information of a vehicle when moving one pixel in the direction it is facing. More...

Direction	GetDirectionTowards (const Vehicle *v, int x, int y)

VehicleEnterTileStatus	VehicleEnterTile (Vehicle *v, TileIndex tile, int x, int y)
	Call the tile callback function for a vehicle entering a tile. More...

UnitID	GetFreeUnitNumber (VehicleType type)
	Get an unused unit number for a vehicle (if allowed). More...

bool	CanBuildVehicleInfrastructure (VehicleType type, uint8_t subtype)
	Check whether we can build infrastructure for the given vehicle type. More...

LiveryScheme	GetEngineLiveryScheme (EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
	Determines the LiveryScheme for a vehicle. More...

const Livery *	GetEngineLivery (EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, uint8_t livery_setting)
	Determines the livery for a vehicle. More...

static PaletteID	GetEngineColourMap (EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v)

PaletteID	GetEnginePalette (EngineID engine_type, CompanyID company)
	Get the colour map for an engine. More...

PaletteID	GetVehiclePalette (const Vehicle *v)
	Get the colour map for a vehicle. More...

static bool	PreviousOrderIsUnbunching (const Vehicle *v)
	Check if the previous order is a depot unbunching order. More...

static void	SpawnAdvancedVisualEffect (const Vehicle *v)
	Call CBID_VEHICLE_SPAWN_VISUAL_EFFECT and spawn requested effects. More...

bool	CanVehicleUseStation (EngineID engine_type, const Station *st)
	Can this station be used by the given engine type? More...

bool	CanVehicleUseStation (const Vehicle v, const Station st)
	Can this station be used by the given vehicle? More...

StringID	GetVehicleCannotUseStationReason (const Vehicle v, const Station st)
	Get reason string why this station can't be used by the given vehicle. More...

void	GetVehicleSet (VehicleSet &set, Vehicle *v, uint8_t num_vehicles)
	Calculates the set of vehicles that will be affected by a given selection. More...

bool	VehiclesHaveSameEngineList (const Vehicle v1, const Vehicle v2)
	Checks if two vehicle chains have the same list of engines. More...

bool	VehiclesHaveSameOrderList (const Vehicle v1, const Vehicle v2)
	Checks if two vehicles have the same list of orders. More...

Variables
static const uint	GEN_HASHX_BITS = 6

static const uint	GEN_HASHY_BITS = 6

static const uint	GEN_HASHX_BUCKET_BITS = 7

static const uint	GEN_HASHY_BUCKET_BITS = 6

static const int	GEN_HASHX_SIZE = 1 << (GEN_HASHX_BUCKET_BITS + GEN_HASHX_BITS + ZOOM_BASE_SHIFT)

static const int	GEN_HASHY_SIZE = 1 << (GEN_HASHY_BUCKET_BITS + GEN_HASHY_BITS + ZOOM_BASE_SHIFT)

static const int	GEN_HASHX_INC = 1

static const int	GEN_HASHY_INC = 1 << GEN_HASHX_BITS

static const uint	GEN_HASHX_MASK = (1 << GEN_HASHX_BITS) - 1

static const uint	GEN_HASHY_MASK = ((1 << GEN_HASHY_BITS) - 1) << GEN_HASHX_BITS

VehiclePool	_vehicle_pool ("Vehicle")
	The pool with all our precious vehicles.

const int	HASH_BITS = 7

const int	HASH_SIZE = 1 << HASH_BITS

const int	HASH_MASK = HASH_SIZE - 1

const int	TOTAL_HASH_SIZE = 1 << (HASH_BITS * 2)

const int	TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1

const int	HASH_RES = 0

static Vehicle *	_vehicle_tile_hash [TOTAL_HASH_SIZE]

static Vehicle *	_vehicle_viewport_hash [1<<(GEN_HASHX_BITS+GEN_HASHY_BITS)]

static AutoreplaceMap	_vehicles_to_autoreplace

static const uint8_t	_breakdown_chance [64]

static const Direction	_new_direction_table []

static const int8_t	_vehicle_smoke_pos [8]

static IntervalTimer< TimerGameEconomy >	_economy_vehicles_yearly ({TimerGameEconomy::YEAR, TimerGameEconomy::Priority::VEHICLE}, [](auto) { for(Vehicle *v :Vehicle::Iterate()) { if(v->IsPrimaryVehicle()) { Money profit=v->GetDisplayProfitThisYear();if(v->economy_age >=VEHICLE_PROFIT_MIN_AGE &&profit< 0) { if(_settings_client.gui.vehicle_income_warn &&v->owner==_local_company) { SetDParam(0, v->index);SetDParam(1, profit);AddVehicleAdviceNewsItem(TimerGameEconomy::UsingWallclockUnits() ? STR_NEWS_VEHICLE_UNPROFITABLE_PERIOD :STR_NEWS_VEHICLE_UNPROFITABLE_YEAR, v->index);} AI::NewEvent(v->owner, new ScriptEventVehicleUnprofitable(v->index));} v->profit_last_year=v->profit_this_year;v->profit_this_year=0;SetWindowDirty(WC_VEHICLE_DETAILS, v->index);} } GroupStatistics::UpdateProfits();SetWindowClassesDirty(WC_TRAINS_LIST);SetWindowClassesDirty(WC_SHIPS_LIST);SetWindowClassesDirty(WC_ROADVEH_LIST);SetWindowClassesDirty(WC_AIRCRAFT_LIST);})

Detailed Description

Base implementations of all vehicles.

Definition in file vehicle.cpp.

Typedef Documentation

◆ AutoreplaceMap

using AutoreplaceMap = std::map<VehicleID, bool>

List of vehicles that should check for autoreplace this tick.

Mapping of vehicle -> leave depot immediately after autoreplace.

Definition at line 694 of file vehicle.cpp.

Function Documentation

◆ AgeVehicle()

void AgeVehicle ( Vehicle * v )

Update age of a vehicle.

Parameters

v	Vehicle to update.

Definition at line 1441 of file vehicle.cpp.

References _local_company, _settings_client, AddVehicleAdviceNewsItem(), Vehicle::age, Engine::company_avail, TimerGame< struct Calendar >::DateAtStartOfYear(), TimerGameConst< struct Calendar >::DAYS_IN_LEAP_YEAR, CompanySettings::engine_renew, Vehicle::engine_type, EngineHasReplacementForCompany(), SpecializedVehicle< T, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), Vehicle::GetEngine(), Vehicle::group_id, ClientSettings::gui, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::IsPrimaryVehicle(), Vehicle::max_age, TimerGameConst< struct Calendar >::MAX_DATE, GUISettings::old_vehicle_warn, Vehicle::owner, Vehicle::Previous(), Vehicle::reliability_spd_dec, SetDParam(), CompanyProperties::settings, SetWindowDirty(), BaseVehicle::type, VEH_TRAIN, Vehicle::vehstatus, VS_CRASHED, VS_STOPPED, and WC_VEHICLE_DETAILS.

Referenced by Aircraft::OnNewCalendarDay(), RoadVehicle::OnNewCalendarDay(), Ship::OnNewCalendarDay(), and Train::OnNewCalendarDay().

◆ CalcPercentVehicleFilled()

uint8_t CalcPercentVehicleFilled	(	const Vehicle *	front,
		StringID *	colour
	)

Calculates how full a vehicle is.

Parameters

front	The front vehicle of the consist to check.
colour	The string to show depending on if we are unloading or loading

Returns: A percentage of how full the Vehicle is. Percentages are rounded towards 50%, so that 0% and 100% are only returned if the vehicle is completely empty or full. This is useful for both display and conditional orders.

Definition at line 1493 of file vehicle.cpp.

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

Referenced by AfterLoadVehiclesPhase2().

◆ CanBuildVehicleInfrastructure()

bool CanBuildVehicleInfrastructure	(	VehicleType	type,
		uint8_t	subtype
	)

Check whether we can build infrastructure for the given vehicle type.

This to disable building stations etc. when you are not allowed/able to have the vehicle type yet.

Parameters

type	the vehicle type to check this for

Returns: true if there is any reason why you may build the infrastructure for the given vehicle type

Definition at line 1922 of file vehicle.cpp.

References _local_company, _settings_game, HasAnyRailTypesAvail(), HasAnyRoadTypesAvail(), IsCompanyBuildableVehicleType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), VehicleSettings::max_aircraft, VehicleSettings::max_roadveh, VehicleSettings::max_ships, VehicleSettings::max_trains, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, and GameSettings::vehicle.

Referenced by BuildAirToolbarWindow::OnInvalidateData(), BuildDocksToolbarWindow::OnInvalidateData(), and BuildRailToolbarWindow::OnInvalidateData().

◆ CanVehicleUseStation() [1/2]

bool CanVehicleUseStation	(	const Vehicle *	v,
		const Station *	st
	)

Can this station be used by the given vehicle?

Parameters

v	the vehicle to test
st	the station to test for

Returns: true if and only if the vehicle can use this station.

Definition at line 3091 of file vehicle.cpp.

References CanVehicleUseStation(), Vehicle::engine_type, SpecializedVehicle< T, Type >::From(), BaseVehicle::type, and VEH_ROAD.

◆ CanVehicleUseStation() [2/2]

bool CanVehicleUseStation	(	EngineID	engine_type,
		const Station *	st
	)

Can this station be used by the given engine type?

Parameters

engine_type	the type of vehicles to test
st	the station to test for

Returns: true if and only if the vehicle of the type can use this station.

Note: For road vehicles the Vehicle is needed to determine whether it can use the station. This function will return true for road vehicles when at least one of the facilities is available.

Definition at line 3058 of file vehicle.cpp.

References AIR_CTOL, AirportFTAClass::AIRPLANES, Station::airport, FACIL_AIRPORT, FACIL_BUS_STOP, FACIL_DOCK, FACIL_TRAIN, FACIL_TRUCK_STOP, BaseStation::facilities, AirportFTAClass::flags, Airport::GetFTA(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::GetIfValid(), AirportFTAClass::HELICOPTERS, AircraftVehicleInfo::subtype, Engine::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

Referenced by CanVehicleUseStation(), CmdBuildAircraft(), and Aircraft::FindClosestDepot().

◆ CheckClickOnVehicle()

Vehicle* CheckClickOnVehicle	(	const Viewport *	vp,
		int	x,
		int	y
	)

Find the vehicle close to the clicked coordinates.

Parameters

vp	Viewport clicked in.
x	X coordinate in the viewport.
y	Y coordinate in the viewport.

Returns: Closest vehicle, or nullptr if none found.

Definition at line 1248 of file vehicle.cpp.

◆ DecreaseVehicleValue()

void DecreaseVehicleValue ( Vehicle * v )

Decrease the value of a vehicle.

Parameters

v	Vehicle to devaluate.

Definition at line 1301 of file vehicle.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, SetWindowDirty(), Vehicle::value, and WC_VEHICLE_DETAILS.

Referenced by Aircraft::OnNewEconomyDay(), RoadVehicle::OnNewEconomyDay(), Ship::OnNewEconomyDay(), and Train::OnNewEconomyDay().

◆ DoDrawVehicle()

static void DoDrawVehicle ( const Vehicle * v )

static

Add vehicle sprite for drawing to the screen.

Parameters

v	Vehicle to draw.

Definition at line 1124 of file vehicle.cpp.

◆ EconomyAgeVehicle()

void EconomyAgeVehicle ( Vehicle * v )

Update economy age of a vehicle.

Parameters

v	Vehicle to update.

Definition at line 1429 of file vehicle.cpp.

References Vehicle::economy_age, Vehicle::IsPrimaryVehicle(), TimerGameConst< struct Economy >::MAX_DATE, VEHICLE_PROFIT_MIN_AGE, and GroupStatistics::VehicleReachedMinAge().

Referenced by Aircraft::OnNewEconomyDay(), RoadVehicle::OnNewEconomyDay(), Ship::OnNewEconomyDay(), and Train::OnNewEconomyDay().

◆ EnsureNoTrainOnTrackBits()

CommandCost EnsureNoTrainOnTrackBits	(	TileIndex	tile,
		TrackBits	track_bits
	)

Tests if a vehicle interacts with the specified track bits.

All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

Parameters

tile	The tile.
track_bits	The track bits.

Returns: true if no train that interacts, is found. false if a train is found.

Definition at line 608 of file vehicle.cpp.

References VehicleFromPos().

Referenced by CmdConvertRail(), and EnsureNoTrainOnTrack().

◆ EnsureNoVehicleOnGround()

CommandCost EnsureNoVehicleOnGround ( TileIndex tile )

Ensure there is no vehicle at the ground at the given position.

Parameters

tile	Position to examine.

Returns: Succeeded command (ground is free) or failed command (a vehicle is found).

Definition at line 546 of file vehicle.cpp.

References EnsureNoVehicleProcZ(), GetTileMaxPixelZ(), return_cmd_error, BaseVehicle::type, and VehicleFromPos().

Referenced by CheckBuildableTile(), CheckIfIndustryTilesAreFree(), CmdConvertRail(), DoBuildLock(), RemoveAirport(), RemoveBuoy(), RemoveDock(), RemoveFromRailBaseStation(), RemoveLock(), and RemoveRoadWaypointStop().

◆ EnsureNoVehicleProcZ()

static Vehicle* EnsureNoVehicleProcZ	(	Vehicle *	v,
		void *	data
	)

static

Callback that returns 'real' vehicles lower or at height *(int*)data .

Parameters

v	Vehicle to examine.
data	Pointer to height data.

Returns: v if conditions are met, else nullptr.

Definition at line 531 of file vehicle.cpp.

References AIR_SHADOW, Vehicle::subtype, BaseVehicle::type, VEH_AIRCRAFT, VEH_DISASTER, and Vehicle::z_pos.

Referenced by EnsureNoVehicleOnGround().

◆ FindVehicleOnPos()

void FindVehicleOnPos	(	TileIndex	tile,
		void *	data,
		VehicleFromPosProc *	proc
	)

Find a vehicle from a specific location.

It will call proc for ALL vehicles on the tile and YOU must make SURE that the "best one" is stored in the data value and is ALWAYS the same regardless of the order of the vehicles where proc was called on! When you fail to do this properly you create an almost untraceable DESYNC!

Note: The return value of proc will be ignored.; Use this function when you have the intention that all vehicles should be iterated over.

Parameters

tile	The location on the map
data	Arbitrary data passed to proc.
proc	The proc that determines whether a vehicle will be "found".

Definition at line 505 of file vehicle.cpp.

Referenced by BuildDepotVehicleList(), CheckTrainCollision(), CmdConvertRail(), DeleteLastWagon(), FloodVehicles(), FollowTrainReservation(), GetTrainForReservation(), RoadStop::Entry::Rebuild(), and RemoveRoadStop().

◆ FindVehicleOnPosXY()

void FindVehicleOnPosXY	(	int	x,
		int	y,
		void *	data,
		VehicleFromPosProc *	proc
	)

Find a vehicle from a specific location.

It will call proc for ALL vehicles on the tile and YOU must make SURE that the "best one" is stored in the data value and is ALWAYS the same regardless of the order of the vehicles where proc was called on! When you fail to do this properly you create an almost untraceable DESYNC!

Note: The return value of proc will be ignored.; Use this when you have the intention that all vehicles should be iterated over.

Parameters

x	The X location on the map
y	The Y location on the map
data	Arbitrary data passed to proc
proc	The proc that determines whether a vehicle will be "found".

Definition at line 445 of file vehicle.cpp.

Referenced by CheckTrainCollision().

◆ GetEngineLivery()

const Livery* GetEngineLivery	(	EngineID	engine_type,
		CompanyID	company,
		EngineID	parent_engine_type,
		const Vehicle *	v,
		uint8_t	livery_setting
	)

Determines the livery for a vehicle.

Parameters

engine_type	EngineID of the vehicle
company	Owner of the vehicle
parent_engine_type	EngineID of the front vehicle. INVALID_VEHICLE if vehicle is at front itself.
v	the vehicle. nullptr if in purchase list etc.
livery_setting	The livery settings to use for acquiring the livery information.

Returns: livery to use

Definition at line 2064 of file vehicle.cpp.

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

Referenced by LiveryHelper().

◆ GetEngineLiveryScheme()

LiveryScheme GetEngineLiveryScheme	(	EngineID	engine_type,
		EngineID	parent_engine_type,
		const Vehicle *	v
	)

Determines the LiveryScheme for a vehicle.

Parameters

engine_type	Engine of the vehicle.
parent_engine_type	Engine of the front vehicle, INVALID_ENGINE if vehicle is at front itself.
v	the vehicle, `nullptr` if in purchase list etc.

Returns: livery scheme to use.

Definition at line 1970 of file vehicle.cpp.

◆ GetEnginePalette()

PaletteID GetEnginePalette	(	EngineID	engine_type,
		CompanyID	company
	)

Get the colour map for an engine.

This used for unbuilt engines in the user interface.

Parameters

engine_type	ID of engine
company	ID of company

Returns: A ready-to-use palette modifier

Definition at line 2142 of file vehicle.cpp.

◆ GetFreeUnitNumber()

UnitID GetFreeUnitNumber ( VehicleType type )

Get an unused unit number for a vehicle (if allowed).

Parameters

type	Type of vehicle

Returns: A unused unit number for the given type of vehicle if it is allowed to build one, else UINT16_MAX.

Definition at line 1895 of file vehicle.cpp.

References _settings_game, VehicleSettings::max_aircraft, VehicleSettings::max_roadveh, VehicleSettings::max_ships, VehicleSettings::max_trains, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, and GameSettings::vehicle.

Referenced by CheckNewTrain(), and NormaliseTrainHead().

◆ GetNewVehiclePos()

GetNewVehiclePosResult GetNewVehiclePos ( const Vehicle * v )

Get position information of a vehicle when moving one pixel in the direction it is facing.

Parameters

v	Vehicle to move

Returns: Position information after the move

Definition at line 1784 of file vehicle.cpp.

Referenced by DisasterTick_Big_Ufo_Destroyer(), DisasterTick_Submarine(), DisasterTick_Zeppeliner(), and TrainController().

◆ GetVehicleCannotUseStationReason()

StringID GetVehicleCannotUseStationReason	(	const Vehicle *	v,
		const Station *	st
	)

Get reason string why this station can't be used by the given vehicle.

Parameters

v	The vehicle to test.
st	The station to test for.

Returns: The string explaining why the vehicle cannot use the station.

Definition at line 3104 of file vehicle.cpp.

References RoadVehicle::compatible_roadtypes, SpecializedVehicle< T, Type >::From(), Vehicle::HasArticulatedPart(), HasTileAnyRoadType(), IsBayRoadStopTile(), RoadVehicle::IsBus(), RoadStop::next, ROADSTOP_BUS, ROADSTOP_TRUCK, BaseVehicle::type, VEH_ROAD, VEH_TRAIN, and RoadStop::xy.

◆ GetVehiclePalette()

PaletteID GetVehiclePalette ( const Vehicle * v )

Get the colour map for a vehicle.

Parameters

v	Vehicle to get colour map for

Returns: A ready-to-use palette modifier

Definition at line 2152 of file vehicle.cpp.

References Vehicle::IsGroundVehicle().

◆ GetVehicleSet()

void GetVehicleSet	(	VehicleSet &	set,
		Vehicle *	v,
		uint8_t	num_vehicles
	)

Calculates the set of vehicles that will be affected by a given selection.

Parameters

[in,out]	set	Set of affected vehicles.
	v	First vehicle of the selection.
	num_vehicles	Number of vehicles in the selection (not counting articulated parts).

Precondition: set must be empty.

Postcondition: set will contain the vehicles that will be refitted.

Definition at line 3218 of file vehicle.cpp.

References SpecializedVehicle< T, Type >::From(), SpecializedVehicle< T, Type >::GetFirstEnginePart(), include(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::IsArticulatedPart(), GroundVehicle< T, Type >::IsMultiheaded(), SpecializedVehicle< T, Type >::Next(), BaseVehicle::type, and VEH_TRAIN.

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

◆ HasVehicleOnPos()

bool HasVehicleOnPos	(	TileIndex	tile,
		void *	data,
		VehicleFromPosProc *	proc
	)

Checks whether a vehicle is on a specific location.

It will call proc for vehicles until it returns non-nullptr.

Note: Use FindVehicleOnPos when you have the intention that all vehicles should be iterated over.

Parameters

tile	The location on the map
data	Arbitrary data passed to proc.
proc	The proc that determines whether a vehicle will be "found".

Returns: True if proc returned non-nullptr.

Definition at line 520 of file vehicle.cpp.

Referenced by CYapfCostShipT< Types >::PfCalcCost(), TrainApproachingCrossing(), and TrainOnCrossing().

◆ HasVehicleOnPosXY()

bool HasVehicleOnPosXY	(	int	x,
		int	y,
		void *	data,
		VehicleFromPosProc *	proc
	)

Checks whether a vehicle in on a specific location.

It will call proc for vehicles until it returns non-nullptr.

Note: Use FindVehicleOnPosXY when you have the intention that all vehicles should be iterated over.

Parameters

x	The X location on the map
y	The Y location on the map
data	Arbitrary data passed to proc
proc	The proc that determines whether a vehicle will be "found".

Returns: True if proc returned non-nullptr.

Definition at line 461 of file vehicle.cpp.

◆ PreviousOrderIsUnbunching()

static bool PreviousOrderIsUnbunching ( const Vehicle * v )

static

Check if the previous order is a depot unbunching order.

Returns: true Iff the previous order is a depot order with the unbunch flag.

Definition at line 2501 of file vehicle.cpp.

References BaseConsist::cur_implicit_order_index, Vehicle::GetFirstOrder(), Vehicle::GetLastOrder(), Vehicle::GetOrder(), and Order::IsType().

Referenced by Vehicle::IsWaitingForUnbunching(), and Vehicle::LeaveUnbunchingDepot().

◆ RunEconomyVehicleDayProc()

static void RunEconomyVehicleDayProc ( )

static

Increases the day counter for all vehicles and calls 1-day and 32-day handlers.

Each tick, it processes vehicles with "index % DAY_TICKS == TimerGameEconomy::date_fract", so each day, all vehicles are processes in DAY_TICKS steps.

Definition at line 954 of file vehicle.cpp.

◆ ShowNewGrfVehicleError()

void ShowNewGrfVehicleError	(	EngineID	engine,
		StringID	part1,
		StringID	part2,
		GRFBugs	bug_type,
		bool	critical
	)

Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking.

Parameters

engine	The engine that caused the problem
part1	Part 1 of the error message, taking the grfname as parameter 1
part2	Part 2 of the error message, taking the engine as parameter 2
bug_type	Flag to check and set in grfconfig
critical	Shall the "OpenTTD might crash"-message be shown when the player tries to unpause?

Definition at line 317 of file vehicle.cpp.

References _networking, DC_EXEC, Debug, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetGRFConfig(), Engine::GetGRFID(), GRFConfig::GetName(), GetString(), GRFConfig::grf_bugs, HasBit(), PM_PAUSED_ERROR, PM_PAUSED_NORMAL, SetBit(), SetDParam(), SetDParamStr(), ShowErrorMessage(), StrMakeValid(), and WL_CRITICAL.

Referenced by VehicleLengthChanged().

◆ SpawnAdvancedVisualEffect()

static void SpawnAdvancedVisualEffect ( const Vehicle * v )

static

Call CBID_VEHICLE_SPAWN_VISUAL_EFFECT and spawn requested effects.

Parameters

v	Vehicle to create effects for.

Definition at line 2732 of file vehicle.cpp.

◆ TunnelBridgeIsFree()

CommandCost TunnelBridgeIsFree	(	TileIndex	tile,
		TileIndex	endtile,
		const Vehicle *	ignore
	)

Finds vehicle in tunnel / bridge.

Parameters

tile	first end
endtile	second end
ignore	Ignore this vehicle when searching

Returns: Succeeded command (if tunnel/bridge is free) or failed command (if a vehicle is using the tunnel/bridge).

Definition at line 575 of file vehicle.cpp.

References GetVehicleTunnelBridgeProc(), return_cmd_error, BaseVehicle::type, and VehicleFromPos().

Referenced by ClearPathReservation(), CmdConvertRail(), DoClearBridge(), and DoClearTunnel().

◆ VehicleEnterDepot()

void VehicleEnterDepot ( Vehicle * v )

Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it, etc.

Parameters

v	Vehicle that entered a depot.

Definition at line 1552 of file vehicle.cpp.

References _settings_client, CCF_ARRANGE, ClrBit(), Train::ConsistChanged(), Vehicle::First(), SpecializedVehicle< Ship, VEH_SHIP >::From(), SpecializedVehicle< T, Type >::From(), SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), ClientSettings::gui, HandleAircraftEnterHangar(), INVALID_DIAGDIR, MarkTileDirtyByTile(), Vehicle::owner, SetDepotReservation(), SetWindowClassesDirty(), SetWindowDirty(), GUISettings::show_track_reservation, Ship::state, TFP_NONE, Vehicle::tile, TRACK_BIT_DEPOT, BaseVehicle::type, Ship::UpdateCache(), UpdateSignalsOnSegment(), SpecializedVehicle< T, Type >::UpdateViewport(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, VRF_TOGGLE_REVERSE, Train::wait_counter, WC_AIRCRAFT_LIST, WC_ROADVEH_LIST, WC_SHIPS_LIST, WC_TRAINS_LIST, and WC_VEHICLE_DEPOT.

Referenced by AircraftEventHandler_EnterHangar().

◆ VehicleEnteredDepotThisTick()

void VehicleEnteredDepotThisTick ( Vehicle * v )

Adds a vehicle to the list of vehicles that visited a depot this tick.

Parameters

*v	vehicle to add

Definition at line 921 of file vehicle.cpp.

◆ VehicleEnterTile()

VehicleEnterTileStatus VehicleEnterTile	(	Vehicle *	v,
		TileIndex	tile,
		int	x,
		int	y
	)

Call the tile callback function for a vehicle entering a tile.

Parameters

v	Vehicle entering the tile
tile	Tile entered
x	X position
y	Y position

Returns: Some meta-data over the to be entered tile.

See also: VehicleEnterTileStatus to see what the bits in the return value mean.

Definition at line 1838 of file vehicle.cpp.

Referenced by TrainController(), and UpdateStatusAfterSwap().

◆ VehicleFromPos()

static Vehicle* VehicleFromPos	(	TileIndex	tile,
		void *	data,
		VehicleFromPosProc *	proc,
		bool	find_first
	)

static

Helper function for FindVehicleOnPos/HasVehicleOnPos.

Note: Do not call this function directly!

Parameters

tile	The location on the map
data	Arbitrary data passed to proc.
proc	The proc that determines whether a vehicle will be "found".
find_first	Whether to return on the first found or iterate over all vehicles

Returns: the best matching or first vehicle (depending on find_first).

Definition at line 476 of file vehicle.cpp.

Referenced by EnsureNoTrainOnTrackBits(), EnsureNoVehicleOnGround(), and TunnelBridgeIsFree().

◆ VehicleFromPosXY()

static Vehicle* VehicleFromPosXY	(	int	x,
		int	y,
		void *	data,
		VehicleFromPosProc *	proc,
		bool	find_first
	)

static

Helper function for FindVehicleOnPos/HasVehicleOnPos.

Note: Do not call this function directly!

Parameters

x	The X location on the map
y	The Y location on the map
data	Arbitrary data passed to proc
proc	The proc that determines whether a vehicle will be "found".
find_first	Whether to return on the first found or iterate over all vehicles

Returns: the best matching or first vehicle (depending on find_first).

Definition at line 418 of file vehicle.cpp.

◆ VehicleLengthChanged()

void VehicleLengthChanged ( const Vehicle * u )

Logs a bug in GRF and shows a warning message if this is for the first time this happened.

Parameters

u	first vehicle of chain

Definition at line 346 of file vehicle.cpp.

References _gamelog, Vehicle::engine_type, GBUG_VEH_LENGTH, Vehicle::GetEngine(), GetGRFConfig(), GRFConfig::grf_bugs, Engine::grf_prop, Gamelog::GRFBugReverse(), GRFFilePropsBase< Tcnt >::grffile, HasBit(), GRFFilePropsBase< Tcnt >::local_id, and ShowNewGrfVehicleError().

Referenced by RoadVehUpdateCache().

◆ VehicleServiceInDepot()

void VehicleServiceInDepot ( Vehicle * v )

Service a vehicle and all subsequent vehicles in the consist.

Parameters

*v	The vehicle or vehicle chain being serviced

Definition at line 167 of file vehicle.cpp.

References _settings_game, Vehicle::breakdown_chance, Vehicle::breakdowns_since_last_service, TimerGameCalendar::date, TimerGameEconomy::date, Vehicle::date_of_last_service, Vehicle::date_of_last_service_newgrf, GameSettings::difficulty, Vehicle::GetEngine(), Vehicle::HasEngineType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::Next(), Engine::reliability, Vehicle::reliability, SetWindowDirty(), DifficultySettings::vehicle_breakdowns, and WC_VEHICLE_DETAILS.

Referenced by AircraftLeaveHangar(), and CheckIfTrainNeedsService().

◆ VehiclesHaveSameEngineList()

bool VehiclesHaveSameEngineList	(	const Vehicle *	v1,
		const Vehicle *	v2
	)

Checks if two vehicle chains have the same list of engines.

Parameters

v1	First vehicle chain.
v1	Second vehicle chain.

Returns: True if same, false if different.

Definition at line 3272 of file vehicle.cpp.

References Vehicle::GetEngine(), and Vehicle::GetNextVehicle().

Referenced by DepotWindow::OnVehicleSelect().

◆ VehiclesHaveSameOrderList()

bool VehiclesHaveSameOrderList	(	const Vehicle *	v1,
		const Vehicle *	v2
	)

Checks if two vehicles have the same list of orders.

Parameters

v1	First vehicles.
v1	Second vehicles.

Returns: True if same, false if different.

Definition at line 3289 of file vehicle.cpp.

References Order::Equals(), Vehicle::GetFirstOrder(), and Order::next.

Referenced by DepotWindow::OnVehicleSelect(), and OrdersWindow::OnVehicleSelect().

◆ ViewportAddVehicles()

void ViewportAddVehicles ( DrawPixelInfo * dpi )

Add the vehicle sprites that should be drawn at a part of the screen.

Parameters

dpi	Rectangle being drawn.

Definition at line 1154 of file vehicle.cpp.

References MAX_VEHICLE_PIXEL_X.

Variable Documentation

◆ _breakdown_chance

const uint8_t _breakdown_chance[64]

static

Initial value:

= {
    3,   3,   3,   3,   3,   3,   3,   3,
    4,   4,   5,   5,   6,   6,   7,   7,
    8,   8,   9,   9,  10,  10,  11,  11,
   12,  13,  13,  13,  13,  14,  15,  16,
   17,  19,  21,  25,  28,  31,  34,  37,
   40,  44,  48,  52,  56,  60,  64,  68,
   72,  80,  90, 100, 110, 120, 130, 140,
  150, 170, 190, 210, 230, 250, 250, 250,
}

Definition at line 1307 of file vehicle.cpp.

◆ _new_direction_table

const Direction _new_direction_table[]

static

Initial value:

= {
  DIR_N,  DIR_NW, DIR_W,
  DIR_NE, DIR_SE, DIR_SW,
  DIR_E,  DIR_SE, DIR_S
}

Definition at line 1802 of file vehicle.cpp.

◆ _vehicle_smoke_pos

const int8_t _vehicle_smoke_pos[8]

static

Initial value:

= {
  1, 1, 1, 0, -1, -1, -1, 0
}

Definition at line 2724 of file vehicle.cpp.

Macros

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ AutoreplaceMap

Function Documentation

◆ AgeVehicle()

◆ CalcPercentVehicleFilled()

◆ CanBuildVehicleInfrastructure()

◆ CanVehicleUseStation() [1/2]

◆ CanVehicleUseStation() [2/2]

◆ CheckClickOnVehicle()

◆ DecreaseVehicleValue()

◆ DoDrawVehicle()

◆ EconomyAgeVehicle()

◆ EnsureNoTrainOnTrackBits()

◆ EnsureNoVehicleOnGround()

◆ EnsureNoVehicleProcZ()

◆ FindVehicleOnPos()

◆ FindVehicleOnPosXY()

◆ GetEngineLivery()

◆ GetEngineLiveryScheme()

◆ GetEnginePalette()

◆ GetFreeUnitNumber()

◆ GetNewVehiclePos()

◆ GetVehicleCannotUseStationReason()

◆ GetVehiclePalette()

◆ GetVehicleSet()

◆ HasVehicleOnPos()

◆ HasVehicleOnPosXY()

◆ PreviousOrderIsUnbunching()

◆ RunEconomyVehicleDayProc()

◆ ShowNewGrfVehicleError()

◆ SpawnAdvancedVisualEffect()

◆ TunnelBridgeIsFree()

◆ VehicleEnterDepot()

◆ VehicleEnteredDepotThisTick()

◆ VehicleEnterTile()

◆ VehicleFromPos()

◆ VehicleFromPosXY()

◆ VehicleLengthChanged()

◆ VehicleServiceInDepot()

◆ VehiclesHaveSameEngineList()

◆ VehiclesHaveSameOrderList()

◆ ViewportAddVehicles()

Variable Documentation

◆ _breakdown_chance

◆ _new_direction_table

◆ _vehicle_smoke_pos