Files
@ r19189:9d8867fd062d
Branch filter:
Location: cpp/openttd-patchpack/source/src/cargotype.h - annotation
r19189:9d8867fd062d
6.3 KiB
text/x-c
(svn r24080) -Update from WebTranslator v3.0:
german - 2 changes by Jogio
irish - 38 changes by tem
italian - 1 changes by Snail_
latvian - 44 changes by Parastais
polish - 4 changes by Kilian
spanish - 2 changes by Terkhen
ukrainian - 1 changes by edd_k
german - 2 changes by Jogio
irish - 38 changes by tem
italian - 1 changes by Snail_
latvian - 44 changes by Parastais
polish - 4 changes by Kilian
spanish - 2 changes by Terkhen
ukrainian - 1 changes by edd_k
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | r6091:2faa7d307565 r6091:2faa7d307565 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r18668:b656d614c4fd r6123:049e9624d068 r6091:2faa7d307565 r6091:2faa7d307565 r6091:2faa7d307565 r12932:8c04eed8b65b r8119:8fdb3a371896 r8123:dde0a9a84019 r8959:484dbfc31293 r9126:35955a7b9d9e r6091:2faa7d307565 r13874:a3b7b89e1abf r6091:2faa7d307565 r6091:2faa7d307565 r13874:a3b7b89e1abf r6311:78f38fcd68ca r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r18444:c1e881f954d6 r6311:78f38fcd68ca r6311:78f38fcd68ca r13874:a3b7b89e1abf r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r13456:7f9200df57a3 r18737:1ee35da7fa2f r13456:7f9200df57a3 r6091:2faa7d307565 r13874:a3b7b89e1abf r12236:ae676539361d r13874:a3b7b89e1abf r6248:b940b09d7ab8 r13874:a3b7b89e1abf r13874:a3b7b89e1abf r6091:2faa7d307565 r6091:2faa7d307565 r13874:a3b7b89e1abf r18994:b2513f4fbc6f r6091:2faa7d307565 r6091:2faa7d307565 r6091:2faa7d307565 r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r6091:2faa7d307565 r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r6091:2faa7d307565 r13874:a3b7b89e1abf r6091:2faa7d307565 r13874:a3b7b89e1abf r13874:a3b7b89e1abf r6365:410001496130 r6122:508316e17f8e r12932:8c04eed8b65b r12932:8c04eed8b65b r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r18782:6453522c2154 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r18782:6453522c2154 r12236:ae676539361d r12236:ae676539361d r12236:ae676539361d r12405:ba094e765533 r12405:ba094e765533 r12409:5f538763905f r12409:5f538763905f r12405:ba094e765533 r18782:6453522c2154 r12405:ba094e765533 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r18782:6453522c2154 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12405:ba094e765533 r12405:ba094e765533 r13871:7588cd2474cc r13871:7588cd2474cc r12405:ba094e765533 r12409:5f538763905f r12405:ba094e765533 r12405:ba094e765533 r6248:b940b09d7ab8 r6091:2faa7d307565 r6113:c77736e8b915 r6113:c77736e8b915 r6091:2faa7d307565 r6143:9ed364174dfd r6460:74b53af67ae0 r6113:c77736e8b915 r14922:51cba7fe7b9b r14922:51cba7fe7b9b r14922:51cba7fe7b9b r14955:fecfdf8f80c1 r14922:51cba7fe7b9b r15610:623a23fb6560 r15610:623a23fb6560 r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13874:a3b7b89e1abf r13456:7f9200df57a3 r12236:ae676539361d r12405:ba094e765533 r12236:ae676539361d r12236:ae676539361d r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r12408:d7d52eed8c09 r15151:8e6202164b81 r15151:8e6202164b81 r14926:3d9a47be1c5a r14926:3d9a47be1c5a r14955:fecfdf8f80c1 r14955:fecfdf8f80c1 r6091:2faa7d307565 | /* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file cargotype.h Types/functions related to cargoes. */
#ifndef CARGOTYPE_H
#define CARGOTYPE_H
#include "economy_type.h"
#include "cargo_type.h"
#include "gfx_type.h"
#include "strings_type.h"
#include "landscape_type.h"
/** Globally unique label of a cargo type. */
typedef uint32 CargoLabel;
/** Town growth effect when delivering cargo. */
enum TownEffect {
TE_BEGIN = 0,
TE_NONE = TE_BEGIN, ///< Cargo has no effect.
TE_PASSENGERS, ///< Cargo behaves passenger-like.
TE_MAIL, ///< Cargo behaves mail-like.
TE_GOODS, ///< Cargo behaves goods/candy-like.
TE_WATER, ///< Cargo behaves water-like.
TE_FOOD, ///< Cargo behaves food/fizzy-drinks-like.
TE_END, ///< End of town effects.
NUM_TE = TE_END, ///< Amount of town effects.
};
/** Cargo classes. */
enum CargoClass {
CC_NOAVAILABLE = 0, ///< No cargo class has been specified
CC_PASSENGERS = 1 << 0, ///< Passengers
CC_MAIL = 1 << 1, ///< Mail
CC_EXPRESS = 1 << 2, ///< Express cargo (Goods, Food, Candy, but also possible for passengers)
CC_ARMOURED = 1 << 3, ///< Armoured cargo (Valuables, Gold, Diamonds)
CC_BULK = 1 << 4, ///< Bulk cargo (Coal, Grain etc., Ores, Fruit)
CC_PIECE_GOODS = 1 << 5, ///< Piece goods (Livestock, Wood, Steel, Paper)
CC_LIQUID = 1 << 6, ///< Liquids (Oil, Water, Rubber)
CC_REFRIGERATED = 1 << 7, ///< Refrigerated cargo (Food, Fruit)
CC_HAZARDOUS = 1 << 8, ///< Hazardous cargo (Nuclear Fuel, Explosives, etc.)
CC_COVERED = 1 << 9, ///< Covered/Sheltered Freight (Transporation in Box Vans, Silo Wagons, etc.)
CC_SPECIAL = 1 << 15, ///< Special bit used for livery refit tricks instead of normal cargoes.
};
static const byte INVALID_CARGO = 0xFF; ///< Constant representing invalid cargo
/** Specification of a cargo type. */
struct CargoSpec {
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 \c 0xFFF (which means to resolve an action123 chain).
uint16 classes; ///< Classes of this cargo type. @see CargoClass
const struct GRFFile *grffile; ///< NewGRF where #group belongs to.
const struct SpriteGroup *group;
Money current_payment;
/**
* Determines index of this cargospec
* @return index (in the CargoSpec::array array)
*/
inline CargoID Index() const
{
return this - CargoSpec::array;
}
/**
* Tests for validity of this cargospec
* @return is this cargospec valid?
* @note assert(cs->IsValid()) can be triggered when GRF config is modified
*/
inline bool IsValid() const
{
return this->bitnum != INVALID_CARGO;
}
/**
* Total number of cargospecs, both valid and invalid
* @return length of CargoSpec::array
*/
static inline size_t GetArraySize()
{
return lengthof(CargoSpec::array);
}
/**
* Retrieve cargo details for the given cargo ID
* @param index ID of cargo
* @pre index is a valid cargo ID
*/
static inline CargoSpec *Get(size_t index)
{
assert(index < lengthof(CargoSpec::array));
return &CargoSpec::array[index];
}
SpriteID GetCargoIcon() const;
private:
static CargoSpec array[NUM_CARGO]; ///< Array holding all CargoSpecs
friend void SetupCargoForClimate(LandscapeID l);
};
extern uint32 _cargo_mask;
void SetupCargoForClimate(LandscapeID l);
CargoID GetCargoIDByLabel(CargoLabel cl);
CargoID GetCargoIDByBitnum(uint8 bitnum);
void InitializeSortedCargoSpecs();
extern const CargoSpec *_sorted_cargo_specs[NUM_CARGO];
extern uint8 _sorted_cargo_specs_size;
extern uint8 _sorted_standard_cargo_specs_size;
/**
* Does cargo \a c have cargo class \a cc?
* @param c Cargo type.
* @param cc Cargo class.
* @return The type fits in the class.
*/
static inline bool IsCargoInClass(CargoID c, CargoClass cc)
{
return (CargoSpec::Get(c)->classes & cc) != 0;
}
#define FOR_ALL_CARGOSPECS_FROM(var, start) for (size_t cargospec_index = start; var = NULL, cargospec_index < CargoSpec::GetArraySize(); cargospec_index++) \
if ((var = CargoSpec::Get(cargospec_index))->IsValid())
#define FOR_ALL_CARGOSPECS(var) FOR_ALL_CARGOSPECS_FROM(var, 0)
#define FOR_EACH_SET_CARGO_ID(var, cargo_bits) FOR_EACH_SET_BIT_EX(CargoID, var, uint, cargo_bits)
#define FOR_ALL_SORTED_CARGOSPECS(var) for (uint8 index = 0; var = _sorted_cargo_specs[index], index < _sorted_cargo_specs_size; index++)
#define FOR_ALL_SORTED_STANDARD_CARGOSPECS(var) for (uint8 index = 0; var = _sorted_cargo_specs[index], index < _sorted_standard_cargo_specs_size; index++)
#endif /* CARGOTYPE_H */
|