OpenTTD
Data Structures | Functions
newgrf_cargo.cpp File Reference

Implementation of NewGRF cargoes. More...

#include "stdafx.h"
#include "debug.h"
#include "newgrf_spritegroup.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures

struct  CargoResolverObject
 Resolver of cargo. More...
 

Functions

SpriteID GetCustomCargoSprite (const CargoSpec *cs)
 Get the custom sprite for the given cargo type. More...
 
uint16 GetCargoCallback (CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs)
 
CargoID GetCargoTranslation (uint8 cargo, const GRFFile *grffile, bool usebit)
 Translate a GRF-local cargo slot/bitnum into a CargoID. More...
 

Detailed Description

Implementation of NewGRF cargoes.

Definition in file newgrf_cargo.cpp.

Function Documentation

◆ GetCargoTranslation()

CargoID GetCargoTranslation ( uint8  cargo,
const GRFFile grffile,
bool  usebit 
)

Translate a GRF-local cargo slot/bitnum into a CargoID.

Parameters
cargoGRF-local cargo slot/bitnum.
grffileOriginating GRF file.
usebitDefines the meaning of cargo for GRF version < 7. If true, then cargo is a bitnum. If false, then cargo is a cargoslot. For GRF version >= 7 cargo is always a translated cargo bit.
Returns
CargoID or CT_INVALID if the cargo is not available.

Definition at line 78 of file newgrf_cargo.cpp.

References GRFFile::cargo_list, CT_INVALID, GetCargoIDByBitnum(), GetCargoIDByLabel(), and SmallVector< T, S >::Length().

Referenced by RoadVehicleChangeInfo(), ShipVehicleChangeInfo(), and TranslateRefitMask().

◆ GetCustomCargoSprite()

SpriteID GetCustomCargoSprite ( const CargoSpec cs)

Get the custom sprite for the given cargo type.

Parameters
csCargo being queried.
Returns
Custom sprite to draw, or 0 if not available.

Definition at line 53 of file newgrf_cargo.cpp.

References SpriteGroup::Resolve().

Referenced by CargoSpec::GetCargoIcon().