1

/* $Id$ */

     2

     3

/** @file cargotype.h */

     4

     5

#ifndef CARGOTYPE_H

     6

#define CARGOTYPE_H

     7

     8

#include "cargo_type.h"

     9

#include "gfx_type.h"

    10

#include "newgrf_string_type.h"

    11

    12

typedef uint32 CargoLabel;

    13

    14

enum TownEffect {

    15

	TE_NONE,

    16

	TE_PASSENGERS,

    17

	TE_MAIL,

    18

	TE_GOODS,

    19

	TE_WATER,

    20

	TE_FOOD,

    21

};

    22

    23

    24

struct CargoSpec {

    25

	uint8 bitnum;

    26

	CargoLabel label;

    27

	uint32 grfid;

    28

	uint8 legend_colour;

    29

	uint8 rating_colour;

    30

	uint8 weight;

    31

	uint16 initial_payment;

    32

	uint8 transit_days[2];

    33

    34

	bool is_freight;

    35

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

    36

	uint16 multipliertowngrowth;

    37

	uint8 callback_mask;

    38

    39

	GRFMappedStringID name;

    40

	GRFMappedStringID name_single;

    41

	GRFMappedStringID units_volume;

    42

	GRFMappedStringID quantifier;

    43

	GRFMappedStringID abbrev;

    44

    45

	SpriteID sprite;

    46

    47

	uint16 classes;

    48

	const struct SpriteGroup *group;

    49

    50

	bool IsValid() const;

    51

};

    52

    53

    54

extern uint32 _cargo_mask;

    55

extern CargoSpec _cargo[NUM_CARGO];

    56

    57

    58

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

    59

void SetupCargoForClimate(LandscapeID l);

    60

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

    61

const CargoSpec *GetCargo(CargoID c);

    62

/* Get the cargo icon for a given cargo ID */

    63

SpriteID GetCargoSprite(CargoID i);

    64

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

    65

CargoID GetCargoIDByLabel(CargoLabel cl);

    66

CargoID GetCargoIDByBitnum(uint8 bitnum);

    67

    68

static inline bool IsCargoInClass(CargoID c, uint16 cc)

    69

{

    70

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

    71

}

    72

    73

    74

#endif /* CARGOTYPE_H */