1

/* $Id$ */

     2

     3

/** @file ai_order.hpp Everything to query and build Orders */

     4

     5

#ifndef AI_ORDER_HPP

     6

#define AI_ORDER_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all order related functions.

    12

 */

    13

class AIOrder : public AIObject {

    14

public:

    15

	/**

    16

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

    17

	 */

    18

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

    19

    20

	/**

    21

	 * Flags that can be used to modify the behaviour of orders.

    22

	 */

    23

	enum AIOrderFlags {

    24

		/** Just go to the station/depot, stop unload if possible and load if needed. */

    25

		AIOF_NONE              = 0,

    26

    27

		/** Transfer instead of deliver the goods; only for stations. */

    28

		AIOF_TRANSFER          = 1 << 0,

    30

		AIOF_UNLOAD            = 1 << 1,

    32

		AIOF_FULL_LOAD         = 1 << 2,

    33

    34

		/** Service the vehicle when needed, otherwise skip this order; only for depots. */

    35

		AIOF_SERVICE_IF_NEEDED = 1 << 2,

    36

    37

		/** Do not stop at the stations that are passed when going to the destination. */

    38

		AIOF_NON_STOP          = 1 << 3,

    39

    40

		/** For marking invalid order flags */

    41

		AIOF_INVALID           = 0xFFFF,

    42

	};

    43

    44

	/**

    45

	 * Checks whether the given order id is valid for the given vehicle.

    46

	 * @param vehicle_id the vehicle to check the order index for.

    47

	 * @param order_id   the order index to check.

    48

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

    49

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

    50

	 */

    51

	static bool IsValidVehicleOrder(VehicleID vehicle_id, uint32 order_id);

    52

    53

	/**

    54

	 * Checks whether the given order flags are valid for the given destination.

    55

	 * @param destination the destination of the order.

    56

	 * @param order_flags the flags given to the order.

    57

	 * @return true if and only if the order_flags are valid for the given location.

    58

	 */

    59

	static bool AreOrderFlagsValid(TileIndex destination, AIOrderFlags order_flags);

    60

    61

	/**

    62

	 * Returns the number of orders for the given vehicle.

    63

	 * @param vehicle_id the vehicle to get the order count of.

    64

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

    65

	 * @return the number of orders for the given vehicle or a negative

    66

	 *   value when the vehicle does not exist.

    67

	 */

    68

	int32 GetNumberOfOrders(VehicleID vehicle_id);

    69

    70

	/**

    71

	 * Gets the destination of the given order for the given vehicle.

    72

	 * @param vehicle_id the vehicle to get the destination for.

    73

	 * @param order_id   the order to get the destination for.

    74

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

    75

	 * @return the destination tile of the order.

    76

	 */

    77

	TileIndex GetOrderDestination(VehicleID vehicle_id, uint32 order_id);

    78

    79

	/**

    80

	 * Gets the AIOrderFlags of the given order for the given vehicle.

    81

	 * @param vehicle_id the vehicle to get the destination for.

    82

	 * @param order_id   the order to get the destination for.

    83

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

    84

	 * @return the AIOrderFlags of the order.

    85

	 */

    86

	AIOrderFlags GetOrderFlags(VehicleID vehicle_id, uint32 order_id);

    87

    88

	/**

    89

	 * Appends an order to the end of the vehicle's order list.

    90

	 * @param vehicle_id  the vehicle to append the order to.

    91

	 * @param destination the destination of the order.

    92

	 * @param order_flags the flags given to the order.

    93

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

    94

	 * @pre AreOrderFlagsValid(destination, order_flags).

    95

	 * @return true if and only if the order was appended.

    96

	 */

    97

	bool AppendOrder(VehicleID vehicle_id, TileIndex destination, AIOrderFlags order_flags);

    98

    99

	/**

   100

	 * Inserts an order before the given order_id into the vehicle's order list.

   101

	 * @param vehicle_id  the vehicle to add the order to.

   102

	 * @param order_id    the order to place the new order before.

   103

	 * @param destination the destination of the order.

   104

	 * @param order_flags the flags given to the order.

   105

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

   106

	 * @pre AreOrderFlagsValid(destination, order_flags).

   107

	 * @return true if and only if the order was inserted.

   108

	 */

   109

	bool InsertOrder(VehicleID vehicle_id, uint32 order_id, TileIndex destination, AIOrderFlags order_flags);

   110

   111

	/**

   112

	 * Removes an order from the vehicle's order list.

   113

	 * @param vehicle_id  the vehicle to remove the order from.

   114

	 * @param order_id    the order to remove from the order list.

   115

	 * @pre AIVehicle::IsValidVehicleOrder(vehicle_id, order_id).

   116

	 * @return true if and only if the order was removed.

   117

	 */

   118

	bool RemoveOrder(VehicleID vehicle_id, uint32 order_id);

   119

   120

	/**

   121

	 * Changes the order flags of the given order.

   122

	 * @param vehicle_id  the vehicle to change the order of.

   123

	 * @param order_id    the order to change.

   124

	 * @param order_flags the new flags given to the order.

   125

	 * @pre IsValidVehicleOrder(vehicle_id, order_id).

   126

	 * @pre AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_id), order_flags).

   127

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

   128

	 */

   129

