OpenTTD Source  20241120-master-g6d3adc6169
train_cmd.h File Reference

Command definitions related to trains. More...

#include "command_type.h"
#include "engine_type.h"
#include "vehicle_type.h"

Go to the source code of this file.

Functions

CommandCost CmdBuildRailVehicle (DoCommandFlag flags, TileIndex tile, const Engine *e, Vehicle **ret)
 Build a railroad vehicle. More...
 
CommandCost CmdSellRailWagon (DoCommandFlag flags, Vehicle *t, bool sell_chain, bool backup_order, ClientID user)
 Sell a (single) train wagon/engine. More...
 
CommandCost CmdMoveRailVehicle (DoCommandFlag flags, VehicleID src_veh, VehicleID dest_veh, bool move_chain)
 Move a rail vehicle around inside the depot. More...
 
CommandCost CmdForceTrainProceed (DoCommandFlag flags, VehicleID veh_id)
 Force a train through a red signal. More...
 
CommandCost CmdReverseTrainDirection (DoCommandFlag flags, VehicleID veh_id, bool reverse_single_veh)
 Reverse train. More...
 
void CcBuildWagon (Commands cmd, const CommandCost &result, VehicleID new_veh_id, uint, uint16_t, CargoArray, TileIndex tile, EngineID, bool, CargoID, ClientID)
 Callback for building wagons. More...
 

Detailed Description

Command definitions related to trains.

Definition in file train_cmd.h.

Function Documentation

◆ CcBuildWagon()

void CcBuildWagon ( Commands  cmd,
const CommandCost result,
VehicleID  new_veh_id,
uint  ,
uint16_t  ,
CargoArray  ,
TileIndex  tile,
EngineID  ,
bool  ,
CargoID  ,
ClientID   
)

Callback for building wagons.

Parameters
resultThe result of the command.
new_veh_idID of the ne vehicle.
tileThe tile the command was executed on.

Definition at line 29 of file train_gui.cpp.

◆ CmdBuildRailVehicle()

CommandCost CmdBuildRailVehicle ( DoCommandFlag  flags,
TileIndex  tile,
const Engine e,
Vehicle **  ret 
)

Build a railroad vehicle.

Parameters
flagstype of operation.
tiletile of the depot where rail-vehicle is built.
ethe engine to build.
[out]retthe vehicle that has been built.
Returns
the cost of this operation or an error.

Definition at line 750 of file train_cmd.cpp.

References CMD_ERROR, CmdBuildRailWagon(), DC_EXEC, GetRailDepotDirection(), GetRailType(), HasPowerOnRail(), RailVehicleInfo::railtype, and RAILVEH_WAGON.

◆ CmdForceTrainProceed()

◆ CmdMoveRailVehicle()

CommandCost CmdMoveRailVehicle ( DoCommandFlag  flags,
VehicleID  src_veh,
VehicleID  dest_veh,
bool  move_chain 
)

Move a rail vehicle around inside the depot.

Parameters
flagstype of operation Note: DC_AUTOREPLACE is set when autoreplace tries to undo its modifications or moves vehicles to temporary locations inside the depot.
src_vehsource vehicle index
dest_vehwhat wagon to put the source wagon AFTER, XXX - INVALID_VEHICLE to make a new line
move_chainmove all vehicles following the source vehicle
Returns
the cost of this operation or an error

Definition at line 1193 of file train_cmd.cpp.

References CheckOwnership(), CMD_ERROR, DC_AUTOREPLACE, CommandCost::Failed(), SpecializedVehicle< T, Type >::GetIfValid(), INVALID_VEHICLE, GroundVehicle< T, Type >::IsEngine(), Vehicle::owner, Vehicle::vehstatus, and VS_CRASHED.

◆ CmdReverseTrainDirection()

CommandCost CmdReverseTrainDirection ( DoCommandFlag  flags,
VehicleID  veh_id,
bool  reverse_single_veh 
)

Reverse train.

Parameters
flagstype of operation
veh_idtrain to reverse
reverse_single_vehif true, reverse a unit in a train (needs to be in a depot)
Returns
the cost of this operation or an error

Definition at line 2059 of file train_cmd.cpp.

References CheckOwnership(), CMD_ERROR, CommandCost::Failed(), SpecializedVehicle< T, Type >::GetIfValid(), HasBit(), GroundVehicle< T, Type >::IsMultiheaded(), and Vehicle::owner.

◆ CmdSellRailWagon()

CommandCost CmdSellRailWagon ( DoCommandFlag  flags,
Vehicle t,
bool  sell_chain,
bool  backup_order,
ClientID  user 
)

Sell a (single) train wagon/engine.

Parameters
flagstype of operation
tthe train wagon to sell
sell_chainthe selling mode
  • sell_chain = false: only sell the single dragged wagon/engine (and any belonging rear-engines)
  • sell_chain = true: sell the vehicle and all vehicles following it in the chain if the wagon is dragged, don't delete the possibly belonging rear-engine to some front
backup_ordermake order backup?
userthe user for the order backup.
Returns
the cost of this operation or an error

Definition at line 1391 of file train_cmd.cpp.

References CommandCost::AddCost(), Vehicle::AddToShared(), ArrangeTrains(), OrderBackup::Backup(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >::CanAllocateItem(), Vehicle::CopyVehicleConfigAndStatistics(), GroupStatistics::CountVehicle(), DC_AUTOREPLACE, DC_EXEC, DeleteVehicleOrders(), EXPENSES_NEW_VEHICLES, CommandCost::Failed(), SpecializedVehicle< T, Type >::First(), SpecializedVehicle< T, Type >::From(), InvalidateWindowClassesData(), InvalidateWindowData(), GroundVehicle< T, Type >::IsEngine(), Vehicle::IsFrontEngine(), Train::IsPrimaryVehicle(), GroundVehicle< T, Type >::IsRearDualheaded(), MakeTrainBackup(), SpecializedVehicle< T, Type >::Next(), NormaliseSubtypes(), NormaliseTrainHead(), Vehicle::orders, RestoreTrainBackup(), return_cmd_error, Vehicle::tile, ValidateTrains(), WC_TRAINS_LIST, and WC_VEHICLE_DEPOT.

Referenced by CmdSellVehicle().