OpenTTD
Functions
autoreplace_cmd.cpp File Reference

Deals with autoreplace execution but not the setup. More...

#include "stdafx.h"
#include "company_func.h"
#include "train.h"
#include "command_func.h"
#include "engine_func.h"
#include "vehicle_func.h"
#include "autoreplace_func.h"
#include "autoreplace_gui.h"
#include "articulated_vehicles.h"
#include "core/random_func.hpp"
#include "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

void ChangeVehicleViewports (VehicleID from_index, VehicleID to_index)
 Switches viewports following vehicles, which get autoreplaced. More...
 
void ChangeVehicleNews (VehicleID from_index, VehicleID to_index)
 Report a change in vehicle IDs (due to autoreplace) to affected vehicle news. More...
 
void ChangeVehicleViewWindow (VehicleID from_index, VehicleID to_index)
 Report a change in vehicle IDs (due to autoreplace) to affected vehicle windows. More...
 
static bool EnginesHaveCargoInCommon (EngineID engine_a, EngineID engine_b)
 Figure out if two engines got at least one type of cargo in common (refitting if needed) More...
 
bool CheckAutoreplaceValidity (EngineID from, EngineID to, CompanyID company)
 Checks some basic properties whether autoreplace is allowed. More...
 
void CheckCargoCapacity (Vehicle *v)
 Check the capacity of all vehicles in a chain and spread cargo if needed. More...
 
static void TransferCargo (Vehicle *old_veh, Vehicle *new_head, bool part_of_chain)
 Transfer cargo from a single (articulated )old vehicle to the new vehicle chain. More...
 
static bool VerifyAutoreplaceRefitForOrders (const Vehicle *v, EngineID engine_type)
 Tests whether refit orders that applied to v will also apply to the new vehicle type. More...
 
static CargoID GetNewCargoTypeForReplace (Vehicle *v, EngineID engine_type, bool part_of_chain)
 Function to find what type of cargo to refit to when autoreplacing. More...
 
static CommandCost GetNewEngineType (const Vehicle *v, const Company *c, bool always_replace, EngineID &e)
 Get the EngineID of the replacement for a vehicle. More...
 
static CommandCost BuildReplacementVehicle (Vehicle *old_veh, Vehicle **new_vehicle, bool part_of_chain)
 Builds and refits a replacement vehicle Important: The old vehicle is still in the original vehicle chain (used for determining the cargo when the old vehicle did not carry anything, but the new one does) More...
 
static CommandCost CmdStartStopVehicle (const Vehicle *v, bool evaluate_callback)
 Issue a start/stop command. More...
 
static CommandCost CmdMoveVehicle (const Vehicle *v, const Vehicle *after, DoCommandFlag flags, bool whole_chain)
 Issue a train vehicle move command. More...
 
static CommandCost CopyHeadSpecificThings (Vehicle *old_head, Vehicle *new_head, DoCommandFlag flags)
 Copy head specific things to the new vehicle chain after it was successfully constructed. More...
 
static CommandCost ReplaceFreeUnit (Vehicle **single_unit, DoCommandFlag flags, bool *nothing_to_do)
 Replace a single unit in a free wagon chain. More...
 
static CommandCost ReplaceChain (Vehicle **chain, DoCommandFlag flags, bool wagon_removal, bool *nothing_to_do)
 Replace a whole vehicle chain. More...
 
