1

/* $Id$ */

     2

     3

/** @file ai_order.cpp handles the functions of the AIOrder class */

     4

     5

#include "ai_order.hpp"

     6

#include "ai_map.hpp"

     7

#include "ai_vehicle.hpp"

     8

#include "../../command.h"

     9

#include "../../order.h"

    10

#include "../../vehicle.h"

    11

#include "../../depot.h"

    12

#include "../../landscape.h"

    13

#include "../../rail_map.h"

    14

#include "../../road_map.h"

    15

#include "../../station_map.h"

    16

#include "../../water_map.h"

    17

#include "../../waypoint.h"

    18

    19

/**

    20

 * Gets the order type given a tile

    21

 * @param t the tile to get the order from

    22

 * @return the order type, or OT_END when there is no order

    23

 */

    24

static OrderType GetOrderTypeByTile(TileIndex t)

    25

{

    26

	if (!::IsValidTile(t)) return OT_END;

    27

    28

	switch (::GetTileType(t)) {

    29

		default: break;

    30

		case MP_STATION: return OT_GOTO_STATION; break;

    31

		case MP_WATER:   if (::IsShipDepot(t)) return OT_GOTO_DEPOT; break;

    32

		case MP_ROAD:    if (::GetRoadTileType(t) == ROAD_TILE_DEPOT) return OT_GOTO_DEPOT; break;

    33

		case MP_RAILWAY:

    34

			switch (::GetRailTileType(t)) {

    35

				case RAIL_TILE_DEPOT:    return OT_GOTO_DEPOT;

    36

				case RAIL_TILE_WAYPOINT: return OT_GOTO_WAYPOINT;

    37

				default: break;

    38

			}

    39

			break;

    40

	}

    41

    42

	return OT_END;

    43

}

    44

    45

/* static */ bool AIOrder::IsValidVehicleOrder(VehicleID vehicle_id, uint32 order_id)

    46

{

    47

	return AIVehicle::IsValidVehicle(vehicle_id) && order_id < ::GetVehicle(vehicle_id)->num_orders;

    48

}

    49

    50

/* static */ bool AIOrder::AreOrderFlagsValid(TileIndex destination, AIOrderFlags order_flags)

    51

{

    52

	switch (::GetOrderTypeByTile(destination)) {

    53

		case OT_GOTO_DEPOT:    return (order_flags & ~(AIOF_NON_STOP | AIOF_SERVICE_IF_NEEDED)) == 0;

    54

		case OT_GOTO_STATION:  return (order_flags & ~(AIOF_NON_STOP | AIOF_TRANSFER | AIOF_UNLOAD | AIOF_FULL_LOAD)) == 0 && ((order_flags & AIOF_UNLOAD) == 0 || (order_flags & AIOF_FULL_LOAD) == 0);

    55

		case OT_GOTO_WAYPOINT: return (order_flags & ~(AIOF_NON_STOP)) == 0;

    56

		default:               return false;

    57

	}

    58

}

    59

    60

int32 AIOrder::GetNumberOfOrders(VehicleID vehicle_id)

    61

{

    62

	return AIVehicle::IsValidVehicle(vehicle_id) ? ::GetVehicle(vehicle_id)->num_orders : -1;

    63

}

    64

    65

TileIndex AIOrder::GetOrderDestination(VehicleID vehicle_id, uint32 order_id)

    66

{

    67

	if (!AIOrder::IsValidVehicleOrder(vehicle_id, order_id)) return INVALID_TILE;

    68

    69

	Order *order = ::GetVehicle(vehicle_id)->orders;

    70

	for (uint i = 0; i < order_id; i++) order = order->next;

    71

    72

	switch (order->type) {

    73

		case OT_GOTO_DEPOT:    return ::GetDepot(order->dest)->xy;

    74

		case OT_GOTO_STATION:  return ::GetStation(order->dest)->xy;

    75

		case OT_GOTO_WAYPOINT: return ::GetWaypoint(order->dest)->xy;

    76

		default:               return INVALID_TILE;

    77

	}

    78

}

    79

    80

AIOrder::AIOrderFlags AIOrder::GetOrderFlags(VehicleID vehicle_id, uint32 order_id)

    81

