1

/* $Id$ */

     2

     3

/** @file ai_map.hpp Everything to query and build roads */

     4

     5

#ifndef AI_ROAD_HPP

     6

#define AI_ROAD_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all road related functions.

    12

 *

    13

 * Roads are always build from tile center to tile center.

    14

 * Furthermore stations and depots need to be build on tiles

    15

 * that already have road on them. For depots and non-drive

    16

 * through stations that means that only one roadbit may be

    17

 * built at the location. The advantage of this method is

    18

 * that the AI does not need to think about pointing the

    19

 * exit of the depots and roadstations towards the correct

    20

 * direction. For drive-through roadstops this works about

    21

 * the same, though they have to be built on straight roads.

    22

 */

    23

class AIRoad : public AIObject {

    24

public:

    25

	/**

    26

	 * Checks whether the given tile is actually a tile with road.

    27

	 * @param tile the tile to check.

    28

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    29

	 * @return true if and only if the tile has road.

    30

	 */

    31

	bool IsRoadTile(TileIndex tile);

    32

    33

	/**

    34

	 * Builds a road from the center of tile start to the

    35

	 * center of tile end.

    36

	 * @param start the start tile of the road.

    37

	 * @param end   the end tile of the road.

    38

	 * @pre start is not equal to end

    39

	 * @pre start is always positive and smaller than AIMap::GetMapSize().

    40

	 * @pre end is always positive and smaller than AIMap::GetMapSize().

    41

	 * @pre start and end are in a straight line, i.e.

    42

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

    43

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

    44

	 * @return whether the road has been/can be build or not.

    45

	 */

    46

	bool BuildRoad(TileIndex start, TileIndex end);

    47

    48

	/**

    49

	 * Builds a road depot.

    50

	 * @param tile  place to build the depot.

    51

	 * @param front the tile exactly in front of the depot

    52

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    53

	 * @pre front is always positive and smaller than AIMap::GetMapSize().

    54

	 * @pre tile is not equal to front

    55

	 * @return whether the road depot has been/can be build or not.

    56

	 */

    57

	bool BuildRoadDepot(TileIndex tile, TileIndex front);

    58

    59

	/**

    60

	 * Builds a road bus or truck station.

    61

	 * @param tile  place to build the depot.

    62

	 * @param front the tile exactly in front of the station.

    63

	 *   For drive-through stations either entrance side can be used.

    64

	 * @param bus   whether to build a bus or truck station.

    65

	 * @param drive_through whether to make the station drive through or not.

    66

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    67

	 * @pre front is always positive and smaller than AIMap::GetMapSize().

    68

	 * @pre tile is not equal to front

    69

	 * @return whether the station has been/can be build or not.

    70

	 */

    71

	bool BuildRoadStation(TileIndex tile, TileIndex front, bool bus, bool drive_through);

    72

    73

	/**

    74

	 * Removes a road from the center of tile start to the

    75

	 * center of tile end.

    76

	 * @param start the start tile of the road.

    77

	 * @param end   the end tile of the road.

    78

	 * @pre start is always positive and smaller than AIMap::GetMapSize().

    79

	 * @pre end is always positive and smaller than AIMap::GetMapSize().

    80

	 * @pre start and end are in a straight line, i.e.

    81

	 *  AIMap::GetTileX(start) == AIMap::GetTileX(end) or

    82

	 *  AIMap::GetTileY(start) == AIMap::GetTileY(end).

    83

	 * @return whether the road has been/can be removed or not.

    84

	 */

    85

	bool RemoveRoad(TileIndex start, TileIndex end);

    86

    87

	/**

    88

	 * Removes a road depot.

    89

	 * @param tile place to remove the depot from.

    90

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

    91

	 * @pre tile is a road depot.

    92

	 * @return whether the road depot has been/can be removed or not.

    93

	 */

    94

	bool RemoveRoadDepot(TileIndex tile);

    95

    96

	/**

    97

	 * Removes a road bus or truck station.

    98

	 * @param tile place to remove the station from.

    99

	 * @pre tile is always positive and smaller than AIMap::GetMapSize().

   100

	 * @pre tile is a road station.

   101

	 * @return whether the station has been/can be removed or not.

   102

	 */

   103

	bool RemoveRoadStation(TileIndex tile);

   104

};

   105

   106

#ifdef DEFINE_SQUIRREL_CLASS

   107

void SQAIRoadRegister(Squirrel *engine) {

   108

	DefSQClass <AIRoad> SQAIRoad("AIRoad");

   109

	SQAIRoad.PreRegister(engine);

   110

	SQAIRoad.AddConstructor(engine);

   111

	SQAIRoad.DefSQFunction(engine, &AIRoad::BuildRoad,         "BuildRoad");

   112

	SQAIRoad.DefSQFunction(engine, &AIRoad::BuildRoadDepot,    "BuildRoadDepot");

   113

	SQAIRoad.DefSQFunction(engine, &AIRoad::BuildRoadStation,  "BuildRoadStation");

   114

	SQAIRoad.DefSQFunction(engine, &AIRoad::RemoveRoad,        "RemoveRoad");

   115

	SQAIRoad.DefSQFunction(engine, &AIRoad::RemoveRoadDepot,   "RemoveRoadDepot");

   116

	SQAIRoad.DefSQFunction(engine, &AIRoad::RemoveRoadStation, "RemoveRoadStation");

   117

	SQAIRoad.PostRegister(engine);

   118

}

   119

#endif /* SQUIRREL_CLASS */

   120

   121

#endif /* AI_ROAD_HPP */