(svn r15027) -Merge: tomatos and bananas left to be, here is NoAI for all to see.
NoAI is an API (a framework) to build your own AIs in. See: http://wiki.openttd.org/wiki/index.php/AI:Main_Page With many thanks to: - glx and Rubidium for their syncing, feedback and hard work - Yexo for his feedback, patches, and AIs which tested the system very deep - Morloth for his feedback and patches - TJIP for hosting a challenge which kept NoAI on track - All AI authors for testing our AI API, and all other people who helped in one way or another -Remove: all old AIs and their cheats/hacks
This commit is contained in:
truebrain
187
src/ai/api/ai_marine.hpp
Normal file
187
src/ai/api/ai_marine.hpp
Normal file
@@ -0,0 +1,187 @@
|
||||
/* $Id$ */
|
||||
|
||||
/** @file ai_marine.hpp Everything to query and build marine. */
|
||||
|
||||
#ifndef AI_MARINE_HPP
|
||||
#define AI_MARINE_HPP
|
||||
|
||||
#include "ai_object.hpp"
|
||||
#include "ai_error.hpp"
|
||||
|
||||
/**
|
||||
* Class that handles all marine related functions.
|
||||
*/
|
||||
class AIMarine : public AIObject {
|
||||
public:
|
||||
static const char *GetClassName() { return "AIMarine"; }
|
||||
|
||||
/**
|
||||
* All marine related error messages.
|
||||
*/
|
||||
enum ErrorMessages {
|
||||
/** Base for marine related errors */
|
||||
ERR_MARINE_BASE = AIError::ERR_CAT_MARINE << AIError::ERR_CAT_BIT_SIZE,
|
||||
|
||||
/** Infrastructure must be built on water */
|
||||
ERR_MARINE_MUST_BE_BUILT_ON_WATER, // [STR_3801_MUST_BE_BUILT_ON_WATER]
|
||||
};
|
||||
|
||||
/**
|
||||
* Checks whether the given tile is actually a tile with a water depot.
|
||||
* @param tile The tile to check.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @return True if and only if the tile has a water depot.
|
||||
*/
|
||||
static bool IsWaterDepotTile(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Checks whether the given tile is actually a tile with a dock.
|
||||
* @param tile The tile to check.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @return True if and only if the tile has a dock.
|
||||
*/
|
||||
static bool IsDockTile(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Checks whether the given tile is actually a tile with a buoy.
|
||||
* @param tile The tile to check.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @return True if and only if the tile has a buoy.
|
||||
*/
|
||||
static bool IsBuoyTile(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Checks whether the given tile is actually a tile with a lock.
|
||||
* @param tile The tile to check.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @return True if and only if the tile has a lock.
|
||||
*/
|
||||
static bool IsLockTile(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Checks whether the given tile is actually a tile with a canal.
|
||||
* @param tile The tile to check.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @return True if and only if the tile has a canal.
|
||||
*/
|
||||
static bool IsCanalTile(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Checks whether the given tiles are directly connected, i.e. whether
|
||||
* a ship vehicle can travel from the center of the first tile to the
|
||||
* center of the second tile.
|
||||
* @param tile_from The source tile.
|
||||
* @param tile_to The destination tile.
|
||||
* @pre AIMap::IsValidTile(tile_from).
|
||||
* @pre AIMap::IsValidTile(tile_to).
|
||||
* @pre 'tile_from' and 'tile_to' are directly neighbouring tiles.
|
||||
* @return True if and only if a ship can go from tile_from to tile_to.
|
||||
*/
|
||||
static bool AreWaterTilesConnected(TileIndex tile_from, TileIndex tile_to);
|
||||
|
||||
/**
|
||||
* Builds a water depot on tile.
|
||||
* @param tile The tile where the water depot will be build.
|
||||
* @param vertical If true, depot will be vertical, else horizontal.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_AREA_NOT_CLEAR
|
||||
* @exception AIError::ERR_SITE_UNSUITABLE
|
||||
* @exception AIMarine::ERR_MARINE_MUST_BE_BUILT_ON_WATER
|
||||
* @return Whether the water depot has been/can be build or not.
|
||||
* @note A WaterDepot is 1 tile in width, and 2 tiles in length.
|
||||
*/
|
||||
static bool BuildWaterDepot(TileIndex tile, bool vertical);
|
||||
|
||||
/**
|
||||
* Builds a dock where tile is the tile still on land.
|
||||
* @param tile The tile still on land of the dock.
|
||||
* @param join_adjacent When building next to an other station, don't create a new station when this flag is true.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_AREA_NOT_CLEAR
|
||||
* @exception AIError::ERR_SITE_UNSUITABLE
|
||||
* @exception AIStation::ERR_STATION_TOO_CLOSE_TO_ANOTHER_STATION
|
||||
* @exception AIStation::ERR_STATION_TOO_MANY_STATIONS
|
||||
* @return Whether the dock has been/can be build or not.
|
||||
*/
|
||||
static bool BuildDock(TileIndex tile, bool join_adjacent);
|
||||
|
||||
/**
|
||||
* Builds a buoy on tile.
|
||||
* @param tile The tile where the buoy will be build.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_AREA_NOT_CLEAR
|
||||
* @exception AIError::ERR_SITE_UNSUITABLE
|
||||
* @exception AIStation::ERR_STATION_TOO_MANY_STATIONS
|
||||
* @return Whether the buoy has been/can be build or not.
|
||||
*/
|
||||
static bool BuildBuoy(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Builds a lock on tile.
|
||||
* @param tile The tile where the lock will be build.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_LAND_SLOPED_WRONG
|
||||
* @exception AIError::ERR_SITE_UNSUITABLE
|
||||
* @return Whether the lock has been/can be build or not.
|
||||
*/
|
||||
static bool BuildLock(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Builds a canal on tile.
|
||||
* @param tile The tile where the canal will be build.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_AREA_NOT_CLEAR
|
||||
* @exception AIError::ERR_LAND_SLOPED_WRONG
|
||||
* @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY
|
||||
* @exception AIError::ERR_ALREADY_BUILT
|
||||
* @return Whether the canal has been/can be build or not.
|
||||
*/
|
||||
static bool BuildCanal(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Removes a water depot.
|
||||
* @param tile Any tile of the water depot.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY
|
||||
* @return Whether the water depot has been/can be removed or not.
|
||||
*/
|
||||
static bool RemoveWaterDepot(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Removes a dock.
|
||||
* @param tile Any tile of the dock.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY
|
||||
* @return Whether the dock has been/can be removed or not.
|
||||
*/
|
||||
static bool RemoveDock(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Removes a buoy.
|
||||
* @param tile Any tile of the buoy.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY
|
||||
* @return Whether the buoy has been/can be removed or not.
|
||||
*/
|
||||
static bool RemoveBuoy(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Removes a lock.
|
||||
* @param tile Any tile of the lock.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY
|
||||
* @return Whether the lock has been/can be removed or not.
|
||||
*/
|
||||
static bool RemoveLock(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Removes a canal.
|
||||
* @param tile Any tile of the canal.
|
||||
* @pre AIMap::IsValidTile(tile).
|
||||
* @exception AIError::ERR_OWNED_BY_ANOTHER_COMPANY
|
||||
* @return Whether the canal has been/can be removed or not.
|
||||
*/
|
||||
static bool RemoveCanal(TileIndex tile);
|
||||
};
|
||||
|
||||
#endif /* AI_MARINE_HPP */
|
||||
Reference in New Issue
Block a user