1

/* $Id$ */

     2

     3

/** @file ai_engine.hpp Everything to query and build engines. */

     4

     5

#ifndef AI_ENGINE_HPP

     6

#define AI_ENGINE_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "ai_vehicle.hpp"

    10

    11

/**

    12

 * Class that handles all engine related functions.

    13

 */

    14

class AIEngine : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * Checks whether the given engine type is valid and buildable by you.

    20

	 * @param engine_id The engine to check.

    21

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

    22

	 */

    23

	static bool IsValidEngine(EngineID engine_id);

    24

    25

	/**

    26

	 * Get the name of an engine.

    27

	 * @param engine_id The engine to get the name of.

    28

	 * @pre IsValidEngine(engine_id).

    29

	 * @return The name the engine has.

    30

	 */

    31

	static char *GetName(EngineID engine_id);

    32

    33

	/**

    34

	 * Get the cargo-type of an engine. In case it can transport 2 cargos, it

    35

	 *  returns the first.

    36

	 * @param engine_id The engine to get the cargo-type of.

    37

	 * @pre IsValidEngine(engine_id).

    38

	 * @return The cargo-type of the engine.

    39

	 */

    40

	static CargoID GetCargoType(EngineID engine_id);

    41

    42

	/**

    43

	 * Check if the cargo of an engine can be refitted to your requested. If

    44

	 *  the engine already allows this cargo, the function also returns true.

    45

	 * @param engine_id The engine to check for refitting.

    46

	 * @param cargo_id The cargo to check for refitting.

    47

	 * @pre IsValidEngine(engine_id).

    48

	 * @pre AICargo::IsValidCargo(cargo_id).

    49

	 * @return True if the engine can carry this cargo, either via refit, or

    50

	 *  by default.

    51

	 */

    52

	static bool CanRefitCargo(EngineID engine_id, CargoID cargo_id);

    53

    54

	/**

    55

	 * Get the capacity of an engine. In case it can transport 2 cargos, it

    56

	 *  returns the first.

    57

	 * @param engine_id The engine to get the capacity of.

    58

	 * @pre IsValidEngine(engine_id).

    59

	 * @return The capacity of the engine.

    60

	 */

    61

	static uint32 GetCapacity(EngineID engine_id);

    62

    63

	/**

    64

	 * Get the reliability of an engine. The value is between 0 and 100, where

    65

	 *  100 means 100% reliability (never breaks down) and 0 means 0%

    66

	 *  reliability (you most likely don't want to buy it).

    67

	 * @param engine_id The engine to get the reliability of.

    68

	 * @pre IsValidEngine(engine_id).

    69

	 * @return The reliability the engine has.

    70

	 */

    71

	static uint32 GetReliability(EngineID engine_id);

    72

    73

	/**

    74

	 * Get the maximum speed of an engine (in km/h).

    75

	 * @param engine_id The engine to get the maximum speed of.

    76

	 * @pre IsValidEngine(engine_id).

    77

	 * @return The maximum speed the engine has.

    78

	 */

    79

	static uint32 GetMaxSpeed(EngineID engine_id);

    80

    81

	/**

    82

	 * Get the new cost of an engine.

    83

	 * @param engine_id The engine to get the new cost of.

    84

	 * @pre IsValidEngine(engine_id).

    85

	 * @return The new cost the engine has.

    86

	 */

    87

	static uint32 GetPrice(EngineID engine_id);

    88

    89

	/**

    90

	 * Get the maximum age of a brand new engine.

    91

	 * @param engine_id The engine to get the maximum age of.

    92

	 * @pre IsValidEngine(engine_id).

    93

	 * @returns The maximum age of a new engine in days.

    94

	 * @note Age is in days; divide by 366 to get per year.

    95

	 */

    96

	static uint32 GetMaxAge(EngineID engine_id);

    97

    98

	/**

    99

	 * Get the running cost of an engine.

   100

	 * @param engine_id The engine to get the running cost of.

   101

	 * @pre IsValidEngine(engine_id).

   102

	 * @return The running cost of a vehicle per year.

   103

	 * @note Cost is per year; divide by 364 to get per day.

   104

	 */

   105

	static Money GetRunningCost(EngineID engine_id);

   106

   107

	/**

   108

	 * Get the type of an engine.

   109

	 * @param engine_id The engine to get the type of.

   110

	 * @pre IsValidEngine(engine_id).

   111

	 * @return The type the engine has.

   112

	 */

   113

	static AIVehicle::VehicleType GetVehicleType(EngineID engine_id);

   114

};

   115

   116

#endif /* AI_ENGINE_HPP */