1

/* $Id$ */

     2

     3

/** @file cargotype.h Types/functions related to cargos. */

     4

     5

#ifndef CARGOTYPE_H

     6

#define CARGOTYPE_H

     7

     8

#include "cargo_type.h"

     9

#include "gfx_type.h"

    10

#include "strings_type.h"

    11

#include "landscape_type.h"

    12

    13

typedef uint32 CargoLabel;

    14

    15

enum TownEffect {

    16

	TE_NONE,

    17

	TE_PASSENGERS,

    18

	TE_MAIL,

    19

	TE_GOODS,

    20

	TE_WATER,

    21

	TE_FOOD,

    22

};

    23

    24

    25

struct CargoSpec {

    26

	uint8 bitnum;

    27

	CargoLabel label;

    28

	uint32 grfid;

    29

	uint8 legend_colour;

    30

	uint8 rating_colour;

    31

	uint8 weight;

    32

	uint16 initial_payment;

    33

	uint8 transit_days[2];

    34

    35

	bool is_freight;

    36

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

    37

	uint16 multipliertowngrowth;

    38

	uint8 callback_mask;

    39

    40

	StringID name;

    41

	StringID name_single;

    42

	StringID units_volume;

    43

	StringID quantifier;

    44

	StringID abbrev;

    45

    46

	SpriteID sprite;

    47

    48

	uint16 classes;

    49

	const struct SpriteGroup *group;

    50

    51

	bool IsValid() const;

    52

};

    53

    54

    55

extern uint32 _cargo_mask;

    56

extern CargoSpec _cargo[NUM_CARGO];

    57

    58

    59

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

    60

void SetupCargoForClimate(LandscapeID l);

    61

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

    62

const CargoSpec *GetCargo(CargoID c);

    63

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

    64

SpriteID GetCargoSprite(CargoID i);

    65

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

    66

CargoID GetCargoIDByLabel(CargoLabel cl);

    67

CargoID GetCargoIDByBitnum(uint8 bitnum);

    68

    69

static inline bool IsCargoInClass(CargoID c, uint16 cc)

    70

{

    71

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

    72

}

    73

    74

    75

#endif /* CARGOTYPE_H */