Implementation of articulated vehicles. More...

#include "stdafx.h"
#include "core/bitmath_func.hpp"
#include "core/random_func.hpp"
#include "train.h"
#include "roadveh.h"
#include "vehicle_func.h"
#include "engine_func.h"
#include "company_func.h"
#include "newgrf.h"
#include "table/strings.h"
#include "safeguards.h"

Functions
static EngineID	GetNextArticulatedPart (uint index, EngineID front_type, Vehicle front=nullptr, bool mirrored=nullptr)
	Determines the next articulated part to attach.

bool	IsArticulatedEngine (EngineID engine_type)
	Does a NewGRF report that this should be an articulated vehicle?

uint	CountArticulatedParts (EngineID engine_type, bool purchase_window)
	Count the number of articulated parts of an engine.

static std::pair< CargoID, uint16_t >	GetVehicleDefaultCapacity (EngineID engine)
	Returns the default (non-refitted) cargo and capacity of a specific EngineID.

static CargoTypes	GetAvailableVehicleCargoTypes (EngineID engine, bool include_initial_cargo_type)
	Returns all cargoes a vehicle can carry.

CargoArray	GetCapacityOfArticulatedParts (EngineID engine)
	Get the capacity of the parts of a given engine.

CargoTypes	GetCargoTypesOfArticulatedParts (EngineID engine)
	Get the cargo mask of the parts of a given engine.

bool	IsArticulatedVehicleRefittable (EngineID engine)
	Checks whether any of the articulated parts is refittable.

void	GetArticulatedRefitMasks (EngineID engine, bool include_initial_cargo_type, CargoTypes union_mask, CargoTypes intersection_mask)
	Merges the refit_masks of all articulated parts.

CargoTypes	GetUnionOfArticulatedRefitMasks (EngineID engine, bool include_initial_cargo_type)
	Ors the refit_masks of all articulated parts.

CargoTypes	GetCargoTypesOfArticulatedVehicle (const Vehicle v, CargoID cargo_type)
	Get cargo mask of all cargoes carried by an articulated vehicle.

void	CheckConsistencyOfArticulatedVehicle (const Vehicle *v)
	Checks whether the specs of freshly build articulated vehicles are consistent with the information specified in the purchase list.

void	AddArticulatedParts (Vehicle *first)
	Add the remaining articulated parts to the given vehicle.

Variables
static const uint	MAX_ARTICULATED_PARTS = 100
	Maximum of articulated parts per vehicle, i.e. when to abort calling the articulated vehicle callback.

Detailed Description

Implementation of articulated vehicles.

Definition in file articulated_vehicles.cpp.

Function Documentation

◆ AddArticulatedParts()

void AddArticulatedParts ( Vehicle * first )

Add the remaining articulated parts to the given vehicle.

Parameters

first The head of the articulated bit.

Definition at line 338 of file articulated_vehicles.cpp.

References Vehicle::build_year, GroundVehicleCache::cached_veh_length, EngineInfo::callback_mask, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::CanAllocateItem(), Engine::CanCarryCargo(), RailVehicleInfo::capacity, Vehicle::cargo_cap, Vehicle::cargo_subtype, Vehicle::cargo_type, CBM_VEHICLE_ARTIC_ENGINE, RoadVehicle::compatible_roadtypes, Vehicle::date_of_last_service, Vehicle::date_of_last_service_newgrf, Vehicle::direction, Vehicle::engine_type, GroundVehicleCache::first_engine, SpecializedVehicle< T, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), Engine::GetDefaultCargoType(), Vehicle::GetGroundVehicleCache(), GetNextArticulatedPart(), HasBit(), INVALID_ENGINE, IsValidCargoID(), Vehicle::max_age, MAX_ARTICULATED_PARTS, Vehicle::owner, Vehicle::random_bits, Vehicle::refit_cap, RoadVehicle::roadtype, RVSB_IN_DEPOT, VehicleSpriteSeq::Set(), GroundVehicle< T, Type >::SetArticulatedPart(), SetBit(), Vehicle::SetNext(), Vehicle::sprite_cache, MutableSpriteCache::sprite_seq, Vehicle::spritenum, RoadVehicle::state, Vehicle::subtype, TestVehicleBuildProbability(), Vehicle::tile, BaseVehicle::type, Vehicle::UpdatePosition(), Vehicle::value, VEH_ROAD, VEH_TRAIN, VEHICLE_LENGTH, Vehicle::vehstatus, VRF_REVERSE_DIRECTION, Vehicle::x_pos, Vehicle::y_pos, and Vehicle::z_pos.

Referenced by CmdBuildRailVehicle(), CmdBuildRailWagon(), and CmdBuildRoadVehicle().

◆ CheckConsistencyOfArticulatedVehicle()

void CheckConsistencyOfArticulatedVehicle ( const Vehicle * v )

Checks whether the specs of freshly build articulated vehicles are consistent with the information specified in the purchase list.

Only essential information is checked to leave room for magic tricks/workarounds to grfcoders. It checks: For autoreplace/-renew:

Default cargo type (without capacity)
intersection and union of refit masks.