{

    82

	if (!AIOrder::IsValidVehicleOrder(vehicle_id, order_id)) return AIOF_INVALID;

    83

    84

	Order *order = ::GetVehicle(vehicle_id)->orders;

    85

	for (uint i = 0; i < order_id; i++) order = order->next;

    86

    87

	return (AIOrder::AIOrderFlags)order->flags;

    88

}

    89

    90

bool AIOrder::AppendOrder(VehicleID vehicle_id, TileIndex destination, AIOrderFlags order_flags)

    91

{

    92

	if (!AIVehicle::IsValidVehicle(vehicle_id)) return false;

    93

	return this->InsertOrder(vehicle_id, GetVehicle(vehicle_id)->num_orders, destination, order_flags);

    94

}

    95

    96

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

    97

{

    98

	/* IsValidVehicleOrder is not good enough because it does not allow appending. */

    99

	if (!AIVehicle::IsValidVehicle(vehicle_id) || order_id > ::GetVehicle(vehicle_id)->num_orders ||

   100

		!this->AreOrderFlagsValid(destination, order_flags)) return false;

   101

   102

	Order order;

   103

	order.type  = ::GetOrderTypeByTile(destination);

   104

	order.flags = order_flags;

   105

	switch (order.type) {

   106

		case OT_GOTO_DEPOT:    order.dest = ::GetDepotByTile(destination)->index; break;

   107

		case OT_GOTO_STATION:  order.dest = ::GetStationIndex(destination);       break;

   108

		case OT_GOTO_WAYPOINT: order.dest = ::GetWaypointIndex(destination);      break;

   109

		default: NOT_REACHED(); return false;

   110

	}

   111

   112

	return this->DoCommand(0, vehicle_id | (order_id << 16), PackOrder(&order), CMD_INSERT_ORDER);

   113

}

   114

   115

bool AIOrder::RemoveOrder(VehicleID vehicle_id, uint32 order_id)

   116

{

   117

	if (!IsValidVehicleOrder(vehicle_id, order_id)) return false;

   118

   119

	return this->DoCommand(0, vehicle_id, order_id, CMD_DELETE_ORDER);

   120

}

   121

   122

bool AIOrder::ChangeOrder(VehicleID vehicle_id, uint32 order_id, AIOrder::AIOrderFlags order_flags)

   123

{

   124

	if (!IsValidVehicleOrder(vehicle_id, order_id) ||

   125

		!this->AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_id), order_flags)) return false;

   126

   127

	for (;;) {

   128

		/* Loop as long as there is a difference between the requested and

   129

		 * the current orders of the vehicle. */

   130

		AIOrderFlags current = this->GetOrderFlags(vehicle_id, order_id);

   131

		AIOrderFlags diff = current ^ order_flags;

   132

		if (diff == 0) return true;

   133

   134

		bool res = this->DoCommand(0, vehicle_id | (order_id << 16), FIND_FIRST_BIT(diff), CMD_MODIFY_ORDER);

   135

		if (!res) return false;

   136

	}

   137

}

   138

   139

bool AIOrder::CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)

   140

{

   141

	if (!AIVehicle::IsValidVehicle(vehicle_id) || !AIVehicle::IsValidVehicle(main_vehicle_id)) return false;

   142

   143

	return this->DoCommand(0, vehicle_id | (main_vehicle_id << 16), CO_COPY, CMD_CLONE_ORDER);

   144

}

   145

   146

bool AIOrder::ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)

   147

{

   148

	if (!AIVehicle::IsValidVehicle(vehicle_id) || !AIVehicle::IsValidVehicle(main_vehicle_id)) return false;

   149

   150

	return this->DoCommand(0, vehicle_id | (main_vehicle_id << 16), CO_SHARE, CMD_CLONE_ORDER);

   151

}

   152

   153

bool AIOrder::UnshareOrders(VehicleID vehicle_id)

   154

{

   155

	if (!AIVehicle::IsValidVehicle(vehicle_id)) return false;

   156

   157

	return this->DoCommand(0, vehicle_id, CO_UNSHARE, CMD_CLONE_ORDER);

   158

}