OpenTTD
Public Member Functions
CargoReservation Class Reference

Action of reserving cargo from a station to be loaded onto a vehicle. More...

#include <cargoaction.h>

Inheritance diagram for CargoReservation:
CargoLoad CargoMovement< StationCargoList, VehicleCargoList >

Public Member Functions

 CargoReservation (StationCargoList *source, VehicleCargoList *destination, uint max_move, TileIndex load_place)
 
bool operator() (CargoPacket *cp)
 Reserves some cargo for loading. More...
 
- Public Member Functions inherited from CargoLoad
 CargoLoad (StationCargoList *source, VehicleCargoList *destination, uint max_move, TileIndex load_place)
 
bool operator() (CargoPacket *cp)
 Loads some cargo onto a vehicle. More...
 
- Public Member Functions inherited from CargoMovement< StationCargoList, VehicleCargoList >
 CargoMovement (StationCargoList *source, VehicleCargoList *destination, uint max_move)
 
uint MaxMove ()
 Returns how much more cargo can be moved with this action. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CargoMovement< StationCargoList, VehicleCargoList >
CargoPacketPreprocess (CargoPacket *cp)
 Decides if a packet needs to be split. More...
 
- Protected Attributes inherited from CargoLoad
TileIndex load_place
 TileIndex to be saved in the packets' loaded_at_xy.
 
- Protected Attributes inherited from CargoMovement< StationCargoList, VehicleCargoList >
StationCargoListsource
 Source of the cargo.
 
VehicleCargoListdestination
 Destination for the cargo.
 
uint max_move
 Maximum amount of cargo to be moved with this action.
 

Detailed Description

Action of reserving cargo from a station to be loaded onto a vehicle.

Definition at line 91 of file cargoaction.h.

Member Function Documentation

◆ operator()()

bool CargoReservation::operator() ( CargoPacket cp)

Reserves some cargo for loading.

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

Definition at line 136 of file cargoaction.cpp.

References CargoPacket::Count(), CargoList< VehicleCargoList, CargoPacketList >::MTA_LOAD, CargoRemoval< Tsource >::Preprocess(), CargoPacket::SetLoadPlace(), and CargoRemoval< Tsource >::source.


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