1

/* $Id$ */

     2

     3

/** @file ai_vehicle.hpp Everything to query and build vehicles */

     4

     5

#ifndef AI_VEHICLE_HPP

     6

#define AI_VEHICLE_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all vehicle related functions.

    12

 */

    13

class AIVehicle : public AIObject {

    14

public:

    15

	/**

    16

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

    17

	 * @param engine_id the engine to check.

    18

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

    19

	 */

    20

	static bool IsValidEngine(EngineID engine_id);

    21

    22

	/**

    23

	 * Checks whether the given vehicle is valid and owned by you.

    24

	 * @param vehicle_id the vehicle to check.

    25

	 * @return true if and only if the vehicle is valid.

    26

	 */

    27

	static bool IsValidVehicle(VehicleID vehicle_id);

    28

    29

	/**

    30

	 * Find the best road vehicle for this job, given a minimum reliability.

    31

	 * @param cargo           the cargo the vehicle has to transport.

    32

	 * @param min_reliability the minimum reliability of the vehicle,

    33

	 *   between 0 and 100.

    34

	 * @pre the tile at depot has a depot that can build the engine and

    35

	 *   is owned by you.

    36

	 * @pre AICargo::IsValidCargo(cargo).

    37

	 * @pre min_reliability is between 0 and 100.

    38

	 * @return the engine with the best characteristics, or INVALID_ENGINE

    39

	 *   when no engine was found given the cargo and reliability.

    40

	 */

    41

	EngineID FindBestRoadVehicle(CargoID cargo, uint8 min_reliability);

    42

    43

	/**

    44

	 * Builds a vehicle with the given engine at the given depot.

    45

	 * @param depot     the depot where the vehicle will be build.

    46

	 * @param engine_id the engine to use for this vehicle.

    47

	 * @pre the tile at depot has a depot that can build the engine and

    48

	 *   is owned by you.

    49

	 * @pre IsValidEngine(engine_id).

    50

	 * @return true if and only if the vehicle has been build.

    51

	 * @return the VehicleID of the new vehicle, or an invalid VehicleID when

    52

	 *   it failed. Check the return value using IsValidVehicle.

    53

	 */

    54

	VehicleID BuildVehicle(TileIndex depot, EngineID vehicle_id);

    55

    56

	/**

    57

	 * Clones a vehicle at the given depot, copying or cloning it's orders.

    58

	 * @param depot        the depot where the vehicle will be build.

    59

	 * @param vehicle_id   the vehicle to use as example for the new vehicle.

    60

	 * @param share_orders should the orders be copied or shared?

    61

	 * @pre the tile at depot has a depot.

    62

	 * @pre IsValidVehicle(vehicle_id).

    63

	 * @return the VehicleID of the new vehicle, or an invalid VehicleID when

    64

	 *   it failed. Check the return value using IsValidVehicle.

    65

	 */

    66

	VehicleID CloneVehicle(TileIndex depot, VehicleID vehicle_id, bool share_orders);

    67

    68

	/**

    69

	 * Refits a vehicle to the given cargo type

    70

	 * @param vehicle_id the vehicle to refit

    71

	 * @param cargo      the cargo to refit to

    72

	 * @pre IsValidVehicle(vehicle_id).

    73

	 * @pre AICargo::IsValidCargo(cargo)

    74

	 * @pre you must own the vehicle

    75

	 * @pre the vehicle must be stopped in the depot

    76

	 * @return true if and only if the refit succeeded.

    77

	 */

    78

	bool RefitVehicle(VehicleID vehicle_id, CargoID cargo);

    79

    80

	/**

    81

	 * Sells the given vehicle.

    82

	 * @param vehicle_id the vehicle to sell.

    83

	 * @pre IsValidVehicle(vehicle_id).

    84

	 * @pre you must own the vehicle

    85

	 * @pre the vehicle must be stopped in the depot

    86

	 * @return true if and only if the vehicle has been sold.

    87

	 */

    88

	bool SellVehicle(VehicleID vehicle_id);

    89

    90

    91

	/**

    92

	 * Sends the given vehicle to a depot.

    93

	 * @param vehicle_id the vehicle to send to a depot.

    94

	 * @pre IsValidVehicle(vehicle_id).

    95

	 * @return true if and only if the vehicle has been sent to a depot.

    96

	 */

    97

	bool SendVehicleToDepot(VehicleID vehicle_id);

    98

    99

	/**

   100

	 * Starts or stops the given vehicle depending on the current state.

   101

	 * @param vehicle_id the vehicle to start/stop.

   102

	 * @pre IsValidVehicle(vehicle_id).

   103

	 * @return true if and only if the vehicle has been started or stopped.

   104

	 */

   105

	bool StartStopVehicle(VehicleID vehicle_id);

   106

   107

	/**

   108

	 * Skips the current order of the given vehicle.

   109

	 * @param vehicle_id the vehicle to skip the order for.

   110

	 * @pre IsValidVehicle(vehicle_id).

   111

	 * @return true if and only if the order has been skipped.

   112

	 */

   113

	bool SkipVehicleOrder(VehicleID vehicle_id);

   114

};

   115

   116

#ifdef DEFINE_SQUIRREL_CLASS

   117

void SQAIVehicleRegister(Squirrel *engine) {

   118

	DefSQClass <AIVehicle> SQAIVehicle("AIVehicle");

   119

	SQAIVehicle.PreRegister(engine);

   120

	SQAIVehicle.AddConstructor(engine);

   121

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::IsValidEngine,       "IsValidEngine");

   122

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::IsValidVehicle,      "IsValidVehicle");

   123

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::FindBestRoadVehicle, "FindBestRoadVehicle");

   124

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::BuildVehicle,        "BuildVehicle");

   125

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::CloneVehicle,        "CloneVehicle");

   126

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::RefitVehicle,        "RefitVehicle");

   127

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::SellVehicle,         "SellVehicle");

   128

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::SendVehicleToDepot,  "SendVehicleToDepot");

   129

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::StartStopVehicle,    "StartStopVehicle");

   130

	SQAIVehicle.DefSQFunction(engine, &AIVehicle::SkipVehicleOrder,    "SkipVehicleOrder");

   131

	SQAIVehicle.PostRegister(engine);

   132

}

   134

   135

#endif /* AI_VEHICLE_HPP */