src/ai/api/ai_tile.hpp
branchnoai
changeset 9829 80fbe02a4184
parent 9814 be51ea0adc29
child 9834 9abe20fc83e5
equal deleted inserted replaced
9828:38be66875b45 9829:80fbe02a4184
     1 /* $Id$ */
     1 /* $Id$ */
     2 
     2 
     3 /** @file ai_tile.hpp tile related functions */
     3 /** @file ai_tile.hpp Everything to query and manipulate tiles. */
     4 
     4 
     5 #ifndef AI_TILE_HPP
     5 #ifndef AI_TILE_HPP
     6 #define AI_TILE_HPP
     6 #define AI_TILE_HPP
     7 
     7 
     8 #include "ai_abstractlist.hpp"
     8 #include "ai_abstractlist.hpp"
    10 /**
    10 /**
    11  * Class that handles all tile related functions.
    11  * Class that handles all tile related functions.
    12  */
    12  */
    13 class AITile : public AIObject {
    13 class AITile : public AIObject {
    14 public:
    14 public:
       
    15 	static const char *GetClassName() { return "AITile"; }
       
    16 
    15 	/**
    17 	/**
    16 	 * Enumeration for the slope-type (from slopes.h).
    18 	 * Enumeration for the slope-type (from slopes.h).
    17 	 *
    19 	 *
    18 	 * This enumeration use the chars N,E,S,W corresponding the
    20 	 * This enumeration use the chars N,E,S,W corresponding the
    19 	 * direction north, east, south and west. The top corner of a tile
    21 	 * direction north, east, south and west. The top corner of a tile
    41 		SLOPE_STEEP_W  = SLOPE_STEEP | SLOPE_NWS,               ///< a steep slope falling to east (from west)
    43 		SLOPE_STEEP_W  = SLOPE_STEEP | SLOPE_NWS,               ///< a steep slope falling to east (from west)
    42 		SLOPE_STEEP_S  = SLOPE_STEEP | SLOPE_WSE,               ///< a steep slope falling to north (from south)
    44 		SLOPE_STEEP_S  = SLOPE_STEEP | SLOPE_WSE,               ///< a steep slope falling to north (from south)
    43 		SLOPE_STEEP_E  = SLOPE_STEEP | SLOPE_SEN,               ///< a steep slope falling to west (from east)
    45 		SLOPE_STEEP_E  = SLOPE_STEEP | SLOPE_SEN,               ///< a steep slope falling to west (from east)
    44 		SLOPE_STEEP_N  = SLOPE_STEEP | SLOPE_ENW                ///< a steep slope falling to south (from north)
    46 		SLOPE_STEEP_N  = SLOPE_STEEP | SLOPE_ENW                ///< a steep slope falling to south (from north)
    45 	};
    47 	};
    46 
       
    47 	/**
       
    48 	 * The name of the class, needed by several sub-processes.
       
    49 	 */
       
    50 	static const char *GetClassName() { return "AITile"; }
       
    51 
    48 
    52 	/**
    49 	/**
    53 	 * Check if this tile is buildable (e.g.: no things on it that needs removing).
    50 	 * Check if this tile is buildable (e.g.: no things on it that needs removing).
    54 	 * @note Road and rail are considered buildable.
    51 	 * @note Road and rail are considered buildable.
    55 	 * @param tile the tile to check on.
    52 	 * @param tile the tile to check on.