	bool ChangeOrder(VehicleID vehicle_id, uint32 order_id, AIOrderFlags order_flags);

   130

   131

	/**

   132

	 * Copies the orders from another vehicle. The orders of the main

   133

	 * vehicle are going to be the orders of the changed vehicle.

   134

	 * @param vehicle_id      the vehicle to copy the orders to.

   135

	 * @param main_vehicle_id the vehicle to copy the orders from.

   136

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

   137

	 * @pre AIVehicle::IsValidVehicle(main_vehicle_id).

   138

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

   139

	 */

   140

	bool CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id);

   141

   142

	/**

   143

	 * Shares the orders between two vehicles. The orders of the main

   144

	 * vehicle are going to be the orders of the changed vehicle.

   145

	 * @param vehicle_id      the vehicle to add to the shared order list.

   146

	 * @param main_vehicle_id the vehicle to share the orders with.

   147

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

   148

	 * @pre AIVehicle::IsValidVehicle(main_vehicle_id).

   149

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

   150

	 */

   151

	bool ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id);

   152

   153

	/**

   154

	 * Removes the given vehicle from a shared orders list.

   155

	 * @param vehicle_id the vehicle to remove from the shared order list.

   156

	 * @pre AIVehicle::IsValidVehicle(vehicle_id).

   157

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

   158

	 */

   159

	bool UnshareOrders(VehicleID vehicle_id);

   160

};

   161

DECLARE_ENUM_AS_BIT_SET(AIOrder::AIOrderFlags);

   162

   163

#ifdef DEFINE_SQUIRREL_CLASS

   164

namespace SQConvert {

   165

	/* Allow enums to be used as Squirrel parameters */

   166

	template <> AIOrder::AIOrderFlags GetParam(ForceType<AIOrder::AIOrderFlags>, HSQUIRRELVM vm, int index) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (AIOrder::AIOrderFlags)tmp; }

   167

	template <> int Return<AIOrder::AIOrderFlags>(HSQUIRRELVM vm, AIOrder::AIOrderFlags res) { sq_pushinteger(vm, (int32)res); return 1; }

   168

   169

	/* Allow AIOrder to be used as Squirrel parameter */

   170

	template <> AIOrder *GetParam(ForceType<AIOrder *>, HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIOrder *)instance; }

   171

}; // namespace SQConvert

   172

   173

void SQAIOrderRegister(Squirrel *engine) {

   174

	DefSQClass <AIOrder> SQAIOrder("AIOrder");

   175

	SQAIOrder.PreRegister(engine);

   176

	SQAIOrder.AddConstructor(engine);

   177

   178

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_NONE,              "AIOF_NONE");

   179

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_TRANSFER,          "AIOF_TRANSFER");

   180

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_UNLOAD,            "AIOF_UNLOAD");

   181

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_FULL_LOAD,         "AIOF_FULL_LOAD");

   182

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_SERVICE_IF_NEEDED, "AIOF_SERVICE_IF_NEEDED");

   183

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_NON_STOP,          "AIOF_NON_STOP");

   184

	SQAIOrder.DefSQConst(engine, AIOrder::AIOF_INVALID,           "AIOF_INVALID");

   185

   186

	SQAIOrder.DefSQStaticMethod(engine, &AIOrder::GetClassName,        "GetClassName",        1, "x");

   187

	SQAIOrder.DefSQStaticMethod(engine, &AIOrder::IsValidVehicleOrder, "IsValidVehicleOrder", 3, "xii");

   188

	SQAIOrder.DefSQStaticMethod(engine, &AIOrder::AreOrderFlagsValid,  "AreOrderFlagsValid",  3, "xii");

   189

   190

	SQAIOrder.DefSQMethod(engine, &AIOrder::GetNumberOfOrders,   "GetNumberOfOrders",   2, "xi");

   191

	SQAIOrder.DefSQMethod(engine, &AIOrder::GetOrderDestination, "GetOrderDestination", 3, "xii");

   192

	SQAIOrder.DefSQMethod(engine, &AIOrder::GetOrderFlags,       "GetOrderFlags",       3, "xii");

   193

	SQAIOrder.DefSQMethod(engine, &AIOrder::AppendOrder,         "AppendOrder",         4, "xiii");

   194

	SQAIOrder.DefSQMethod(engine, &AIOrder::InsertOrder,         "InsertOrder",         5, "xiiii");

   195

	SQAIOrder.DefSQMethod(engine, &AIOrder::RemoveOrder,         "RemoveOrder",         3, "xii");

   196

	SQAIOrder.DefSQMethod(engine, &AIOrder::ChangeOrder,         "ChangeOrder",         4, "xiii");

   197

	SQAIOrder.DefSQMethod(engine, &AIOrder::CopyOrders,          "CopyOrders",          3, "xii");

   198

	SQAIOrder.DefSQMethod(engine, &AIOrder::ShareOrders,         "ShareOrders",         3, "xii");

   199

	SQAIOrder.DefSQMethod(engine, &AIOrder::UnshareOrders,       "UnshareOrders",       2, "xi");

   200

   201

	SQAIOrder.PostRegister(engine);

   202

}

   203

#endif /* DEFINE_SQUIRREL_CLASS */

   204

   205

#endif /* AI_ORDER_HPP */