1

/* $Id$ */

     2

     3

/** @file ai_cargo.hpp Everything to query about 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

	/**

    16

	 * The name of the class, needed by several sub-processes.

    17

	 */

    18

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

    19

    20

	/**

    21

	 * Checks whether the given cargo type is valid.

    22

	 * @param cargo_type the cargo to check.

    23

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

    24

	 */

    25

	static bool IsValidCargo(CargoID cargo_type);

    26

    27

	/**

    28

	 * Gets the string representation of the cargo label.

    29

	 * @param cargo_type to get the string representation of.

    30

	 * @return the cargo label.

    31

	 * @note the returned cargo label must be free'd (C++ only).

    32

	 */

    33

	char *GetCargoLabel(CargoID cargo_type);

    34

    35

	/**

    36

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

    37

	 * @param cargo_type is this cargo freight or not?

    38

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

    39

	 */

    40

	bool IsFreight(CargoID cargo_type);

    41

    42

	/**

    43

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

    44

	 *   given distance within the specified time.

    45

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

    46

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

    47

	 * @param cargo_type the cargo to transport.

    48

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

    49

	 */

    50

	int32 GetCargoIncome(uint32 distance, uint32 days_in_transit, CargoID cargo_type);

    51

};

    52

    53

#ifdef DEFINE_SQUIRREL_CLASS

    54

namespace SQConvert {

    55

	/* Allow AICargo to be used as Squirrel parameter */

    60

}; // namespace SQConvert

    61

    62

void SQAICargoRegister(Squirrel *engine) {

    63

	DefSQClass <AICargo> SQAICargo("AICargo");

    64

	SQAICargo.PreRegister(engine);

    65

	SQAICargo.AddConstructor(engine);

    66

    67

	SQAICargo.DefSQStaticMethod(engine, &AICargo::GetClassName, "GetClassName", 1, "x");

    68

	SQAICargo.DefSQStaticMethod(engine, &AICargo::IsValidCargo, "IsValidCargo", 2, "xi");

    69

    70

	SQAICargo.DefSQMethod(engine, &AICargo::GetCargoLabel,  "GetCargoLabel",  2, "xi");

    71

	SQAICargo.DefSQMethod(engine, &AICargo::IsFreight,      "IsFreight",      2, "xi");

    72

	SQAICargo.DefSQMethod(engine, &AICargo::GetCargoIncome, "GetCargoIncome", 4, "xiii");

    73

    74

	SQAICargo.PostRegister(engine);

    75

}

    76

#endif /* DEFINE_SQUIRREL_CLASS */

    77

    78

#endif /* AI_CARGO_HPP */