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

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

    17

	 */

    18

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

    19

    20

	/**

    21

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

    22

	 * @param engine_id the engine to check.

    23

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

    24

	 */

    25

	static bool IsValidEngine(EngineID engine_id);

    26

    27

	/**

    28

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

    29

	 * @param vehicle_id the vehicle to check.

    30

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

    31

	 */

    32

	static bool IsValidVehicle(VehicleID vehicle_id);

    33

    34

	/**

    35

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

    36

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

    37

	 * @param min_reliability the minimum reliability of the vehicle,

    38

	 *   between 0 and 100.

    39

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

    40

	 *   is owned by you.

    41

	 * @pre AICargo::IsValidCargo(cargo).

    42

	 * @pre min_reliability is between 0 and 100.

    43

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

    44

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

    45

	 *   return value using IsValidEngine.

    46

	 */

    47

	EngineID FindBestRoadVehicle(CargoID cargo, uint8 min_reliability);

    48

    49

	/**

    50

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

    51

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

    52

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

    53

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

    54

	 *   is owned by you.

    55

	 * @pre IsValidEngine(engine_id).

    56

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

    57

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

    58

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

    59

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

    60

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

    61

	 *   assigning orders.

    62

	 */

    63

	VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);

    64

    65

	/**

    66

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

    67

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

    68

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

    69

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

    70

	 * @pre the tile at depot has a depot.

    71

	 * @pre IsValidVehicle(vehicle_id).

    72

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

    73

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

    74

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

    75

	 */

    76

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

    77

    78

	/**

    79

	 * Refits a vehicle to the given cargo type

    80

	 * @param vehicle_id the vehicle to refit

    81

	 * @param cargo      the cargo to refit to

    82

	 * @pre IsValidVehicle(vehicle_id).

    83

	 * @pre AICargo::IsValidCargo(cargo)

    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 refit succeeded.

    87

	 */

    88

	bool RefitVehicle(VehicleID vehicle_id, CargoID cargo);

    89

    90

	/**

    91

	 * Sells the given vehicle.

    92

	 * @param vehicle_id the vehicle to sell.

    93

	 * @pre IsValidVehicle(vehicle_id).

    94

	 * @pre you must own the vehicle

    95

	 * @pre the vehicle must be stopped in the depot

    96

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

    97

	 */

    98

	bool SellVehicle(VehicleID vehicle_id);

    99

   100

   101

	/**

   102

	 * Sends the given vehicle to a depot.

   103

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

   104

	 * @pre IsValidVehicle(vehicle_id).

   105

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

   106

	 */

   107

	bool SendVehicleToDepot(VehicleID vehicle_id);

   108

   109

	/**

   110

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

   111

	 * @param vehicle_id the vehicle to start/stop.

   112

	 * @pre IsValidVehicle(vehicle_id).

   113

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

   114

	 */

   115

	bool StartStopVehicle(VehicleID vehicle_id);

   116

   117

	/**

   118

	 * Skips the current order of the given vehicle.

   119

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

   120

	 * @pre IsValidVehicle(vehicle_id).

   121

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

   122

	 */

   123

	bool SkipVehicleOrder(VehicleID vehicle_id);

   124

   125

	/**

   126

	 * Get the current location of a vehicle.

   127

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

   128

	 * @pre IsValidVehicle(vehicle_id).

   129

	 * @return the tile the vehicle is currently on.

   130

	 */

   131

	static TileIndex GetLocation(VehicleID vehicle_id);

   132

   133

	/**

   134

	 * Get the engine-type of a vehicle.

   135

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

   136

	 * @pre IsValidVehicle(vehicle_id).

   137

	 * @return the engine type the vehicle has.

   138

	 */

   139

	static EngineID GetEngineType(VehicleID vehicle_id);

   140

   141

	/**

   142

	 * Get the unitnumber of a vehicle.

   143

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

   144

	 * @pre IsValidVehicle(vehicle_id).

   145

	 * @return the unitnumber the vehicle has.

   146

	 */

   147

	static int32 GetUnitNumber(VehicleID vehicle_id);

   148

   149

	/**

   150

	 * Get the current age of a vehicle.

   151

	 * @note age is in days.

   152

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

   153

	 * @pre IsValidVehicle(vehicle_id).

   154

	 * @return the current age the vehicle has.

   155

	 */

   156

	static int32 GetAge(VehicleID vehicle_id);

   157

   158

	/**

   159

	 * Get the max age of a vehicle.

   160

	 * @note age is in days.

   161

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

   162

	 * @pre IsValidVehicle(vehicle_id).

   163

	 * @return the max age the vehicle has.

   164

	 */

   165

	static int32 GetMaxAge(VehicleID vehicle_id);

   166

   167

	/**

   168

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

   169

	 * @note age is in days.

   170

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

   171

	 * @pre IsValidVehicle(vehicle_id).

   172

	 * @return the age the vehicle has left.

   173

	 */

   174

	static int32 GetAgeLeft(VehicleID vehicle_id);

   175

   176

	/**

   177

	 * Get the current profit of a vehicle.

   178

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

   179

	 * @pre IsValidVehicle(vehicle_id).

   180

	 * @return the current profit the vehicle has.

   181

	 */

   182

	static int32 GetProfitThisYear(VehicleID vehicle_id);

   183

   184

	/**

   185

	 * Get the profit of last year of a vehicle.

   186

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

   187

	 * @pre IsValidVehicle(vehicle_id).

   188

	 * @return the profit the vehicle had last year.

   189

	 */

   190

	static int32 GetProfitLastYear(VehicleID vehicle_id);

   191

};

   192

   193

#endif /* AI_VEHICLE_HPP */