Functions | Variables

engine_func.h File Reference

Functions related to engines. More...

#include "engine_type.h"
#include "vehicle_type.h"
#include "company_type.h"

Go to the source code of this file.

Functions

void SetupEngines ()
 Initialise the engine pool with the data from the original vehicles.
void StartupEngines ()
 Start/initialise all our engines.
bool IsEngineBuildable (EngineID engine, VehicleType type, CompanyID company)
 Check if an engine is buildable.
bool IsEngineRefittable (EngineID engine)
 Check if an engine is refittable.
void SetCachedEngineCounts ()
 Sets cached values in Company::num_vehicles and Group::num_vehicles.
void SetYearEngineAgingStops ()
 Compute the value for _year_engine_aging_stops.
void StartupOneEngine (Engine *e, Date aging_date)
 Start/initialise one engine.
uint GetTotalCapacityOfArticulatedParts (EngineID engine)
 Get the capacity of an engine with articulated parts.

Variables

const uint8 _engine_counts [4]
 Number of engines of each vehicle type in original engine data.
const uint8 _engine_offsets [4]
 Offset of the first engine of each vehicle type in original engine data.

Detailed Description

Functions related to engines.

Definition in file engine_func.h.


Function Documentation

uint GetTotalCapacityOfArticulatedParts ( EngineID  engine  ) 

Get the capacity of an engine with articulated parts.

Parameters:
engine The engine to get the capacity of.
Returns:
The capacity.

Definition at line 136 of file engine_gui.cpp.

References GetCapacityOfArticulatedParts().

Referenced by RoadVehEngineCapacitySorter(), and TrainEngineCapacitySorter().

bool IsEngineBuildable ( EngineID  engine,
VehicleType  type,
CompanyID  company 
)

Check if an engine is buildable.

Parameters:
engine index of the engine to check.
type the type the engine should be.
company index of the company.
Returns:
True if an engine is valid, of the specified type, and buildable by the given company.

Definition at line 961 of file engine.cpp.

References CompanyProperties::avail_railtypes, Engine::company_avail, 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 >::GetIfValid(), GetRailTypeInfo(), HasBit(), Engine::IsEnabled(), Engine::type, and VEH_TRAIN.

Referenced by CheckAutoreplaceValidity(), CmdBuildRoadVehicle(), CmdBuildShip(), CmdBuildVehicle(), GetNewEngineType(), AIEngine::IsBuildable(), and AIEngine::IsValidEngine().

bool IsEngineRefittable ( EngineID  engine  ) 

Check if an engine is refittable.

Note: Likely you want to use IsArticulatedVehicleRefittable().

Parameters:
engine index of the engine to check.
Returns:
true if the engine is refittable.

Definition at line 991 of file engine.cpp.

References EngineInfo::callback_mask, Engine::CanCarryCargo(), CBM_VEHICLE_CARGO_SUFFIX, CT_INVALID, Engine::GetDefaultCargoType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::GetIfValid(), and HasBit().

Referenced by IsArticulatedVehicleRefittable(), and IsVehicleRefitable().

void SetYearEngineAgingStops (  ) 
void StartupEngines (  ) 
void StartupOneEngine ( Engine e,
Date  aging_date 
)