1

/* $Id$ */

     2

     3

/** @file ai_marine.hpp Everything to query and build marine. */

     4

     5

#ifndef AI_MARINE_HPP

     6

#define AI_MARINE_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all marine related functions.

    12

 */

    13

class AIMarine : public AIObject {

    14

public:

    15

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

    16

    17

	/**

    18

	 * Checks whether the given tile is actually a tile with a water depot.

    19

	 * @param tile The tile to check.

    20

	 * @pre AIMap::IsValidTile(tile).

    21

	 * @return True if and only if the tile has a water depot.

    22

	 */

    23

	static bool IsWaterDepotTile(TileIndex tile);

    24

    25

	/**

    26

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

    27

	 * @param tile The tile to check.

    28

	 * @pre AIMap::IsValidTile(tile).

    29

	 * @return True if and only if the tile has a dock.

    30

	 */

    31

	static bool IsDockTile(TileIndex tile);

    32

    33

	/**

    34

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

    35

	 * @param tile The tile to check.

    36

	 * @pre AIMap::IsValidTile(tile).

    37

	 * @return True if and only if the tile has a buoy.

    38

	 */

    39

	static bool IsBuoyTile(TileIndex tile);

    40

    41

	/**

    42

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

    43

	 * @param tile The tile to check.

    44

	 * @pre AIMap::IsValidTile(tile).

    45

	 * @return True if and only if the tile has a lock.

    46

	 */

    47

	static bool IsLockTile(TileIndex tile);

    48

    49

	/**

    50

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

    51

	 * @param tile The tile to check.

    52

	 * @pre AIMap::IsValidTile(tile).

    53

	 * @return True if and only if the tile has a canal.

    54

	 */

    55

	static bool IsCanalTile(TileIndex tile);

    56

    57

	/**

    58

	 * Builds a water depot on tile.

    59

	 * @param tile The tile where the water depot will be build.

    60

	 * @param vertical If true, depot will be vertical, else horizontal.

    61

	 * @pre AIMap::IsValidTile(tile).

    62

	 * @return Whether the water depot has been/can be build or not.

    63

	 */

    64

	static bool BuildWaterDepot(TileIndex tile, bool vertical);

    65

    66

	/**

    67

	 * Builds a dock where tile is the tile still on land.

    68

	 * @param tile The tile still on land of the dock.

    69

	 * @pre AIMap::IsValidTile(tile).

    70

	 * @return Whether the dock has been/can be build or not.

    71

	 */

    72

	static bool BuildDock(TileIndex tile);

    73

    74

	/**

    75

	 * Builds a buoy on tile.

    76

	 * @param tile The tile where the buoy will be build.

    77

	 * @pre AIMap::IsValidTile(tile).

    78

	 * @return Whether the buoy has been/can be build or not.

    79

	 */

    80

	static bool BuildBuoy(TileIndex tile);

    81

    82

	/**

    83

	 * Builds a lock on tile.

    84

	 * @param tile The tile where the lock will be build.

    85

	 * @pre AIMap::IsValidTile(tile).

    86

	 * @return Whether the lock has been/can be build or not.

    87

	 */

    88

	static bool BuildLock(TileIndex tile);

    89

    90

	/**

    91

	 * Builds a canal on tile.

    92

	 * @param tile The tile where the canal will be build.

    93

	 * @pre AIMap::IsValidTile(tile).

    94

	 * @return Whether the canal has been/can be build or not.

    95

	 */

    96

	static bool BuildCanal(TileIndex tile);

    97

    98

	/**

    99

	 * Removes a water depot.

   100

	 * @param tile Any tile of the water depot.

   101

	 * @pre AIMap::IsValidTile(tile).

   102

	 * @return Whether the water depot has been/can be removed or not.

   103

	 */

   104

	static bool RemoveWaterDepot(TileIndex tile);

   105

   106

	/**

   107

	 * Removes a dock.

   108

	 * @param tile Any tile of the dock.

   109

	 * @pre AIMap::IsValidTile(tile).

   110

	 * @return Whether the dock has been/can be removed or not.

   111

	 */

   112

	static bool RemoveDock(TileIndex tile);

   113

   114

	/**

   115

	 * Removes a buoy.

   116

	 * @param tile Any tile of the buoy.

   117

	 * @pre AIMap::IsValidTile(tile).

   118

	 * @return Whether the buoy has been/can be removed or not.

   119

	 */

   120

	static bool RemoveBuoy(TileIndex tile);

   121

   122

	/**

   123

	 * Removes a lock.

   124

	 * @param tile Any tile of the lock.

   125

	 * @pre AIMap::IsValidTile(tile).

   126

	 * @return Whether the lock has been/can be removed or not.

   127

	 */

   128

	static bool RemoveLock(TileIndex tile);

   129

   130

	/**

   131

	 * Removes a canal.

   132

	 * @param tile Any tile of the canal.

   133

	 * @pre AIMap::IsValidTile(tile).

   134

	 * @return Whether the canal has been/can be removed or not.

   135

	 */

   136

	static bool RemoveCanal(TileIndex tile);

   137

};

   138

   139

#endif /* AI_MARINE_HPP */