OpenTTD Source 20260208-master-g43af8e94d0
VehicleCargoReroute Class Reference

Action of rerouting cargo staged for transfer in a vehicle. More...

#include <cargoaction.h>

Inheritance diagram for VehicleCargoReroute:
CargoReroute< VehicleCargoList > CargoMovement< VehicleCargoList, VehicleCargoList >

Public Member Functions

 VehicleCargoReroute (VehicleCargoList *source, VehicleCargoList *dest, uint max_move, StationID avoid, StationID avoid2, const GoodsEntry *ge)
bool operator() (CargoPacket *cp)
 Reroutes some cargo in a VehicleCargoList.
Public Member Functions inherited from CargoReroute< VehicleCargoList >
 CargoReroute (VehicleCargoList *source, VehicleCargoList *dest, uint max_move, StationID avoid, StationID avoid2, const GoodsEntry *ge)
Public Member Functions inherited from CargoMovement< VehicleCargoList, VehicleCargoList >
 CargoMovement (VehicleCargoList *source, VehicleCargoList *destination, uint max_move)
uint MaxMove ()
 Returns how much more cargo can be moved with this action.

Additional Inherited Members

Protected Member Functions inherited from CargoMovement< VehicleCargoList, VehicleCargoList >
CargoPacket * Preprocess (CargoPacket *cp)
 Decides if a packet needs to be split.
Protected Attributes inherited from CargoReroute< VehicleCargoList >
StationID avoid
StationID avoid2
const GoodsEntry * ge
Protected Attributes inherited from CargoMovement< VehicleCargoList, VehicleCargoList >
VehicleCargoList * source
 Source of the cargo.
VehicleCargoList * destination
 Destination for the cargo.
uint max_move
 Maximum amount of cargo to be moved with this action.

Detailed Description

Action of rerouting cargo staged for transfer in a vehicle.

Definition at line 140 of file cargoaction.h.

Constructor & Destructor Documentation

◆ VehicleCargoReroute()

VehicleCargoReroute::VehicleCargoReroute ( VehicleCargoList * source,
VehicleCargoList * dest,
uint max_move,
StationID avoid,
StationID avoid2,
const GoodsEntry * ge )
inline

Definition at line 142 of file cargoaction.h.

Member Function Documentation

◆ operator()()

bool VehicleCargoReroute::operator() ( CargoPacket * cp)

Reroutes some cargo in a VehicleCargoList.

Parameters
cpPacket to be rerouted.
Returns
True if the packet was completely rerouted, false if part of it was.

Definition at line 220 of file cargoaction.cpp.

References CargoPacket::Count(), CargoMovement< VehicleCargoList, VehicleCargoList >::destination, CargoPacket::GetFirstStation(), CargoPacket::GetNextHop(), CargoList< VehicleCargoList, CargoPacketList >::MTA_TRANSFER, CargoMovement< VehicleCargoList, VehicleCargoList >::Preprocess(), CargoPacket::SetNextHop(), and CargoMovement< VehicleCargoList, VehicleCargoList >::source.

The documentation for this class was generated from the following files: