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 "ai_error.hpp"

    10

#include "../../engine_type.h"

    11

    12

/**

    13

 * Class that handles all vehicle related functions.

    14

 */

    15

class AIVehicle : public AIObject {

    16

public:

    17

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

    18

    19

	enum ErrorMessages {

    20

		/** Base for vehicle related errors */

    21

		ERR_VEHICLE_BASE = AIError::ERR_CAT_VEHICLE << AIError::ERR_CAT_BIT_SIZE,

    22

    23

		/** Too many vehicles in the game, can't build any more. */

    24

		ERR_VEHICLE_TOO_MANY,                   // [STR_00E1_TOO_MANY_VEHICLES_IN_GAME]

    25

    26

		/** Vehicle is not available */

    27

		ERR_VEHICLE_NOT_AVAILABLE,              // [STR_AIRCRAFT_NOT_AVAILABLE, STR_ROAD_VEHICLE_NOT_AVAILABLE, STR_SHIP_NOT_AVAILABLE, STR_RAIL_VEHICLE_NOT_AVAILABLE]

    28

    29

		/** Vehicle can't be build due to game settigns */

    30

		ERR_VEHICLE_BUILD_DISABLED,             // [STR_A008_CAN_T_BUILD_AIRCRAFT, STR_980D_CAN_T_BUILD_SHIP, STR_9009_CAN_T_BUILD_ROAD_VEHICLE, STR_882B_CAN_T_BUILD_RAILROAD_VEHICLE]

    31

    32

		/** Vehicle can't be build in the selected depot */

    33

		ERR_VEHICLE_WRONG_DEPOT,                // [STR_DEPOT_WRONG_DEPOT_TYPE]

    34

    35

		/** Vehicle can't return to the depot */

    36

		ERR_VEHICLE_CANNOT_SEND_TO_DEPOT,       // [STR_8830_CAN_T_SEND_TRAIN_TO_DEPOT, STR_9018_CAN_T_SEND_VEHICLE_TO_DEPOT, STR_9819_CAN_T_SEND_SHIP_TO_DEPOT, STR_A012_CAN_T_SEND_AIRCRAFT_TO]

    37

    38

		/** Vehicle can't start / stop */

    39

		ERR_VEHICLE_CANNOT_START_STOP,          // [STR_883B_CAN_T_STOP_START_TRAIN, STR_9015_CAN_T_STOP_START_ROAD_VEHICLE, STR_9818_CAN_T_STOP_START_SHIP, STR_A016_CAN_T_STOP_START_AIRCRAFT]

    40

    41

		/** Vehicle can't turn */

    42

		ERR_VEHICLE_CANNOT_TURN,                // [STR_8869_CAN_T_REVERSE_DIRECTION, STR_9033_CAN_T_MAKE_VEHICLE_TURN]

    43

    44

		/** Vehicle can't be refit */

    45

		ERR_VEHICLE_CANNOT_REFIT,               // [STR_RAIL_CAN_T_REFIT_VEHICLE, STR_REFIT_ROAD_VEHICLE_CAN_T, STR_9841_CAN_T_REFIT_SHIP, STR_A042_CAN_T_REFIT_AIRCRAFT]

    46

    47

		/** Vehicle is destroyed */

    48

		ERR_VEHICLE_IS_DESTROYED,               // [STR_CAN_T_REFIT_DESTROYED_VEHICLE, STR_CAN_T_SELL_DESTROYED_VEHICLE]

    49

    50

		/** Vehicle is not in a depot */

    51

		ERR_VEHICLE_NOT_IN_DEPOT,               // [STR_A01B_AIRCRAFT_MUST_BE_STOPPED, STR_9013_MUST_BE_STOPPED_INSIDE, STR_TRAIN_MUST_BE_STOPPED, STR_980B_SHIP_MUST_BE_STOPPED_IN]

    52

    53

		/** Vehicle is flying */

    54

		ERR_VEHICLE_IN_FLIGHT,                  // [STR_A017_AIRCRAFT_IS_IN_FLIGHT]

    55

    56

		/** Vehicle is without power */

    57

		ERR_VEHCILE_NO_POWER,                   // [STR_TRAIN_START_NO_CATENARY]

    58

    59

	};

    60

	/**

    61

	 * The type of a vehicle available in the game. Trams for example are

    62

	 *  road vehicles, as maglev is a rail vehicle.

    63

	 */

    64

	enum VehicleType {

    65

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

    66

		VEHICLE_RAIL,           //!< Rail type vehicle.

    67

		VEHICLE_ROAD,           //!< Road type vehicle (bus / truck).

    68

