1

/* $Id$ */

     2

     3

/** @file ai_cargo.hpp Everything to query cargos. */

     4

     5

#ifndef AI_CARGO_HPP

     6

#define AI_CARGO_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all cargo related functions.

    12

 */

    13

class AICargo : public AIObject {

    14

public:

    15

	static const char *GetClassName() { return "AICargo"; }

    16

    17

	/**

    18

	 * The classes of cargo (from newgrf_cargo.h).

    19

	 */

    20

	enum CargoClass {

    21

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

    22

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

    23

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

    24

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

    25

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

    26

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

    27

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

    28

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

    29

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

    30

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

    31

	};

    32

    33

	/**

    34

	 * The effects a cargo can have on a town.

    35

	 */

    36

	enum TownEffect {

    37

		TE_NONE       = 0, ///< This cargo has no effect on a town

    38

		TE_PASSENGERS = 1, ///< This cargo supplies passengers to a town

    39

		TE_MAIL       = 2, ///< This cargo supplies mail to a town

    40

		TE_GOODS      = 3, ///< This cargo supplies goods to a town

    41

		TE_WATER      = 4, ///< This cargo supplies water to a town

    42

		TE_FOOD       = 5, ///< This cargo supplies food to a town

    43

	};

    44

    45

	/**

    46

	 * Checks whether the given cargo type is valid.

    47

	 * @param cargo_type The cargo to check.

    48

	 * @return True if and only if the cargo type is valid.

    49

	 */

    50

	static bool IsValidCargo(CargoID cargo_type);

    51

    52

	/**

    53

	 * Gets the string representation of the cargo label.

    54

	 * @param cargo_type The cargo to get the string representation of.

    55

	 * @return The cargo label.

    56

	 * @note Never use this to check if it is a certain cargo. NewGRF can

    57

	 *  redefine all of the names.

    58

	 */

    59

	static char *GetCargoLabel(CargoID cargo_type);

    60

    61

	/**

    62

	 * Checks whether the give cargo is a freight or not.

    63

	 * @param cargo_type The cargo to check on.

    64

	 * @return True if and only if the cargo is freight.

    65

	 */

    66

	static bool IsFreight(CargoID cargo_type);

    67

    68

	/**

    69

	 * Check if this cargo is in the requested cargo class.

    70

	 * @param cargo_type The cargo to check on.

    71

	 * @param cargo_class The class to check for.

    72

	 * @return True if and only if the cargo is in the cargo class.

    73

	 */

    74

	static bool HasCargoClass(CargoID cargo_type, CargoClass cargo_class);

    75

    76

	/**

    77

	 * Get the effect this cargo has on a town.

    78

	 * @param cargo_type The cargo to check on.

    79

	 * @return The effect this cargo has on a town, or TE_NONE if it has no effect.

    80

	 */

    81

	static TownEffect GetTownEffect(CargoID cargo_type);

    82

    83

	/**

    84

	 * Get the income for transporting a piece of cargo over the

    85

	 *   given distance within the specified time.

    86

	 * @param cargo_type The cargo to transport.

    87

	 * @param distance The distance the cargo travels from begin to end.

    88

	 * @param days_in_transit Amount of (game) days the cargo is in transit.

    89

	 * @return The amount of money that would be earned by this trip.

    90

	 */

    91

	static Money GetCargoIncome(CargoID cargo_type, uint32 distance, uint32 days_in_transit);

    92

};

    93

    94

#endif /* AI_CARGO_HPP */