Functions related to articulated vehicles. More...
#include "vehicle_type.h"
#include "engine_type.h"
Go to the source code of this file.
Functions | |
uint | CountArticulatedParts (EngineID engine_type, bool purchase_window) |
CargoArray | GetCapacityOfArticulatedParts (EngineID engine) |
void | AddArticulatedParts (Vehicle *first) |
void | GetArticulatedRefitMasks (EngineID engine, bool include_initial_cargo_type, uint32 *union_mask, uint32 *intersection_mask) |
Merges the refit_masks of all articulated parts. | |
uint32 | GetUnionOfArticulatedRefitMasks (EngineID engine, bool include_initial_cargo_type) |
Ors the refit_masks of all articulated parts. | |
uint32 | GetIntersectionOfArticulatedRefitMasks (EngineID engine, bool include_initial_cargo_type) |
Ands the refit_masks of all articulated parts. | |
bool | IsArticulatedVehicleCarryingDifferentCargos (const Vehicle *v, CargoID *cargo_type) |
Tests if all parts of an articulated vehicle are refitted to the same cargo. | |
bool | IsArticulatedVehicleRefittable (EngineID engine) |
Checks whether any of the articulated parts is refittable. | |
void | CheckConsistencyOfArticulatedVehicle (const Vehicle *v) |
Checks whether the specs of freshly build articulated vehicles are consistent with the information specified in the purchase list. |
Functions related to articulated vehicles.
Definition in file articulated_vehicles.h.
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:
Definition at line 241 of file articulated_vehicles.cpp.
References Vehicle::cargo_cap, Vehicle::cargo_type, Vehicle::engine_type, GBUG_VEH_REFIT, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetArticulatedRefitMasks(), GetAvailableVehicleCargoTypes(), Vehicle::GetNextArticulatedPart(), Vehicle::HasArticulatedPart(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem< Tpool >::index, NUM_CARGO, and ShowNewGrfVehicleError().
Referenced by CmdBuildRailVehicle(), CmdBuildRailWagon(), and CmdBuildRoadVehicle().
void GetArticulatedRefitMasks | ( | EngineID | engine, | |
bool | include_initial_cargo_type, | |||
uint32 * | union_mask, | |||
uint32 * | intersection_mask | |||
) |
Merges the refit_masks of all articulated parts.
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 159 of file articulated_vehicles.cpp.
References EngineInfo::callback_mask, CBM_VEHICLE_ARTIC_ENGINE, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetAvailableVehicleCargoTypes(), GetNextArticulatedPart(), HasBit(), and Engine::IsGroundVehicle().
Referenced by CheckConsistencyOfArticulatedVehicle(), GetIntersectionOfArticulatedRefitMasks(), GetNewCargoTypeForReplace(), GetUnionOfArticulatedRefitMasks(), and Vehicle::NeedsServicing().
uint32 GetIntersectionOfArticulatedRefitMasks | ( | EngineID | engine, | |
bool | include_initial_cargo_type | |||
) |
Ands the refit_masks of all articulated parts.
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 |
Definition at line 198 of file articulated_vehicles.cpp.
References GetArticulatedRefitMasks().
uint32 GetUnionOfArticulatedRefitMasks | ( | EngineID | engine, | |
bool | include_initial_cargo_type | |||
) |
Ors the refit_masks of all articulated parts.
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 |
Definition at line 185 of file articulated_vehicles.cpp.
References GetArticulatedRefitMasks().
Referenced by AIEngine::CanRefitCargo(), CargoFilter(), EnginesHaveCargoInCommon(), ShowRefitOptionsList(), and VerifyAutoreplaceRefitForOrders().
Tests if all parts of an articulated vehicle are refitted to the same cargo.
Note: Vehicles not carrying anything are ignored
v | the first vehicle in the chain | |
cargo_type | returns the common CargoID if needed. (CT_INVALID if no part is carrying something or they are carrying different things) |
Definition at line 213 of file articulated_vehicles.cpp.
References Vehicle::cargo_cap, Vehicle::cargo_type, CT_INVALID, Vehicle::GetNextArticulatedPart(), and Vehicle::HasArticulatedPart().
Referenced by GetNewCargoTypeForReplace(), and Vehicle::NeedsServicing().
bool IsArticulatedVehicleRefittable | ( | EngineID | engine | ) |
Checks whether any of the articulated parts is refittable.
engine | the first part |
Definition at line 133 of file articulated_vehicles.cpp.
References EngineInfo::callback_mask, CBM_VEHICLE_ARTIC_ENGINE, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetNextArticulatedPart(), HasBit(), IsEngineRefittable(), and Engine::IsGroundVehicle().
Referenced by DrawVehiclePurchaseInfo().