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 type of a vehicle available in the game. Trams for example are

    18

	 *  road vehicles, as maglev is a rail vehicle.

    19

	 */

    20

	enum VehicleType {

    21

		/* Order IS important, as it now matches the internal state of the game for vehicle type */

    22

		VEHICLE_RAIL,

    23

		VEHICLE_ROAD,

    24

		VEHICLE_WATER,

    25

		VEHICLE_AIR,

    26

		VEHICLE_INVALID = 0xFF,

    27

	};

    28

    29

	/**

    30

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

    31

	 */

    32

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

    33

    34

	/**

    35

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

    36

	 * @param engine_id the engine to check.

    37

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

    38

	 */

    39

	static bool IsValidEngine(EngineID engine_id);

    40

    41

	/**

    42

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

    43

	 * @param vehicle_id the vehicle to check.

    44

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

    45

	 */

    46

	static bool IsValidVehicle(VehicleID vehicle_id);

    47

    48

	/**

    49

	 * Find the best road vehicle 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

	 * @param max_cost        the maximum cost for the vehicle.

    54

	 * @pre AICargo::IsValidCargo(cargo).

    55

	 * @pre min_reliability is between 0 and 100.

    56

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

    57

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

    58

	 *   return value using IsValidEngine.

    59

	 */

    60

	EngineID FindBestRoadVehicle(CargoID cargo, uint8 min_reliability, uint max_cost);

    61

    62

	/**

    63

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

    64

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

    65

	 * @param min_reliability the minimum reliability of the vehicle,

    66

	 *   between 0 and 100.

    67

	 * @param max_cost        the maximum cost for the vehicle.

    68

	 * @pre AICargo::IsValidCargo(cargo).

    69

	 * @pre min_reliability is between 0 and 100.

    70

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

    71

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

    72

	 *   return value using IsValidEngine.

    73

	 */

    89

    90

	/**

    91

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

    92

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

    93

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

    94

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

    95

	 *   is owned by you.

    96

	 * @pre IsValidEngine(engine_id).

    97

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

    98

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

    99

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

   100

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

   101

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

   102

	 *   assigning orders.

   103

	 */

   104

	VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);

   105

   106

	/**

   107

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

   108

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

   109

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

   110

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

   111

	 * @pre the tile at depot has a depot.

   112

	 * @pre IsValidVehicle(vehicle_id).

   113

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

   114

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

   115

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

   116

	 */

   117

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

   118

   119

	/**

   120

	 * Refits a vehicle to the given cargo type

   121

	 * @param vehicle_id the vehicle to refit

   122

	 * @param cargo      the cargo to refit to

   123

	 * @pre IsValidVehicle(vehicle_id).

   124

	 * @pre AICargo::IsValidCargo(cargo)

   125

	 * @pre you must own the vehicle

   126

	 * @pre the vehicle must be stopped in the depot

   127

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

   128

	 */

   129

	bool RefitVehicle(VehicleID vehicle_id, CargoID cargo);

   130

   131

	/**

   132

	 * Sells the given vehicle.

   133

	 * @param vehicle_id the vehicle to sell.

   134

	 * @pre IsValidVehicle(vehicle_id).

   135

	 * @pre you must own the vehicle

   136

	 * @pre the vehicle must be stopped in the depot

   137

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

   138

	 */

   139

	bool SellVehicle(VehicleID vehicle_id);

   140

   141

   142

	/**

   143

	 * Sends the given vehicle to a depot.

   144

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

   145

	 * @pre IsValidVehicle(vehicle_id).

   146

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

   147

	 */

   148

	bool SendVehicleToDepot(VehicleID vehicle_id);

   149

   150

	/**

   151

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

   152

	 * @param vehicle_id the vehicle to start/stop.

   153

	 * @pre IsValidVehicle(vehicle_id).

   154

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

   155

	 */

   156

	bool StartStopVehicle(VehicleID vehicle_id);

   157

   158

	/**

   159

	 * Skips the current order of the given vehicle.

   160

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

   161

	 * @pre IsValidVehicle(vehicle_id).

   162

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

   163

	 */

   164

	bool SkipVehicleOrder(VehicleID vehicle_id);

   165

   166

	/**

   167

	 * Get the current location of a vehicle.

   168

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

   169

	 * @pre IsValidVehicle(vehicle_id).

   170

	 * @return the tile the vehicle is currently on.

   171

	 */

   172

	static TileIndex GetLocation(VehicleID vehicle_id);

   173

   174

	/**

   175

	 * Get the engine-type of a vehicle.

   176

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

   177

	 * @pre IsValidVehicle(vehicle_id).

   178

	 * @return the engine type the vehicle has.

   179

	 */

   180

	static EngineID GetEngineType(VehicleID vehicle_id);

   181

   182

	/**

   183

	 * Get the unitnumber of a vehicle.

   184

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

   185

	 * @pre IsValidVehicle(vehicle_id).

   186

	 * @return the unitnumber the vehicle has.

   187

	 */

   188

	static int32 GetUnitNumber(VehicleID vehicle_id);

   189

   190

	/**

   191

	 * Get the current age of a vehicle.

   192

	 * @note age is in days.

   193

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

   194

	 * @pre IsValidVehicle(vehicle_id).

   195

	 * @return the current age the vehicle has.

   196

	 */

   197

	static int32 GetAge(VehicleID vehicle_id);

   198

   199

	/**

   200

	 * Get the max age of a vehicle.

   201

	 * @note age is in days.

   202

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

   203

	 * @pre IsValidVehicle(vehicle_id).

   204

	 * @return the max age the vehicle has.

   205

	 */

   206

	static int32 GetMaxAge(VehicleID vehicle_id);

   207

   208

	/**

   209

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

   210

	 * @note age is in days.

   211

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

   212

	 * @pre IsValidVehicle(vehicle_id).

   213

	 * @return the age the vehicle has left.

   214

	 */

   215

	static int32 GetAgeLeft(VehicleID vehicle_id);

   216

   217

	/**

   218

	 * Get the current profit of a vehicle.

   219

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

   220

	 * @pre IsValidVehicle(vehicle_id).

   221

	 * @return the current profit the vehicle has.

   222

	 */

   223

	static int32 GetProfitThisYear(VehicleID vehicle_id);

   224

   225

	/**

   226

	 * Get the profit of last year of a vehicle.

   227

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

   228

	 * @pre IsValidVehicle(vehicle_id).

   229

	 * @return the profit the vehicle had last year.

   230

	 */

   231

	static int32 GetProfitLastYear(VehicleID vehicle_id);

   232

   233

	/**

   234

	 * Get the type of vehicle.

   235

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

   236

	 * @pre IsValidVehicle(vehicle_id).

   237

	 * @return the vehicle type.

   238

	 */

   239

	static AIVehicle::VehicleType GetVehicleType(VehicleID vehicle_id);

   240

   241

private:

   242

	EngineID FindBestVehicle(CargoID cargo, uint8 min_reliability, AIVehicle::VehicleType veh_type, uint max_cost);

   243

};

   244

   245

#endif /* AI_VEHICLE_HPP */