CommandCost CmdAutoreplaceVehicle (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Autoreplaces a vehicle Trains are replaced as a whole chain, free wagons in depot are replaced on their own. More...
 
CommandCost CmdSetAutoReplace (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Change engine renewal parameters. More...
 

Detailed Description

Deals with autoreplace execution but not the setup.

Definition in file autoreplace_cmd.cpp.

Function Documentation

◆ BuildReplacementVehicle()

static CommandCost BuildReplacementVehicle ( Vehicle old_veh,
Vehicle **  new_vehicle,
bool  part_of_chain 
)
static

Builds and refits a replacement vehicle Important: The old vehicle is still in the original vehicle chain (used for determining the cargo when the old vehicle did not carry anything, but the new one does)

Parameters
old_vehA single (articulated/multiheaded) vehicle that shall be replaced.
new_vehicleReturns the newly build and refitted vehicle
part_of_chainThe vehicle is part of a train
Returns
cost or error

Definition at line 282 of file autoreplace_cmd.cpp.

References _current_company, CT_INVALID, DC_AUTOREPLACE, DC_EXEC, DoCommand(), CommandCost::Failed(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), GetNewCargoTypeForReplace(), GetNewEngineType(), INVALID_ENGINE, and Vehicle::tile.

◆ ChangeVehicleNews()

void ChangeVehicleNews ( VehicleID  from_index,
VehicleID  to_index 
)

Report a change in vehicle IDs (due to autoreplace) to affected vehicle news.

Note
Viewports of currently displayed news is changed via ChangeVehicleViewports
Parameters
from_indexthe old vehicle ID
to_indexthe new vehicle ID

Definition at line 869 of file news_gui.cpp.

References NewsItem::next, NF_VEHICLE_PARAM0, and NR_VEHICLE.

◆ ChangeVehicleViewports()

void ChangeVehicleViewports ( VehicleID  from_index,
VehicleID  to_index 
)

Switches viewports following vehicles, which get autoreplaced.

Parameters
from_indexthe old vehicle ID
to_indexthe new vehicle ID

Definition at line 3441 of file window.cpp.

◆ ChangeVehicleViewWindow()

void ChangeVehicleViewWindow ( VehicleID  from_index,
VehicleID  to_index 
)

Report a change in vehicle IDs (due to autoreplace) to affected vehicle windows.

Parameters
from_indexthe old vehicle ID
to_indexthe new vehicle ID

Definition at line 1243 of file vehicle_gui.cpp.

References ChangeVehicleWindow(), WC_VEHICLE_DETAILS, WC_VEHICLE_ORDERS, WC_VEHICLE_REFIT, WC_VEHICLE_TIMETABLE, and WC_VEHICLE_VIEW.

◆ CheckAutoreplaceValidity()

bool CheckAutoreplaceValidity ( EngineID  from,
EngineID  to,
CompanyID  company 
)

Checks some basic properties whether autoreplace is allowed.

Parameters
fromOrigin engine
toDestination engine
companyCompany to check for
Returns
true if autoreplace is allowed

Definition at line 52 of file autoreplace_cmd.cpp.

Referenced by RemoveEngineReplacementForCompany().

◆ CheckCargoCapacity()

void CheckCargoCapacity ( Vehicle v)

Check the capacity of all vehicles in a chain and spread cargo if needed.

Parameters
vThe vehicle to check.
Precondition
You can only do this if the consist is not loading or unloading. It must not carry reserved cargo, nor cargo to be unloaded or transferred.

Definition at line 99 of file autoreplace_cmd.cpp.

◆ CmdAutoreplaceVehicle()

CommandCost CmdAutoreplaceVehicle ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

◆ CmdMoveVehicle()

static CommandCost CmdMoveVehicle ( const Vehicle v,
const Vehicle after,
DoCommandFlag  flags,
bool  whole_chain 
)
inlinestatic

Issue a train vehicle move command.

Parameters
vThe vehicle to move
afterThe vehicle to insert 'v' after, or NULL to start new chain
flagsthe command flags to use
whole_chainmove all vehicles following 'v' (true), or only 'v' (false)
Returns
success or error

Definition at line 339 of file autoreplace_cmd.cpp.

References CMD_MOVE_RAIL_VEHICLE, DC_NO_CARGO_CAP_CHECK, DoCommand(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, and INVALID_VEHICLE.

◆ CmdSetAutoReplace()

CommandCost CmdSetAutoReplace ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Change engine renewal parameters.

Parameters
tileunused
flagsoperation to perform
p1packed data
  • bit 0 = replace when engine gets old?
  • bits 16-31 = engine group
p2packed data
  • bits 0-15 = old engine type
  • bits 16-31 = new engine type
textunused
Returns
the cost of this operation or an error

Definition at line 757 of file autoreplace_cmd.cpp.

References _current_company, CMD_ERROR, GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_group_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::GetIfValid(), IsAllGroupID(), and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_group_pool >::IsValidID().

◆ CmdStartStopVehicle()

static CommandCost CmdStartStopVehicle ( const Vehicle v,
bool  evaluate_callback 
)
inlinestatic

Issue a start/stop command.

Parameters
va vehicle
evaluate_callbackshall the start/stop callback be evaluated?
Returns
success or error

Definition at line 326 of file autoreplace_cmd.cpp.

References CMD_START_STOP_VEHICLE, DC_AUTOREPLACE, DC_EXEC, DoCommand(), and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index.

Referenced by CmdAutoreplaceVehicle().

◆ CopyHeadSpecificThings()

static CommandCost CopyHeadSpecificThings ( Vehicle old_head,
Vehicle new_head,
DoCommandFlag  flags 
)
static

Copy head specific things to the new vehicle chain after it was successfully constructed.

Parameters
old_headThe old front vehicle (no wagons attached anymore)
new_headThe new head of the completely replaced vehicle chain
flagsthe command flags to use

Definition at line 350 of file autoreplace_cmd.cpp.

References CommandCost::AddCost(), DoCommand(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, and CommandCost::Succeeded().

◆ EnginesHaveCargoInCommon()

static bool EnginesHaveCargoInCommon ( EngineID  engine_a,
EngineID  engine_b 
)
static

Figure out if two engines got at least one type of cargo in common (refitting if needed)

Parameters
engine_aone of the EngineIDs
engine_bthe other EngineID
typethe type of the engines
Returns
true if they can both carry the same type of cargo (or at least one of them got no capacity at all)

Definition at line 38 of file autoreplace_cmd.cpp.

References GetUnionOfArticulatedRefitMasks().

◆ GetNewCargoTypeForReplace()

static CargoID GetNewCargoTypeForReplace ( Vehicle v,
EngineID  engine_type,
bool  part_of_chain 
)
static

Function to find what type of cargo to refit to when autoreplacing.

Parameters
*vOriginal vehicle that is being replaced.
engine_typeThe EngineID of the vehicle that is being replaced to
part_of_chainThe vehicle is part of a train
Returns
The cargo type to replace to CT_NO_REFIT is returned if no refit is needed CT_INVALID is returned when both old and new vehicle got cargo capacity and refitting the new one to the old one's cargo type isn't possible

Definition at line 202 of file autoreplace_cmd.cpp.

References Engine::CanCarryCargo(), Vehicle::cargo_type, CT_INVALID, CT_NO_REFIT, Vehicle::First(), GetArticulatedRefitMasks(), Vehicle::GetEngine(), HasBit(), IsArticulatedVehicleCarryingDifferentCargoes(), Vehicle::Next(), BaseVehicle::type, VEH_TRAIN, and VerifyAutoreplaceRefitForOrders().

Referenced by BuildReplacementVehicle().

◆ GetNewEngineType()

static CommandCost GetNewEngineType ( const Vehicle v,
const Company c,
bool  always_replace,
EngineID e 
)
static

Get the EngineID of the replacement for a vehicle.

Parameters
vThe vehicle to find a replacement for
cThe vehicle's owner (it's faster to forward the pointer than refinding it)
always_replaceAlways replace, even if not old.
[out]ethe EngineID of the replacement. INVALID_ENGINE if no replacement is found
Returns
Error if the engine to build is not available

Definition at line 244 of file autoreplace_cmd.cpp.

Referenced by BuildReplacementVehicle(), and CmdAutoreplaceVehicle().

◆ ReplaceChain()

static CommandCost ReplaceChain ( Vehicle **  chain,
DoCommandFlag  flags,
bool  wagon_removal,
bool *  nothing_to_do 
)
static

Replace a whole vehicle chain.

Parameters
chainvehicle chain to let autoreplace/renew operator on
flagscommand flags
wagon_removalremove wagons when the resulting chain occupies more tiles than the old did
nothing_to_dois set to 'false' when something was done (only valid when not failed)
Returns
cost or error

< Number of units in the chain

< Will store vehicles of the old chain in their order

< New vehicles corresponding to old_vehs or NULL if no replacement

< Costs for buying and refitting the new vehicles

< Shall store the last engine unit after this step

Definition at line 441 of file autoreplace_cmd.cpp.

◆ ReplaceFreeUnit()

static CommandCost ReplaceFreeUnit ( Vehicle **  single_unit,
DoCommandFlag  flags,
bool *  nothing_to_do 
)
static

Replace a single unit in a free wagon chain.

Parameters
single_unitvehicle to let autoreplace/renew operator on
flagscommand flags
nothing_to_dois set to 'false' when something was done (only valid when not failed)
Returns
cost or error

Definition at line 391 of file autoreplace_cmd.cpp.

References SpecializedVehicle< Train, Type >::From().

◆ TransferCargo()

static void TransferCargo ( Vehicle old_veh,
Vehicle new_head,
bool  part_of_chain 
)
static

Transfer cargo from a single (articulated )old vehicle to the new vehicle chain.

Parameters
old_vehOld vehicle that will be sold
new_headHead of the completely constructed new vehicle chain
part_of_chainThe vehicle is part of a train
Precondition
You can only do this if both consists are not loading or unloading. They must not carry reserved cargo, nor cargo to be unloaded or transferred.

Definition at line 134 of file autoreplace_cmd.cpp.

◆ VerifyAutoreplaceRefitForOrders()

static bool VerifyAutoreplaceRefitForOrders ( const Vehicle v,
EngineID  engine_type 
)
static

Tests whether refit orders that applied to v will also apply to the new vehicle type.

Parameters
vThe vehicle to be replaced
engine_typeThe type we want to replace with
Returns
true iff all refit orders stay valid

Definition at line 174 of file autoreplace_cmd.cpp.

References Vehicle::engine_type, Vehicle::First(), GetUnionOfArticulatedRefitMasks(), BaseVehicle::type, and VEH_TRAIN.

Referenced by GetNewCargoTypeForReplace().