OpenTTD Source 20261112-master-gbcbec5e63f
cargotype.h File Reference

Types/functions related to cargoes. More...

#include "economy_type.h"
#include "cargo_type.h"
#include "gfx_type.h"
#include "newgrf_callbacks.h"
#include "strings_type.h"
#include "landscape_type.h"

Go to the source code of this file.

Data Structures

struct  CargoSpec
 Specification of a cargo type. More...
struct  CargoSpec::Iterator
 Iterator to iterate all valid CargoSpec. More...
struct  CargoSpec::IterateWrapper
 Iterable ensemble of all valid CargoSpec. More...
struct  CargoTypeComparator
 Comparator to sort CargoType by according to desired order. More...

Typedefs

using CargoClasses = EnumBitSet<CargoClass, uint16_t>
 Bitset of CargoClass elements.

Enumerations

enum class  TownAcceptanceEffect : uint8_t {
  Begin = 0 , None = TownAcceptanceEffect::Begin , Passengers , Mail ,
  Goods , Water , Food , End
}
 Town growth effect when delivering cargo. More...
enum class  TownProductionEffect : uint8_t {
  None , Passengers , Mail , End ,
  Invalid
}
 Town effect when producing cargo. More...
enum class  CargoClass : uint8_t {
  Passengers = 0 , Mail = 1 , Express = 2 , Armoured = 3 ,
  Bulk = 4 , PieceGoods = 5 , Liquid = 6 , Refrigerated = 7 ,
  Hazardous = 8 , Covered = 9 , Oversized = 10 , Powderized = 11 ,
  NotPourable = 12 , Potable = 13 , NonPotable = 14 , Special = 15
}
 Cargo classes. More...

Functions

void SetupCargoForClimate (LandscapeType l)
 Set up the default cargo types for the given landscape type.
bool IsDefaultCargo (CargoType cargo_type)
 Test if a cargo is a default cargo type.
void BuildCargoLabelMap ()
 Build cargo label map.
std::optional< std::string > BuildCargoAcceptanceString (const CargoArray &acceptance, StringID label)
 Build comma-separated cargo acceptance string.
CargoType GetCargoTypeByLabel (CargoLabel label)
 Get cargo assigned to a label.
Dimension GetLargestCargoIconSize ()
 Get dimensions of largest cargo icon.
void InitializeSortedCargoSpecs ()
 Initialize the list of sorted cargo specifications.
bool IsCargoInClass (CargoType cargo, CargoClasses cc)
 Does a given cargo have any cargo class from cc.

Variables

static const uint8_t INVALID_CARGO_BITNUM = 0xFF
 Constant representing invalid cargo bit number.
static const uint TOWN_PRODUCTION_DIVISOR = 256
 By what factor divide town production.
CargoTypes _cargo_mask
 Bitmask of cargo types available.
CargoTypes _standard_cargo_mask
 Bitmask of real cargo types available.
std::array< uint8_t, NUM_CARGO > _sorted_cargo_types
 Sort order of cargoes by cargo type.
std::vector< const CargoSpec * > _sorted_cargo_specs
 Cargo specifications sorted alphabetically by name.
std::span< const CargoSpec * > _sorted_standard_cargo_specs
 Standard cargo specifications sorted alphabetically by name.

Detailed Description

Types/functions related to cargoes.

Definition in file cargotype.h.

Typedef Documentation

◆ CargoClasses

using CargoClasses = EnumBitSet<CargoClass, uint16_t>

Bitset of CargoClass elements.

Definition at line 69 of file cargotype.h.

Enumeration Type Documentation

◆ CargoClass

enum class CargoClass : uint8_t
strong

Cargo classes.

Enumerator
Passengers 

Passengers.

Mail 

Mail.

Express 

Express cargo (Goods, Food, Candy, but also possible for passengers).

Armoured 

Armoured cargo (Valuables, Gold, Diamonds).

Bulk 

Bulk cargo (Coal, Grain etc., Ores, Fruit).

PieceGoods 

Piece goods (Livestock, Wood, Steel, Paper).

Liquid 

Liquids (Oil, Water, Rubber).

Refrigerated 

Refrigerated cargo (Food, Fruit).

Hazardous 

Hazardous cargo (Nuclear Fuel, Explosives, etc.).

Covered 

Covered/Sheltered Freight (Transportation in Box Vans, Silo Wagons, etc.).

Oversized 

Oversized (stake/flatbed wagon).

Powderized 

Powderized, moist protected (powder/silo wagon).

NotPourable 

Not Pourable (open wagon, but not hopper wagon).

Potable 

Potable / food / clean.

NonPotable 

Non-potable / non-food / dirty.

Special 

Special bit used for livery refit tricks instead of normal cargoes.

Definition at line 49 of file cargotype.h.

◆ TownAcceptanceEffect

enum class TownAcceptanceEffect : uint8_t
strong

Town growth effect when delivering cargo.

Enumerator
Begin 

Used for iteration.

None 

Cargo has no effect.

Passengers 

Cargo behaves passenger-like.

Mail 

Cargo behaves mail-like.

Goods 

Cargo behaves goods/candy-like.

Water 

Cargo behaves water-like.

Food 

Cargo behaves food/fizzy-drinks-like.

End 

End of town effects.

Definition at line 21 of file cargotype.h.

◆ TownProductionEffect

enum class TownProductionEffect : uint8_t
strong

Town effect when producing cargo.

Enumerator
None 

