1

/* $Id$ */

     2

     3

/** @file ai_sign.hpp Everything to query and build signs */

     4

     5

#ifndef AI_SIGN_HPP

     6

#define AI_SIGN_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all sign related functions.

    12

 */

    13

class AISign : public AIObject {

    14

public:

    15

	/**

    16

	 * The name of the class, needed by several sub-processes.

    17

	 */

    18

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

    19

    20

	/**

    21

	 * Gets the maximum sign index; there are no valid signs with a higher index.

    22

	 * @return the maximum sign index.

    23

	 * @post return value is always non-negative.

    24

	 */

    25

	static SignID GetMaxSignID();

    26

    27

	/**

    28

	 * Gets the number of signs. This is different than GetMaxSignID()

    29

	 *   because of the way OpenTTD works internally.

    30

	 * @return the number of signs.

    31

	 * @post return value is always non-negative.

    32

	 */

    33

	static int32 GetSignCount();

    34

    35

	/**

    36

	 * Checks whether the given sign index is valid.

    37

	 * @param sign_id the index to check.

    38

	 * @return true if and only if the sign is valid.

    39

	 */

    40

	static bool IsValidSign(SignID sign_id);

    41

    42

	/**

    43

	 * Get the text on the sign.

    44

	 * @param sign_id the sign to get the text of.

    45

	 * @pre sign_id has to be valid (use IsValidSign()).

    46

	 * @return the text on the sign.

    47

	 * @note the returned name must be free'd (C++ only).

    48

	 */

    49

	static char *GetText(SignID sign_id);

    50

    51

	/**

    52

	 * Gets the location of the sign.

    53

	 * @param sign_id the sign to get the location of.

    54

	 * @pre sign_id has to be valid (use IsValidSign()).

    55

	 * @return the location of the sign.

    56

	 * @post return value is always valid with AIMap::IsValidTile().

    57

	 */

    58

	static TileIndex GetLocation(SignID sign_id);

    59

    60

	/**

    61

	 * Removes a sign from the map.

    62

	 * @param sign_id the sign to remove.

    63

	 * @pre sign_id has to be valid (use IsValidSign()).

    64

	 * @return true if and only if the sign has been removed.

    65

	 */

    66

	static bool RemoveSign(SignID sign_id);

    67

    68

	/**

    69

	 * Builds a sign on the map.

    70

	 * @param location the place to build the sign.

    71

	 * @param text     the text to place on the sign.

    72

	 * @pre AIMap::IsValidTile(location).

    73

	 * @pre text is not NULL and non-empty, i.e. length is positive.

    74

	 * @return the SignID of the build sign (use IsValidSign() to check for validity).

    75

	 *   In test-mode it returns 0 if successful, or any other value to indicate

    76

	 *   failure.

    77

	 */

    78

	static SignID BuildSign(TileIndex location, const char *text);

    79

};

    80

    81

#endif /* AI_SIGN_HPP */