1

/* $Id$ */

     2

     3

/** @file newgrf_cargo.h Cargo support for NewGRFs. */

     4

     5

#ifndef NEWGRF_CARGO_H

     6

#define NEWGRF_CARGO_H

     7

     8

#include "newgrf_callbacks.h"

     9

#include "cargo_type.h"

    10

#include "gfx_type.h"

    11

    12

enum CargoClass {

    13

	CC_NOAVAILABLE  = 0,       ///< No cargo class has been specified

    14

	CC_PASSENGERS   = 1 <<  0, ///< Passengers

    15

	CC_MAIL         = 1 <<  1, ///< Mail

    16

	CC_EXPRESS      = 1 <<  2, ///< Express cargo (Goods, Food, Candy, but also possible for passengers)

    17

	CC_ARMOURED     = 1 <<  3, ///< Armoured cargo (Valuables, Gold, Diamonds)

    18

	CC_BULK         = 1 <<  4, ///< Bulk cargo (Coal, Grain etc., Ores, Fruit)

    19

	CC_PIECE_GOODS  = 1 <<  5, ///< Piece goods (Livestock, Wood, Steel, Paper)

    20

	CC_LIQUID       = 1 <<  6, ///< Liquids (Oil, Water, Rubber)

    21

	CC_REFRIGERATED = 1 <<  7, ///< Refrigerated cargo (Food, Fruit)

    22

	CC_HAZARDOUS    = 1 <<  8, ///< Hazardous cargo (Nuclear Fuel, Explosives, etc.)

    23

	CC_COVERED      = 1 <<  9, ///< Covered/Sheltered Freight (Transporation in Box Vans, Silo Wagons, etc.)

    24

	CC_SPECIAL      = 1 << 15  ///< Special bit used for livery refit tricks instead of normal cargoes.

    25

};

    26

    27

static const CargoID CT_DEFAULT      = NUM_CARGO + 0;

    28

static const CargoID CT_PURCHASE     = NUM_CARGO + 1;

    29

static const CargoID CT_DEFAULT_NA   = NUM_CARGO + 2;

    30

    31

/* Forward declarations of structs used */

    32

struct CargoSpec;

    33

struct GRFFile;

    34

    35

SpriteID GetCustomCargoSprite(const CargoSpec *cs);

    36

uint16 GetCargoCallback(CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs);

    37

CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit = false);

    38

uint8 GetReverseCargoTranslation(CargoID cargo, const GRFFile *grffile);

    39

    40

#endif /* NEWGRF_CARGO_H */