OpenTTD Source 20241224-master-gf74b0cf984
newgrf_cargo.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#ifndef NEWGRF_CARGO_H
11#define NEWGRF_CARGO_H
12
13#include "newgrf_callbacks.h"
14#include "cargo_type.h"
15#include "gfx_type.h"
16
23 static constexpr CargoID SG_DEFAULT = NUM_CARGO;
24 static constexpr CargoID SG_PURCHASE = NUM_CARGO + 1;
25 static constexpr CargoID SG_DEFAULT_NA = NUM_CARGO + 2;
26};
27
28/* Forward declarations of structs used */
29struct CargoSpec;
30struct GRFFile;
31
33uint16_t GetCargoCallback(CallbackID callback, uint32_t param1, uint32_t param2, const CargoSpec *cs);
34CargoID GetCargoTranslation(uint8_t cargo, const GRFFile *grffile, bool usebit = false);
35
36std::span<const CargoLabel> GetClimateDependentCargoTranslationTable();
37std::span<const CargoLabel> GetClimateIndependentCargoTranslationTable();
38
39#endif /* NEWGRF_CARGO_H */
Types related to cargoes...
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:22
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:74
Types related to the graphics and/or input devices.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:18
Sprite Group Cargo types.
static constexpr CargoID SG_DEFAULT
Default type used when no more-specific cargo matches.
static constexpr CargoID SG_PURCHASE
Used in purchase lists before an item exists.
static constexpr CargoID SG_DEFAULT_NA
Used only by stations and roads when no more-specific cargo matches.
Callbacks that NewGRFs could implement.
CallbackID
List of implemented NewGRF callbacks.
std::span< const CargoLabel > GetClimateDependentCargoTranslationTable()
Get default climate-dependent cargo translation table for a NewGRF, used if the NewGRF does not provi...
SpriteID GetCustomCargoSprite(const CargoSpec *cs)
Get the custom sprite for the given cargo type.
std::span< const CargoLabel > GetClimateIndependentCargoTranslationTable()
Get default climate-independent cargo translation table for a NewGRF, used if the NewGRF does not pro...
CargoID GetCargoTranslation(uint8_t cargo, const GRFFile *grffile, bool usebit=false)
Translate a GRF-local cargo slot/bitnum into a CargoID.
Specification of a cargo type.
Definition cargotype.h:76
Dynamic data of a loaded NewGRF.
Definition newgrf.h:108