src/ai/api/ai_sign.hpp
branchnoai
changeset 9513 258f78c74b0c
parent 9511 f767ad06e86b
child 9520 f7cf8bea10db
equal deleted inserted replaced
9512:36a53e169661 9513:258f78c74b0c
     6 #define AI_SIGN_HPP
     6 #define AI_SIGN_HPP
     7 
     7 
     8 #include "ai_object.hpp"
     8 #include "ai_object.hpp"
     9 
     9 
    10 /**
    10 /**
    11  * Class that handles all town related functions.
    11  * Class that handles all sign related functions.
    12  */
    12  */
    13 class AISign : public AIObject {
    13 class AISign : public AIObject {
    14 public:
    14 public:
    15 	/**
    15 	/**
    16 	 * Gets the maximum sign index; there are no valid signs with a higher index.
    16 	 * Gets the maximum sign index; there are no valid signs with a higher index.
    17 	 * @return the maximum town index.
    17 	 * @return the maximum sign index.
    18 	 * @post return value is always non-negative.
    18 	 * @post return value is always non-negative.
    19 	 */
    19 	 */
    20 	SignID GetMaxSignID();
    20 	SignID GetMaxSignID();
    21 
    21 
    22 	/**
    22 	/**
    23 	 * Gets the number of signs. This is different than GetSignTownID()
    23 	 * Gets the number of signs. This is different than GetMaxSignID()
    24 	 *   because of the way OpenTTD works internally.
    24 	 *   because of the way OpenTTD works internally.
    25 	 * @return the number of signs.
    25 	 * @return the number of signs.
    26 	 * @post return value is always non-negative.
    26 	 * @post return value is always non-negative.
    27 	 */
    27 	 */
    28 	int32 GetSignCount();
    28 	int32 GetSignCount();