OpenTTD Source: src/cargopacket.h File Reference

OpenTTD Source 14.0-beta3

Data Structures | Typedefs | Functions | Variables
cargopacket.h File Reference
`#include "core/pool_type.hpp"`
`#include "economy_type.h"`
`#include "station_type.h"`
`#include "order_type.h"`
`#include "cargo_type.h"`
`#include "vehicle_type.h"`
`#include "core/multimap.hpp"`
`#include "saveload/saveload.h"`

Go to the source code of this file.

## Data Structures
class | CargoList< Tinst, Tcont >
| Simple collection class for a list of cargo packets. More...
struct | CargoPacket
| Container for cargo from the same location and time. More...
struct | CargoPacket::Vector
class | CargoList< Tinst, Tcont >
| Simple collection class for a list of cargo packets. More...
class | VehicleCargoList
| CargoList that is used for vehicles. More...
class | StationCargoList
| CargoList that is used for stations. More...

## Typedefs
typedef uint32_t | CargoPacketID
| Unique identifier for a single cargo packet.
typedef Pool< CargoPacket, CargoPacketID, 1024, 0xFFF000, PT_NORMAL, true, false > | CargoPacketPool
| Type of the pool for cargo packets for a little over 16 million packets.
typedef std::list< CargoPacket * > | CargoPacketList
typedef MultiMap< StationID, CargoPacket * > | StationCargoPacketMap
typedef std::map< StationID, uint > | StationCargoAmountMap

## Functions
SaveLoadTable | GetCargoPacketDesc ()
| Wrapper function to get the CargoPacket's internal structure while some of the variables itself are private. More...

## Variables
CargoPacketPool | _cargopacket_pool
| The actual pool with cargo packets.

## Detailed Description

Base class for cargo packets.

Definition in file cargopacket.h.

## Function Documentation

## ◆ GetCargoPacketDesc()

SaveLoadTable GetCargoPacketDesc | ( |  | ) |

Wrapper function to get the CargoPacket's internal structure while some of the variables itself are private.

We want this to be saved, right?

Returns
  the saveload description for CargoPackets.

Definition at line 119 of file cargopacket_sl.cpp.

References SLE_VARNAME.

Referenced by CAPAChunkHandler::Load(), and CAPAChunkHandler::Save().