		VEHICLE_WATER,          //!< Water type vehicle.

    69

		VEHICLE_AIR,            //!< Air type vehicle.

    70

		VEHICLE_INVALID = 0xFF, //!< Invalid vehicle type.

    71

	};

    72

    73

	/**

    74

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

    75

	 * @param vehicle_id The vehicle to check.

    76

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

    77

	 */

    78

	static bool IsValidVehicle(VehicleID vehicle_id);

    79

    80

	/**

    81

	 * Set the name of a vehicle.

    82

	 * @param vehicle_id The vehicle to set the name for.

    83

	 * @param name The name for the vehicle.

    84

	 * @pre IsValidVehicle(vehicle_id).

    85

	 * @pre Name has to be unique.

    86

	 * @pre You have to own the vehicle.

    87

	 * @return True if and only if the name was changed.

    88

	 */

    89

	static bool SetName(VehicleID vehicle_id, const char *name);

    90

    91

	/**

    92

	 * Get the name of a vehicle.

    93

	 * @param vehicle_id The vehicle to get the name of.

    94

	 * @pre IsValidVehicle(vehicle_id).

    95

	 * @return The name the vehicle has.

    96

	 */

    97

	static char *GetName(VehicleID vehicle_id);

    98

    99

	/**

   100

	 * Get the current location of a vehicle.

   101

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

   102

	 * @pre IsValidVehicle(vehicle_id).

   103

	 * @return The tile the vehicle is currently on.

   104

	 */

   105

	static TileIndex GetLocation(VehicleID vehicle_id);

   106

   107

	/**

   108

	 * Get the engine-type of a vehicle.

   109

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

   110

	 * @pre IsValidVehicle(vehicle_id).

   111

	 * @return The engine type the vehicle has.

   112

	 */

   113

	static EngineID GetEngineType(VehicleID vehicle_id);

   114

   115

	/**

   116

	 * Get the unitnumber of a vehicle.

   117

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

   118

	 * @pre IsValidVehicle(vehicle_id).

   119

	 * @return The unitnumber the vehicle has.

   120

	 */

   121

	static int32 GetUnitNumber(VehicleID vehicle_id);

   122

   123

	/**

   124

	 * Get the current age of a vehicle.

   125

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

   126

	 * @pre IsValidVehicle(vehicle_id).

   127

	 * @return The current age the vehicle has.

   128

	 * @note The age is in days.

   129

	 */

   130

	static int32 GetAge(VehicleID vehicle_id);

   131

   132

	/**

   133

	 * Get the maximum age of a vehicle.

   134

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

   135

	 * @pre IsValidVehicle(vehicle_id).

   136

	 * @return The maximum age the vehicle has.

   137

	 * @note The age is in days.

   138

	 */

   139

	static int32 GetMaxAge(VehicleID vehicle_id);

   140

   141

	/**

   142

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

   143

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

   144

	 * @pre IsValidVehicle(vehicle_id).

   145

	 * @return The age the vehicle has left.

   146

	 * @note The age is in days.

   147

	 */

   148

	static int32 GetAgeLeft(VehicleID vehicle_id);

   149

   150

	/**

   151

	 * Get the running cost of this vehicle.

   152

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

   153

	 * @pre IsValidVehicle(vehicle_id).

   154

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

   155

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

   156

	 * @note This is not equal to AIEngine::GetRunningCost for Trains, because

   157

	 *   wagons and second engines can add up in the calculation too.

   158

	 */

   159

	static Money GetRunningCost(VehicleID vehicle_id);

   160

   161

	/**

   162

	 * Get the current profit of a vehicle.

   163

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

   164

	 * @pre IsValidVehicle(vehicle_id).

   165

	 * @return The current profit the vehicle has.

   166

	 */

   167

	static int32 GetProfitThisYear(VehicleID vehicle_id);

   168

   169

	/**

   170

	 * Get the profit of last year of a vehicle.

   171

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

   172

	 * @pre IsValidVehicle(vehicle_id).

   173

	 * @return The profit the vehicle had last year.

   174

	 */

   175

	static int32 GetProfitLastYear(VehicleID vehicle_id);

   176

   177

	/**

   178

	 * Get the type of vehicle.

   179

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

   180

	 * @pre IsValidVehicle(vehicle_id).

   181

	 * @return The vehicle type.

   182

	 */

   183

	static AIVehicle::VehicleType GetVehicleType(VehicleID vehicle_id);

   184

   185

	/**

   186

	 * Check if a vehicle is in a depot.

   187

	 * @param vehicle_id The vehicle to check.

   188

	 * @pre IsValidVehicle(vehicle_id).

   189

	 * @return True if and only if the vehicle is in a depot.

   190

	 */

