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

#include "ai_error.hpp"

    10

    11

/**

    12

 * Class that handles all marine related functions.

    13

 */

    14

class AIMarine : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * All marine related error messages.

    20

	 */

    21

	enum ErrorMessages {

    22

		/** Base for marine related errors */

    23

		ERR_MARINE_BASE = AIError::ERR_CAT_MARINE << AIError::ERR_CAT_BIT_SIZE,

    24

    25

		/** Infrastructure must be built on water */

    26

		ERR_MARINE_MUST_BE_BUILT_ON_WATER,                  // [STR_3801_MUST_BE_BUILT_ON_WATER]

    27

	};

    28

    29

	/**

    30

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

    31

	 * @param tile The tile to check.

    32

	 * @pre AIMap::IsValidTile(tile).

    33

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

    34

	 */

    35

	static bool IsWaterDepotTile(TileIndex tile);

    36

    37

	/**

    38

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

    39

	 * @param tile The tile to check.

    40

	 * @pre AIMap::IsValidTile(tile).

    41

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

    42

	 */

    43

	static bool IsDockTile(TileIndex tile);

    44

    45

	/**

    46

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

    47

	 * @param tile The tile to check.

    48

	 * @pre AIMap::IsValidTile(tile).

    49

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

    50

	 */

    51

	static bool IsBuoyTile(TileIndex tile);

    52

    53

	/**

    54

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

    55

	 * @param tile The tile to check.

    56

	 * @pre AIMap::IsValidTile(tile).

    57

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

    58

	 */

    59

	static bool IsLockTile(TileIndex tile);

    60

    61

	/**

    62

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

    63

	 * @param tile The tile to check.

    64

	 * @pre AIMap::IsValidTile(tile).

    65

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

    66

	 */

    67

	static bool IsCanalTile(TileIndex tile);

    68

    69

	/**

    70

	 * Builds a water depot on tile.

    71

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

    72

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

    73

	 * @pre AIMap::IsValidTile(tile).

    74

	 * @exception AIError::ERR_AREA_NOT_CLEAR

    75

	 * @exception AIError::ERR_SITE_UNSUITABLE

    76

	 * @exception AIMarine::ERR_MARINE_MUST_BE_BUILT_ON_WATER

    77

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

    78

	 */

    79

	static bool BuildWaterDepot(TileIndex tile, bool vertical);

    80

    81

	/**

    82

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

    83

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

    84

	 * @pre AIMap::IsValidTile(tile).

    85

	 * @exception AIError::ERR_AREA_NOT_CLEAR

    86

	 * @exception AIError::ERR_SITE_UNSUITABLE

    87

	 * @exception AIStation::ERR_STATION_TOO_CLOSE_TO_ANOTHER_STATION

    88

	 * @exception AIStation::ERR_STATION_TOO_MANY_STATIONS

    89

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

    90

	 */

    91

	static bool BuildDock(TileIndex tile);

    92

    93

	/**

    94

	 * Builds a buoy on tile.

    95

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

    96

	 * @pre AIMap::IsValidTile(tile).

    97

	 * @exception AIError::ERR_AREA_NOT_CLEAR

    98

	 * @exception AIError::ERR_SITE_UNSUITABLE

    99

	 * @exception AIStation::ERR_STATION_TOO_MANY_STATIONS

   100

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

   101

	 */

   102

	static bool BuildBuoy(TileIndex tile);

   103

   104

	/**

   105

	 * Builds a lock on tile.

   106

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

   107

	 * @pre AIMap::IsValidTile(tile).

   108

	 * @exception AIError::ERR_LAND_SLOPED_WRONG

   109

	 * @exception AIError::ERR_SITE_UNSUITABLE

   110

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

   111

	 */

   112

	static bool BuildLock(TileIndex tile);

   113

   114

	/**

   115

	 * Builds a canal on tile.

   116

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

   117

	 * @pre AIMap::IsValidTile(tile).

   118

	 * @exception AIError::ERR_AREA_NOT_CLEAR

   119

	 * @exception AIError::ERR_LAND_SLOPED_WRONG

   120

	 * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY

   121

	 * @exception AIError::ERR_ALREADY_BUILT

   122

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

   123

	 */

   124

	static bool BuildCanal(TileIndex tile);

   125

   126

	/**

   127

	 * Removes a water depot.

   128

	 * @param tile Any tile of the water depot.

   129

	 * @pre AIMap::IsValidTile(tile).

   130

	 * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY

   131

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

   132

	 */

   133

	static bool RemoveWaterDepot(TileIndex tile);

   134

   135

	/**

   136

	 * Removes a dock.

   137

	 * @param tile Any tile of the dock.

   138

	 * @pre AIMap::IsValidTile(tile).

   139

	 * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY

   140

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

   141

	 */

   142

	static bool RemoveDock(TileIndex tile);

   143

   144

	/**

   145

	 * Removes a buoy.

   146

	 * @param tile Any tile of the buoy.

   147

	 * @pre AIMap::IsValidTile(tile).

   148

	 * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY

   149

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

   150

	 */

   151

	static bool RemoveBuoy(TileIndex tile);

   152

   153

	/**

   154

	 * Removes a lock.

   155

	 * @param tile Any tile of the lock.

   156

	 * @pre AIMap::IsValidTile(tile).

   157

	 * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY

   158

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

   159

	 */

   160

	static bool RemoveLock(TileIndex tile);

   161

   162

	/**

   163

	 * Removes a canal.

   164

	 * @param tile Any tile of the canal.

   165

	 * @pre AIMap::IsValidTile(tile).

   166

	 * @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY

   167

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

   168

	 */

   169

	static bool RemoveCanal(TileIndex tile);

   170

};

   171

   172

#endif /* AI_MARINE_HPP */