1

/* $Id$ */

     2

     3

/** @file cargotype.h */

     4

     5

#ifndef CARGOTYPE_H

     6

#define CARGOTYPE_H

     7

     8

     9

typedef uint32 CargoLabel;

    10

    11

enum TownEffect {

    12

	TE_NONE,

    13

	TE_PASSENGERS,

    14

	TE_MAIL,

    15

	TE_GOODS,

    16

	TE_WATER,

    17

	TE_FOOD,

    18

};

    19

    20

    21

struct CargoSpec {

    22

	uint8 bitnum;

    23

	CargoLabel label;

    24

	uint32 grfid;

    25

	uint8 legend_colour;

    26

	uint8 rating_colour;

    27

	uint8 weight;

    28

	uint16 initial_payment;

    29

	uint8 transit_days[2];

    30

    31

	bool is_freight;

    32

	TownEffect town_effect; ///< The effect this cargo type has on towns

    33

	uint16 multipliertowngrowth;

    34

	uint8 callback_mask;

    35

    36

	StringID name;

    37

	StringID name_plural;

    38

	StringID units_volume;

    39

	StringID quantifier;

    40

	StringID abbrev;

    41

    42

	SpriteID sprite;

    43

    44

	uint16 classes;

    45

	const struct SpriteGroup *group;

    46

    47

	bool IsValid() const;

    48

};

    49

    50

    51

extern uint32 _cargo_mask;

    52

extern CargoSpec _cargo[NUM_CARGO];

    53

    54

    55

/* Set up the default cargo types for the given landscape type */

    56

void SetupCargoForClimate(LandscapeID l);

    57

/* Retrieve cargo details for the given cargo ID */

    58

const CargoSpec *GetCargo(CargoID c);

    59

/* Get the cargo ID with the cargo label */

    60

CargoID GetCargoIDByLabel(CargoLabel cl);

    61

    62

static inline bool IsCargoInClass(CargoID c, uint16 cc)

    63

{

    64

	return (GetCargo(c)->classes & cc) != 0;

    65

}

    66

    67

    68

#endif /* CARGOTYPE_H */