   191

	static bool IsInDepot(VehicleID vehicle_id);

   192

   193

	/**

   194

	 * Check if a vehicle is in a depot and stopped.

   195

	 * @param vehicle_id The vehicle to check.

   196

	 * @pre IsValidVehicle(vehicle_id).

   197

	 * @return True if and only if the vehicle is in a depot and stopped.

   198

	 */

   199

	static bool IsStoppedInDepot(VehicleID vehicle_id);

   200

   201

	/**

   202

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

   203

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

   204

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

   205

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

   206

	 *   is owned by you.

   207

	 * @pre IsValidEngine(engine_id).

   208

	 * @exception AIVehicle::ERR_VEHICLE_TOO_MANY

   209

	 * @exception AIVehicle::ERR_VEHICLE_BUILD_DISABLED

   210

	 * @exception AIVehicle::ERR_VEHICLE_WRONG_DEPOT

   211

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

   212

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

   213

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

   214

	 * @note In Test Mode it means you can't assign orders yet to this vehicle,

   215

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

   216

	 *   assigning orders.

   217

	 */

   218

	static VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);

   219

   220

	/**

   221

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

   222

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

   223

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

   224

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

   225

	 * @pre The tile 'depot' has a depot on it, allowing 'vehicle_id'-type vehicles.

   226

	 * @pre IsValidVehicle(vehicle_id).

   227

	 * @exception AIVehicle::ERR_VEHICLE_TOO_MANY

   228

	 * @exception AIVehicle::ERR_VEHICLE_BUILD_DISABLED

   229

	 * @exception AIVehicle::ERR_VEHICLE_WRONG_DEPOT

   230

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

   231

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

   232

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

   233

	 */

   234

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

   235

   236

	/**

   237

	 * Refits a vehicle to the given cargo type

   238

	 * @param vehicle_id The vehicle to refit

   239

	 * @param cargo The cargo to refit to.

   240

	 * @pre IsValidVehicle(vehicle_id).

   241

	 * @pre AICargo::IsValidCargo(cargo).

   242

	 * @pre You must own the vehicle.

   243

	 * @pre The vehicle must be stopped in the depot.

   244

	 * @exception AIVehicle::ERR_VEHICLE_CANNOT_REFIT

   245

	 * @exception AIVehicle::ERR_VEHICLE_IS_DESTROYED

   246

	 * @exception AIVehicle::ERR_VEHICLE_NOT_IN_DEPOT

   247

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

   248

	 */

   249

	static bool RefitVehicle(VehicleID vehicle_id, CargoID cargo);

   250

   251

	/**

   252

	 * Sells the given vehicle.

   253

	 * @param vehicle_id The vehicle to sell.

   254

	 * @pre IsValidVehicle(vehicle_id).

   255

	 * @pre You must own the vehicle.

   256

	 * @pre The vehicle must be stopped in the depot.

   257

	 * @exception AIVehicle::ERR_VEHICLE_IS_DESTROYED

   258

	 * @exception AIVehicle::ERR_VEHICLE_NOT_IN_DEPOT

   259

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

   260

	 */

   261

	static bool SellVehicle(VehicleID vehicle_id);

   262

   263

	/**

   264

	 * Sends the given vehicle to a depot.

   265

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

   266

	 * @pre IsValidVehicle(vehicle_id).

   267

	 * @exception AIVehicle::ERR_VEHICLE_CANNOT_SEND_TO_DEPOT

   268

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

   269

	 */

   270

	static bool SendVehicleToDepot(VehicleID vehicle_id);

   271

   272

	/**

   273

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

   274

	 * @param vehicle_id The vehicle to start/stop.

   275

	 * @pre IsValidVehicle(vehicle_id).

   276

	 * @exception AIVehicle::ERR_VEHICLE_CANNOT_START_STOP

   277

	 * @exception (For aircraft only): AIVehicle::ERR_VEHICLE_IN_FLIGHT

   278

	 * @exception (For trains only): AIVehicle::ERR_VEHICLE_NO_POWER

   279

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

   280

	 */

   281

	static bool StartStopVehicle(VehicleID vehicle_id);

   282

   283

	/**

   284

	 * Skips the current order of the given vehicle.

   285

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

   286

	 * @param order_id The selected order to which we want to skip.

   287

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

   288

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

   289

	 */

   290

	static bool SkipToVehicleOrder(VehicleID vehicle_id, uint32 order_id);

   291

};

   292

   293

#endif /* AI_VEHICLE_HPP */