Town will not produce this cargo type.

Passengers 

Cargo behaves passenger-like for production.

Mail 

Cargo behaves mail-like for production.

End 

End marker.

Invalid 

Invalid town production effect.

Used as a sentinel to indicate if a NewGRF has explicitly set an effect. This does not 'exist' after cargo types are finalised.

Definition at line 35 of file cargotype.h.

Function Documentation

◆ BuildCargoAcceptanceString()

std::optional< std::string > BuildCargoAcceptanceString ( const CargoArray & acceptance,
StringID label )

Build comma-separated cargo acceptance string.

Parameters
acceptanceCargoArray filled with accepted cargo.
labelLabel to prefix cargo acceptance list.
Returns
String of accepted cargo, or nullopt if no cargo is accepted.

Definition at line 271 of file cargotype.cpp.

References _sorted_cargo_specs, GetListSeparator(), and GetString().

Referenced by BuildHouseWindow::GetHouseInformation(), and LandInfoWindow::OnInit().

◆ BuildCargoLabelMap()

void BuildCargoLabelMap ( )

Build cargo label map.

This is called multiple times during NewGRF initialization as cargos are defined, so that TranslateRefitMask() and GetCargoTranslation(), also used during initialization, get the correct information.

Definition at line 249 of file cargotype.cpp.

References _sorted_cargo_specs, and _sorted_standard_cargo_specs.

Referenced by CargoReserveInfo(), and CargoSpec::SetupCargoForClimate.

◆ GetCargoTypeByLabel()

◆ GetLargestCargoIconSize()

Dimension GetLargestCargoIconSize ( )

◆ InitializeSortedCargoSpecs()

void InitializeSortedCargoSpecs ( )

Initialize the list of sorted cargo specifications.

Definition at line 222 of file cargotype.cpp.

References _sorted_cargo_specs, _sorted_cargo_types, _standard_cargo_mask, CargoSpecClassSorter(), Invalid, CargoSpec::Iterate(), Special, and CargoSpec::town_production_cargoes.

Referenced by AfterLoadGRFs(), and ReadLanguagePack().

◆ IsCargoInClass()

bool IsCargoInClass ( CargoType cargo,
CargoClasses cc )
inline

Does a given cargo have any cargo class from cc.

Parameters
cargoThe cargo type to test.
ccThe cargo classes to check for.
Returns
true iff the cargo type fits in the classes.

Definition at line 288 of file cargotype.h.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), CargoSpec::classes, and CargoSpec::Get().

Referenced by CargoFilterSingle(), Vehicle::Crash(), Engine::DetermineCapacity(), MultiCommodityFlow::Dijkstra(), DrawStationCoverageAreaText(), GetEngineLiveryScheme(), RoadVehicle::IsBus(), LoadUnloadVehicle(), and UpdateStationAcceptance().

◆ IsDefaultCargo()

bool IsDefaultCargo ( CargoType cargo_type)

Test if a cargo is a default cargo type.

Parameters
cargo_typeCargo type.
Returns
true iff the cargo type is a default cargo type.

Definition at line 149 of file cargotype.cpp.

References _default_cargo_labels, and CargoSpec::Get().

Referenced by CalculateRefitMasks().

◆ SetupCargoForClimate()

void SetupCargoForClimate ( LandscapeType l)

Set up the default cargo types for the given landscape type.

Parameters
lLandscape to set up the default cargoes for.

Definition at line 248 of file cargotype.cpp.

Referenced by ResetNewGRFData().

Variable Documentation

◆ _cargo_mask

CargoTypes _cargo_mask
extern

Bitmask of cargo types available.

This includes phony cargoes like regearing cargoes. Initialized during a call to SetupCargoForClimate.

Definition at line 30 of file cargotype.cpp.

Referenced by CalculateRefitMasks(), CargoReserveInfo(), CompanyStationsWindow::GetWidgetString(), CompanyStationsWindow::OnDropdownSelect(), CargoSpec::SetupCargoForClimate, and ShowRefitOptionsList().

◆ _sorted_cargo_specs

◆ _sorted_cargo_types

std::array<uint8_t, NUM_CARGO> _sorted_cargo_types
extern

Sort order of cargoes by cargo type.

Definition at line 188 of file cargotype.cpp.

Referenced by InitializeSortedCargoSpecs(), and CargoTypeComparator::operator()().

◆ _sorted_standard_cargo_specs

std::span<const CargoSpec *> _sorted_standard_cargo_specs
extern

◆ _standard_cargo_mask

CargoTypes _standard_cargo_mask
extern

Bitmask of real cargo types available.

Phony cargoes like regearing cargoes are excluded.

Definition at line 35 of file cargotype.cpp.

Referenced by CalculateRefitMasks(), CargoAndEngineFilter(), PaymentRatesGraphWindow::GetCargoTypes(), InitializeSortedCargoSpecs(), and BuildVehicleWindow::SetCargoFilterArray().

◆ INVALID_CARGO_BITNUM

const uint8_t INVALID_CARGO_BITNUM = 0xFF
static

Constant representing invalid cargo bit number.

Definition at line 71 of file cargotype.h.

Referenced by CargoSpec::IsValid().

◆ TOWN_PRODUCTION_DIVISOR

const uint TOWN_PRODUCTION_DIVISOR = 256
static

By what factor divide town production.

Definition at line 73 of file cargotype.h.

Referenced by TownGenerateCargoBinomial(), and TownGenerateCargoOriginal().