engine_func.h File Reference

Functions related to engines. More...

#include "engine_type.h"
#include "vehicle_type.h"
#include "company_type.h"
#include "timer/timer_game_calendar.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.
void	CheckEngines ()
	Check for engines that have an appropriate availability.
uint8_t	GetOriginalEngineCount (VehicleType type)
	Get the number of original engines for a VehicleType.
uint8_t	GetOriginalEngineOffset (VehicleType type)
	Get the index offset for original engines of a VehicleType.
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	SetYearEngineAgingStops ()
	Compute the value for _year_engine_aging_stops.
void	CalcEngineReliability (Engine *e, bool new_month)
	Update Engine::reliability and (if needed) update the engine GUIs.
void	StartupOneEngine (Engine *e, const TimerGameCalendar::YearMonthDay &aging_ymd, uint32_t seed)
	Start/initialise one engine.
uint	GetTotalCapacityOfArticulatedParts (EngineID engine)
	Get the capacity of an engine with articulated parts.

Detailed Description

Functions related to engines.

Definition in file engine_func.h.

Function Documentation

CalcEngineReliability()

void CalcEngineReliability	(	Engine *	e,
		bool	new_month )

Update Engine::reliability and (if needed) update the engine GUIs.

Parameters

e	Engine to update.
new_month	Whether this is called from a 'new month' context or not, i.e. whether engines should be aged.

Definition at line 674 of file engine.cpp.

References _settings_game, AddRemoveEngineFromAutoreplaceAndBuildWindows(), Engine::age, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), EngineInfo::base_life, ClearLastVariant(), Engine::company_avail, Engine::duration_phase_1, Engine::duration_phase_2, Engine::duration_phase_3, Engine::reliability, Engine::reliability_final, Engine::reliability_max, Engine::reliability_start, EngineInfo::retire_early, SyncReliability, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), Engine::type, and EngineInfo::variant_id.

Referenced by CalendarEnginesMonthlyLoop(), FixTTOEngines(), and StartupEngines().

CheckEngines()

void CheckEngines

(

)

Check for engines that have an appropriate availability.

Definition at line 1339 of file engine.cpp.

References Available, GetEncodedString(), RailVehicleInfo::railveh_type, ShowErrorMessage(), Train, Wagon, and WL_WARNING.

GetOriginalEngineCount()

uint8_t GetOriginalEngineCount

(

VehicleType

type

)

Get the number of original engines for a VehicleType.

Parameters

type	the vehicle type

Returns

the number of original engines of the given type

Number of engines of each vehicle type in original engine data

Definition at line 58 of file engine.cpp.

References IsCompanyBuildableVehicleType(), and lengthof.

Referenced by GetNewEngine(), ParamSet(), EngineOverrideManager::ResetToDefaultMapping(), and SetupEngines().

GetOriginalEngineOffset()

uint8_t GetOriginalEngineOffset

(

VehicleType

type

)

Get the index offset for original engines of a VehicleType.

Parameters

type	the vehicle type

Returns

the index offset for original engines of the given type

Offset of the first engine of each vehicle type in original engine data

Definition at line 77 of file engine.cpp.

References IsCompanyBuildableVehicleType(), and lengthof.

Referenced by ParamSet().

GetTotalCapacityOfArticulatedParts()

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 300 of file engine_gui.cpp.

References GetCapacityOfArticulatedParts(), and CargoArray::GetSum().

Referenced by DrawEngineList(), RoadVehEngineCapacitySorter(), and TrainEngineCapacitySorter().

IsEngineBuildable()

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 1274 of file engine.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), Company::avail_railtypes, Company::avail_roadtypes, Available, Engine::company_avail, Engine::flags, GetAllCompatibleRailTypes(), GetRoadTypeInfo(), Engine::IsEnabled(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::None(), OWNER_DEITY, RoadTypeInfo::powered_roadtypes, RailVehicleInfo::railtypes, Road, RoadVehicleInfo::roadtype, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), Train, and Engine::type.

Referenced by CheckAutoreplaceValidity(), CmdBuildVehicle(), CmdSetVehicleVisibility(), BuildVehicleWindow::GenerateBuildAircraftList(), BuildVehicleWindow::GenerateBuildRoadVehList(), BuildVehicleWindow::GenerateBuildShipList(), and GetNewEngineType().

IsEngineRefittable()

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 1315 of file engine.cpp.

References EngineInfo::callback_mask, Engine::CanCarryCargo(), CargoSuffix, Engine::GetDefaultCargoType(), IsValidCargoType(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::None(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by IsArticulatedVehicleRefittable(), IsVehicleRefittable(), and OrdersWindow::UpdateAutoRefitState().

SetupEngines()

void SetupEngines

(

)

Initialise the engine pool with the data from the original vehicles.

Definition at line 627 of file engine.cpp.

References Begin, CloseWindowByClass(), CompanyEnd, GetOriginalEngineCount(), and WC_ENGINE_PREVIEW.

Referenced by ResetNewGRFData().

SetYearEngineAgingStops()

void SetYearEngineAgingStops

(

)

Compute the value for _year_engine_aging_stops.

Definition at line 720 of file engine.cpp.

References _settings_game, _year_engine_aging_stops, EngineInfo::base_intro, EngineInfo::climates, TimerGameCalendar::ConvertDateToYMD(), TimerGameConst< struct Calendar >::DAYS_IN_LEAP_YEAR, EngineInfo::lifelength, RailVehicleInfo::railveh_type, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), Train, and Wagon.

Referenced by AfterLoadGRFs().

StartupEngines()

void StartupEngines

(

)

Start/initialise all our engines.

Must be called whenever there are changes to the NewGRF config.

Definition at line 826 of file engine.cpp.

References _year_engine_aging_stops, CalcEngineReliability(), TimerGameCalendar::ConvertDateToYMD(), TimerGameCalendar::ConvertYMDToDate(), TimerGameCalendar::date, GetCompanyRailTypes(), GetCompanyRoadTypes(), InvalidateWindowClassesData(), SetWindowClassesDirty(), StartupOneEngine(), WC_BUILD_VEHICLE, and WC_REPLACE_VEHICLE.

Referenced by _GenerateWorld(), AfterLoadGame(), ConResetEngines(), SaveLoadWindow::OnTimeout(), and ReloadNewGRFData().

StartupOneEngine()

void StartupOneEngine	(	Engine *	e,
		const TimerGameCalendar::YearMonthDay &	aging_ymd,
		uint32_t	seed )

Start/initialise one engine.

Parameters

e	The engine to initialise.
aging_ymd	The date used for age calculations.
seed	Random seed.

Definition at line 745 of file engine.cpp.

References _settings_game, Engine::age, Available, EngineInfo::base_intro, EngineInfo::base_life, EngineInfo::climates, Engine::company_avail, Engine::company_hidden, TimerGameCalendar::ConvertDateToYMD(), TimerGameCalendar::ConvertYMDToDate(), TimerGameCalendar::date, Engine::duration_phase_1, Engine::duration_phase_2, Engine::duration_phase_3, Engine::flags, GB(), Engine::GetGRFID(), Engine::intro_date, EngineInfo::lifelength, Engine::reliability_final, Engine::reliability_max, Engine::reliability_spd_dec, Engine::reliability_start, RestoreRandomSeeds(), EngineInfo::retire_early, SaveRandomSeeds(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), SetRandomSeed(), SyncReliability, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), to_underlying(), Engine::type, and EngineInfo::variant_id.

Referenced by FixTTOEngines(), and StartupEngines().