Definition at line 296 of file articulated_vehicles.cpp.

References Vehicle::cargo_cap, Vehicle::cargo_type, Vehicle::engine_type, GBUG_VEH_REFIT, GetArticulatedRefitMasks(), GetAvailableVehicleCargoTypes(), GetCapacityOfArticulatedParts(), Vehicle::GetEngine(), Vehicle::GetNextArticulatedPart(), Vehicle::HasArticulatedPart(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, NUM_CARGO, SetBit(), and ShowNewGrfVehicleError().

Referenced by CmdBuildRailVehicle(), CmdBuildRailWagon(), and CmdBuildRoadVehicle().

◆ CountArticulatedParts()

uint CountArticulatedParts	(	EngineID	engine_type,
		bool	purchase_window
	)

Count the number of articulated parts of an engine.

Parameters

engine_type	The engine to get the number of parts of.
purchase_window	Whether we are in the scope of the purchase window or not, i.e. whether we cannot allocate vehicles.

Returns: The number of parts.

Definition at line 75 of file articulated_vehicles.cpp.

References _current_company, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::CanAllocateItem(), CBM_VEHICLE_ARTIC_ENGINE, Vehicle::engine_type, GetNextArticulatedPart(), HasBit(), INVALID_ENGINE, MAX_ARTICULATED_PARTS, and Vehicle::owner.

Referenced by CmdBuildVehicle().

◆ GetArticulatedRefitMasks()

void GetArticulatedRefitMasks	(	EngineID	engine,
		bool	include_initial_cargo_type,
		CargoTypes *	union_mask,
		CargoTypes *	intersection_mask
	)

Merges the refit_masks of all articulated parts.

Parameters

engine	the first part
include_initial_cargo_type	if true the default cargo type of the vehicle is included; if false only the refit_mask
union_mask	returns bit mask of CargoIDs which are a refit option for at least one articulated part
intersection_mask	returns bit mask of CargoIDs which are a refit option for every articulated part (with default capacity > 0)

Definition at line 224 of file articulated_vehicles.cpp.

References EngineInfo::callback_mask, CBM_VEHICLE_ARTIC_ENGINE, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetAvailableVehicleCargoTypes(), GetNextArticulatedPart(), HasBit(), INVALID_ENGINE, Engine::IsGroundVehicle(), and MAX_ARTICULATED_PARTS.

Referenced by CheckConsistencyOfArticulatedVehicle(), GetNewCargoTypeForReplace(), GetUnionOfArticulatedRefitMasks(), and Vehicle::NeedsServicing().

◆ GetAvailableVehicleCargoTypes()

static CargoTypes GetAvailableVehicleCargoTypes	(	EngineID	engine,
		bool	include_initial_cargo_type
	)

inlinestatic

Returns all cargoes a vehicle can carry.

Parameters

engine	the EngineID of interest
include_initial_cargo_type	if true the default cargo type of the vehicle is included; if false only the refit_mask

Returns: bit set of CargoIDs

Definition at line 119 of file articulated_vehicles.cpp.

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

Referenced by CheckConsistencyOfArticulatedVehicle(), and GetArticulatedRefitMasks().

◆ GetCapacityOfArticulatedParts()

CargoArray GetCapacityOfArticulatedParts ( EngineID engine )

Get the capacity of the parts of a given engine.

Parameters

engine The engine to get the capacities from.

Returns: The cargo capacities.

Definition at line 138 of file articulated_vehicles.cpp.

References EngineInfo::callback_mask, CBM_VEHICLE_ARTIC_ENGINE, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetNextArticulatedPart(), GetVehicleDefaultCapacity(), HasBit(), INVALID_ENGINE, Engine::IsGroundVehicle(), IsValidCargoID(), and MAX_ARTICULATED_PARTS.

Referenced by CheckConsistencyOfArticulatedVehicle(), CmdBuildVehicle(), and GetTotalCapacityOfArticulatedParts().

◆ GetCargoTypesOfArticulatedParts()

CargoTypes GetCargoTypesOfArticulatedParts ( EngineID engine )

Get the cargo mask of the parts of a given engine.

Parameters

engine The engine to get the capacities from.

Returns: The cargo mask.

Definition at line 168 of file articulated_vehicles.cpp.

References EngineInfo::callback_mask, CBM_VEHICLE_ARTIC_ENGINE, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetNextArticulatedPart(), GetVehicleDefaultCapacity(), HasBit(), INVALID_ENGINE, Engine::IsGroundVehicle(), IsValidCargoID(), MAX_ARTICULATED_PARTS, and SetBit().

Referenced by GetNewCargoTypeForReplace(), and Vehicle::NeedsServicing().

◆ GetCargoTypesOfArticulatedVehicle()

CargoTypes GetCargoTypesOfArticulatedVehicle	(	const Vehicle *	v,
		CargoID *	cargo_type
	)

Get cargo mask of all cargoes carried by an articulated vehicle.

Note: Vehicles not carrying anything are ignored

Parameters

v	the first vehicle in the chain
cargo_type	returns the common CargoID if needed. (INVALID_CARGO if no part is carrying something or they are carrying different things)