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 vehicle is valid and owned by you.

    36

	 * @param vehicle_id the vehicle to check.

    37

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

    38

	 */

    39

	static bool IsValidVehicle(VehicleID vehicle_id);

    40

    41

	/**

    42

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

    43

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

    44

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

    45

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

    46

	 *   is owned by you.

    47

	 * @pre IsValidEngine(engine_id).

    48

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

    49

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

    50

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

    51

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

    52

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

    53

	 *   assigning orders.

    54

	 */

    55

	VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);

    56

    57

	/**

    58

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

    59

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

    60

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

    61

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

    62

	 * @pre the tile at depot has a depot.

    63

	 * @pre IsValidVehicle(vehicle_id).

    64

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

    65

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

    66

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

    67

	 */

    68

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

    69

    70

	/**

    71

	 * Refits a vehicle to the given cargo type

    72

	 * @param vehicle_id the vehicle to refit

    73

	 * @param cargo      the cargo to refit to

    74

	 * @pre IsValidVehicle(vehicle_id).

    75

	 * @pre AICargo::IsValidCargo(cargo)

    76

	 * @pre you must own the vehicle

    77

	 * @pre the vehicle must be stopped in the depot

    78

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

    79

	 */

    80

	bool RefitVehicle(VehicleID vehicle_id, CargoID cargo);

    81

    82

	/**

    83

	 * Sells the given vehicle.

    84

	 * @param vehicle_id the vehicle to sell.

    85

	 * @pre IsValidVehicle(vehicle_id).

    86

	 * @pre you must own the vehicle

    87

	 * @pre the vehicle must be stopped in the depot

    88

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

    89

	 */

    90

	bool SellVehicle(VehicleID vehicle_id);

    91

    92

	/**

    93

	 * Sends the given vehicle to a depot.

    94

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

    95

	 * @pre IsValidVehicle(vehicle_id).

    96

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

    97

	 */

    98

	bool SendVehicleToDepot(VehicleID vehicle_id);

    99

   100

	/**

   101

	 * Check if a vehicle is in a depot.

   102

	 * @param vehicle_id the vehicle to check.

   103

	 * @pre isValidVehicle(vehicle_id).

   104

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

   105

	 */

   106

	bool IsInDepot(VehicleID vehicle_id);

   107

   108

	/**

   109

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

   110

	 * @param vehicle_id the vehicle to check.

   111

	 * @pre isValidVehicle(vehicle_id).

   112

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

   113

	 */

   114

	bool IsStoppedInDepot(VehicleID vehicle_id);

   115

   116

	/**

   117

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

   118

	 * @param vehicle_id the vehicle to start/stop.

   119

	 * @pre IsValidVehicle(vehicle_id).

   120

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

   121

	 */

   122

	bool StartStopVehicle(VehicleID vehicle_id);

   123

   124

	/**

   125

	 * Skips the current order of the given vehicle.

   126

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

   127

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

   128

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

   129

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

   130

	 */

   131

	bool SkipToVehicleOrder(VehicleID vehicle_id, uint32 order_id);

   132

   133

	/**

   134

	 * Set the name of a vehicle.

   135

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

   136

	 * @param name the name for the vehicle.

   137

	 * @pre IsValidVehicle(vehicle_id).

   138

	 * @pre Name has to be unique.

   139

	 * @pre You have to own the vehicle.

   140

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

   141

	 */

   142

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

   143

   144

	/**

   145

	 * Get the current location of a vehicle.

   146

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

   147

	 * @pre IsValidVehicle(vehicle_id).

   148

	 * @return the tile the vehicle is currently on.

   149

	 */

   150

	static TileIndex GetLocation(VehicleID vehicle_id);

   151

   152

	/**

   153

	 * Get the engine-type of a vehicle.

   154

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

   155

	 * @pre IsValidVehicle(vehicle_id).

   156

	 * @return the engine type the vehicle has.

   157

	 */

   158

	static EngineID GetEngineType(VehicleID vehicle_id);

   159

   160

	/**

   161

	 * Get the unitnumber of a vehicle.

   162

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

   163

	 * @pre IsValidVehicle(vehicle_id).

   164

	 * @return the unitnumber the vehicle has.

   165

	 */

   166

	static int32 GetUnitNumber(VehicleID vehicle_id);

   167

   168

	/**

   169

	 * Get the name of a vehicle.

   170

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

   171

	 * @pre IsValidVehicle(vehicle_id).

   172

	 * @return the name the vehicle has.

   173

	 */

   174

	static char *GetName(VehicleID vehicle_id);

   175

   176

	/**

   177

	 * Get the current age of a vehicle.

   178

	 * @note age is in days.

   179

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

   180

	 * @pre IsValidVehicle(vehicle_id).

   181

	 * @return the current age the vehicle has.

   182

	 */

   183

	static int32 GetAge(VehicleID vehicle_id);

   184

   185

	/**

   186

	 * Get the max age of a vehicle.

   187

	 * @note age is in days.

   188

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

   189

	 * @pre IsValidVehicle(vehicle_id).

   190

	 * @return the max age the vehicle has.

   191

	 */

   192

	static int32 GetMaxAge(VehicleID vehicle_id);

   193

   194

	/**

   195

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

   196

	 * @note age is in days.

   197

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

   198

	 * @pre IsValidVehicle(vehicle_id).

   199

	 * @return the age the vehicle has left.

   200

	 */

   201

	static int32 GetAgeLeft(VehicleID vehicle_id);

   202

   203

	/**

   204

	 * Get the current profit of a vehicle.

   205

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

   206

	 * @pre IsValidVehicle(vehicle_id).

   207

	 * @return the current profit the vehicle has.

   208

	 */

   209

	static int32 GetProfitThisYear(VehicleID vehicle_id);

   210

   211

	/**

   212

	 * Get the profit of last year of a vehicle.

   213

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

   214

	 * @pre IsValidVehicle(vehicle_id).

   215

	 * @return the profit the vehicle had last year.

   216

	 */

   217

	static int32 GetProfitLastYear(VehicleID vehicle_id);

   218

   219

	/**

   220

	 * Get the type of vehicle.

   221

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

   222

	 * @pre IsValidVehicle(vehicle_id).

   223

	 * @return the vehicle type.

   224

	 */

   225

	static AIVehicle::VehicleType GetVehicleType(VehicleID vehicle_id);

   226

};

   227

   228

#endif /* AI_VEHICLE_HPP */