src/ai/api/ai_townlist.hpp
branchnoai
changeset 9778 38560cd27070
parent 9772 c1035f0ac732
child 9816 35e866676c00
equal deleted inserted replaced
9777:053e53a1650e 9778:38560cd27070
     1 /* $Id$ */
     1 /* $Id$ */
     2 
     2 
     3 /** @file ai_townlist.hpp list all the towns */
     3 /** @file ai_townlist.hpp list all the towns */
       
     4 /** @defgroup AITownList AITownList - Valuators and lists working on/with AITownList */
     4 
     5 
     5 #ifndef AI_TOWNLIST_HPP
     6 #ifndef AI_TOWNLIST_HPP
     6 #define AI_TOWNLIST_HPP
     7 #define AI_TOWNLIST_HPP
     7 
     8 
     8 #include "ai_abstractlist.hpp"
     9 #include "ai_abstractlist.hpp"
     9 
    10 
    10 /**
    11 /**
    11  * Class that creates a list of current towns.
    12  * Creates a list of towns that are currently on the map.
       
    13  * @ingroup AITownList
    12  */
    14  */
    13 class AITownList : public AIAbstractList {
    15 class AITownList : public AIAbstractList {
    14 public:
    16 public:
    15 	/**
       
    16 	 * The name of the class, needed by several sub-processes.
       
    17 	 */
       
    18 	static const char *GetClassName() { return "AITownList"; }
    17 	static const char *GetClassName() { return "AITownList"; }
    19 
       
    20 	/**
       
    21 	 * The constructor to make a list of towns.
       
    22 	 */
       
    23 	AITownList();
    18 	AITownList();
    24 
    19 
    25 private:
    20 private:
    26 	/**
       
    27 	 * The name of this list, to check if a Valuator can be used on this list.
       
    28 	 */
       
    29 	const char *GetListName() const { return "AITownList"; }
    21 	const char *GetListName() const { return "AITownList"; }
    30 };
    22 };
    31 
    23 
    32 #endif /* AI_TOWNLIST_HPP */
    24 #endif /* AI_TOWNLIST_HPP */