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

	 * Checks whether the given cargo type is valid.

    17

	 * @param cargo_type the cargo to check.

    18

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

    19

	 */

    20

	static bool IsValidCargo(CargoID cargo_type);

    21

    22

	/**

    23

	 * Gets the string representation of the cargo label.

    24

	 * @param cargo_type to get the string representation of.

    25

	 * @return the cargo label.

    26

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

    27

	 */

    28

	char *GetCargoLabel(CargoID cargo_type);

    29

    30

	/**

    31

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

    32

	 * @param cargo_type is this cargo freight or not?

    33

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

    34

	 */

    35

	bool IsFreight(CargoID cargo_type);

    36

    37

	/**

    38

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

    39

	 *   given distance within the specified time.

    40

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

    41

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

    42

	 * @param cargo_type the cargo to transport.

    43

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

    44

	 */

    45

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

    46

};

    47

    48

#ifdef DEFINE_SQUIRREL_CLASS

    54

void SQAICargoRegister(Squirrel *engine) {

    55

	DefSQClass <AICargo> SQAICargo("AICargo");

    56

	SQAICargo.PreRegister(engine);

    57

	SQAICargo.AddConstructor(engine);

    58

	SQAICargo.DefSQFunction(engine, &AICargo::IsValidCargo,   "IsValidCargo");

    59

	SQAICargo.DefSQFunction(engine, &AICargo::GetCargoLabel,  "GetCargoLabel");

    60

	SQAICargo.DefSQFunction(engine, &AICargo::IsFreight,      "IsFreight");

    61

	SQAICargo.DefSQFunction(engine, &AICargo::GetCargoIncome, "GetCargoIncome");

    62

	SQAICargo.PostRegister(engine);

    63

}

    64

#endif /* DEFINE_SQUIRREL_CLASS */

    65

    66

#endif /* AI_CARGO_HPP */