|
OpenTTD Source
1.10.0-RC1
|
Specification of a cargo type. More...
#include <cargotype.h>
Public Member Functions | |
| CargoID | Index () const |
| Determines index of this cargospec. More... | |
| bool | IsValid () const |
| Tests for validity of this cargospec. More... | |
| SpriteID | GetCargoIcon () const |
| Get sprite for showing cargo of this type. More... | |
Static Public Member Functions | |
| static size_t | GetArraySize () |
| Total number of cargospecs, both valid and invalid. More... | |
| static CargoSpec * | Get (size_t index) |
| Retrieve cargo details for the given cargo ID. More... | |
Data Fields | |
| uint8 | bitnum |
| Cargo bit number, is INVALID_CARGO for a non-used spec. | |
| CargoLabel | label |
| Unique label of the cargo type. | |
| uint8 | legend_colour |
| uint8 | rating_colour |
| uint8 | weight |
| Weight of a single unit of this cargo type in 1/16 ton (62.5 kg). | |
| uint16 | multiplier |
| Capacity multiplier for vehicles. (8 fractional bits) | |
| uint16 | initial_payment |
| uint8 | transit_days [2] |
| bool | is_freight |
| Cargo type is considered to be freight (affects train freight multiplier). | |
| TownEffect | town_effect |
| The effect that delivering this cargo type has on towns. Also affects destination of subsidies. | |
| uint16 | multipliertowngrowth |
| Size of the effect. | |
| uint8 | callback_mask |
| Bitmask of cargo callbacks that have to be called. | |
| StringID | name |
| Name of this type of cargo. | |
| StringID | name_single |
| Name of a single entity of this type of cargo. | |
| StringID | units_volume |
| Name of a single unit of cargo of this type. | |
| StringID | quantifier |
| Text for multiple units of cargo of this type. | |
| StringID | abbrev |
| Two letter abbreviation for this cargo type. | |
| SpriteID | sprite |
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain). | |
| uint16 | classes |
| Classes of this cargo type. More... | |
| const struct GRFFile * | grffile |
| NewGRF where #group belongs to. | |
| const struct SpriteGroup * | group |
| Money | current_payment |
Static Private Attributes | |
| static CargoSpec | array [NUM_CARGO] |
| Array holding all CargoSpecs. | |
Friends | |
| void | SetupCargoForClimate (LandscapeID l) |
| Set up the default cargo types for the given landscape type. More... | |
Specification of a cargo type.
Definition at line 55 of file cargotype.h.
|
inlinestatic |
Retrieve cargo details for the given cargo ID.
| index | ID of cargo |
Definition at line 117 of file cargotype.h.
Referenced by BuildCargoTranslationMap(), CargoChangeInfo(), CmdCreateSubsidy(), CMSAMine(), FinaliseCargoArray(), FreightWagonMult(), GetRefitCostFactor(), VehicleScopeResolver::GetVariable(), GenericScopeResolver::GetVariable(), RoadVehicle::GetWeight(), Train::GetWeight(), IsCargoInClass(), IsTileForestIndustry(), BuildIndustryWindow::MakeCargoListString(), IndustryCargoesWindow::OnInit(), IndustryCargoesWindow::OnTooltip(), IndustryCargoesWindow::SetStringParameters(), SetupSubsidyDecodeParam(), ShowRejectOrAcceptNews(), and TownHouseChangeInfo().
|
inlinestatic |
Total number of cargospecs, both valid and invalid.
Definition at line 107 of file cargotype.h.
| SpriteID CargoSpec::GetCargoIcon | ( | ) | const |
Get sprite for showing cargo of this type.
Definition at line 120 of file cargotype.cpp.
References GetCustomCargoSprite(), and sprite.
|
inline |
Determines index of this cargospec.
Definition at line 88 of file cargotype.h.
References array.
Referenced by BuildLinkStatsLegend(), RefitWindow::BuildRefitList(), BuildVehicleWindow::SetCargoFilterArray(), IndustryDirectoryWindow::SetCargoFilterArray(), CompanyStationsWindow::SortStationsList(), and TruncateCargo().
|
inline |
Tests for validity of this cargospec.
Definition at line 98 of file cargotype.h.
References INVALID_CARGO.
Referenced by BuildCargoTranslationMap(), CargoChangeInfo(), FinaliseCargoArray(), IndustryCargoesWindow::OnInit(), and TownHouseChangeInfo().
|
friend |
Set up the default cargo types for the given landscape type.
| l | Landscape |
Definition at line 40 of file cargotype.cpp.
| uint16 CargoSpec::classes |
Classes of this cargo type.
Definition at line 78 of file cargotype.h.
Referenced by CargoChangeInfo(), CargoSpecClassSorter(), CMSAMine(), GetRefitCostFactor(), VehicleScopeResolver::GetVariable(), and IsCargoInClass().