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

#include "../../vehicle.h"

    10

    11

/**

    12

 * Class that handles all vehicle related functions.

    13

 */

    14

class AIVehicle : public AIObject {

    15

public:

    16

	/**

    17

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

    18

	 */

    19

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

    20

    21

	/**

    22

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

    23

	 * @param engine_id the engine to check.

    24

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

    25

	 */

    26

	static bool IsValidEngine(EngineID engine_id);

    27

    28

	/**

    29

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

    30

	 * @param vehicle_id the vehicle to check.

    31

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

    32

	 */

    33

	static bool IsValidVehicle(VehicleID vehicle_id);

    34

    35

	/**

    36

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

    37

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

    38

	 * @param min_reliability the minimum reliability of the vehicle,

    39

	 *   between 0 and 100.

    40

	 * @pre AICargo::IsValidCargo(cargo).

    41

	 * @pre min_reliability is between 0 and 100.

    42

	 * @return the engine with the best characteristics, or an invalid engine

    43

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

    44

	 *   return value using IsValidEngine.

    45

	 */

    46

	EngineID FindBestRoadVehicle(CargoID cargo, uint8 min_reliability);

    47

    48

	/**

    49

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

    50

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

    51

	 * @param min_reliability the minimum reliability of the vehicle,

    52

	 *   between 0 and 100.

    53

	 * @pre AICargo::IsValidCargo(cargo).

    54

	 * @pre min_reliability is between 0 and 100.

    55

	 * @return the engine with the best characteristics, or an invalid engine

    56

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

    57

	 *   return value using IsValidEngine.

    58

	 */

    59

	EngineID FindBestAircraftVehicle(CargoID cargo, uint8 min_reliability);

    60

    61

	/**

    62

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

    63

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

    64

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

    65

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

    66

	 *   is owned by you.

    67

	 * @pre IsValidEngine(engine_id).

    68

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

    69

	 *   it failed. Check the return value using IsValidVehicle. In test-mode

    70

	 *   0 is returned if it was successful; any other value indicates failure.

    71

	 * @note in test-mode it means you can't assign orders yet to this vehicle,

    72

	 *   as the vehicle isn't really built yet. Build it for real first before

    73

	 *   assigning orders.

    74

	 */

    75

	VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);

    76

    77

	/**

    78

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

    79

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

    80

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

    81

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

    82

	 * @pre the tile at depot has a depot.

    83

	 * @pre IsValidVehicle(vehicle_id).

    84

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

    85

	 *   it failed. Check the return value using IsValidVehicle. In test-mode

    86

	 *   0 is returned if it was successful; any other value indicates failure.

    87

	 */

    88

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

    89

    90

	/**

    91

	 * Refits a vehicle to the given cargo type

    92

	 * @param vehicle_id the vehicle to refit

    93

	 * @param cargo      the cargo to refit to

    94

	 * @pre IsValidVehicle(vehicle_id).

    95

	 * @pre AICargo::IsValidCargo(cargo)

    96

	 * @pre you must own the vehicle

    97

	 * @pre the vehicle must be stopped in the depot

    98

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

    99

	 */

   100

	bool RefitVehicle(VehicleID vehicle_id, CargoID cargo);

   101

   102

	/**

   103

	 * Sells the given vehicle.

   104

	 * @param vehicle_id the vehicle to sell.

   105

	 * @pre IsValidVehicle(vehicle_id).

   106

	 * @pre you must own the vehicle

   107

	 * @pre the vehicle must be stopped in the depot

   108

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

   109

	 */

   110

	bool SellVehicle(VehicleID vehicle_id);

   111

   112

   113

	/**

   114

	 * Sends the given vehicle to a depot.

   115

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

   116

	 * @pre IsValidVehicle(vehicle_id).

   117

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

   118

	 */

   119

	bool SendVehicleToDepot(VehicleID vehicle_id);

   120

   121

	/**

   122

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

   123

	 * @param vehicle_id the vehicle to start/stop.

   124

	 * @pre IsValidVehicle(vehicle_id).

   125

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

   126

	 */

   127

	bool StartStopVehicle(VehicleID vehicle_id);

   128

   129

	/**

   130

	 * Skips the current order of the given vehicle.

   131

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

   132

	 * @pre IsValidVehicle(vehicle_id).

   133

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

   134

	 */

   135

	bool SkipVehicleOrder(VehicleID vehicle_id);

   136

   137

	/**

   138

	 * Get the current location of a vehicle.

   139

	 * @param vehicle_id the vehicle to get the location of.

   140

	 * @pre IsValidVehicle(vehicle_id).

   141

	 * @return the tile the vehicle is currently on.

   142

	 */

   143

	static TileIndex GetLocation(VehicleID vehicle_id);

   144

   145

	/**

   146

	 * Get the engine-type of a vehicle.

   147

	 * @param vehicle_id the vehicle to get the engine-type of.

   148

	 * @pre IsValidVehicle(vehicle_id).

   149

	 * @return the engine type the vehicle has.

   150

	 */

   151

	static EngineID GetEngineType(VehicleID vehicle_id);

   152

   153

	/**

   154

	 * Get the unitnumber of a vehicle.

   155

	 * @param vehicle_id the vehicle to get the unitnumber of.

   156

	 * @pre IsValidVehicle(vehicle_id).

   157

	 * @return the unitnumber the vehicle has.

   158

	 */

   159

	static int32 GetUnitNumber(VehicleID vehicle_id);

   160

   161

	/**

   162

	 * Get the current age of a vehicle.

   163

	 * @note age is in days.

   164

	 * @param vehicle_id the vehicle to get the age of.

   165

	 * @pre IsValidVehicle(vehicle_id).

   166

	 * @return the current age the vehicle has.

   167

	 */

   168

	static int32 GetAge(VehicleID vehicle_id);

   169

   170

	/**

   171

	 * Get the max age of a vehicle.

   172

	 * @note age is in days.

   173

	 * @param vehicle_id the vehicle to get the age of.

   174

	 * @pre IsValidVehicle(vehicle_id).

   175

	 * @return the max age the vehicle has.

   176

	 */

   177

	static int32 GetMaxAge(VehicleID vehicle_id);

   178

   179

	/**

   180

	 * Get the age a vehicle has left (max - current).

   181

	 * @note age is in days.

   182

	 * @param vehicle_id the vehicle to get the age of.

   183

	 * @pre IsValidVehicle(vehicle_id).

   184

	 * @return the age the vehicle has left.

   185

	 */

   186

	static int32 GetAgeLeft(VehicleID vehicle_id);

   187

   188

	/**

   189

	 * Get the current profit of a vehicle.

   190

	 * @param vehicle_id the vehicle to get the profit of.

   191

	 * @pre IsValidVehicle(vehicle_id).

   192

	 * @return the current profit the vehicle has.

   193

	 */

   194

	static int32 GetProfitThisYear(VehicleID vehicle_id);

   195

   196

	/**

   197

	 * Get the profit of last year of a vehicle.

   198

	 * @param vehicle_id the vehicle to get the profit of.

   199

	 * @pre IsValidVehicle(vehicle_id).

   200

	 * @return the profit the vehicle had last year.

   201

	 */

   202

	static int32 GetProfitLastYear(VehicleID vehicle_id);

   203

   204

private:

   205

	EngineID FindBestVehicle(CargoID cargo, uint8 min_reliability, VehicleType veh_type);

   206

};

   207

   208

#endif /* AI_VEHICLE_HPP */