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"

    10

    11

/**

    12

 * Class that handles all sign related functions.

    13

 */

    14

class AISign : public AIObject {

    15

public:

    16

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

    17

    27

	/**

    28

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

    29

	 * @return The maximum sign index.

    30

	 * @post Return value is always non-negative.

    31

	 */

    32

	static SignID GetMaxSignID();

    33

    34

	/**

    35

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

    36

	 *   because of the way OpenTTD works internally.

    37

	 * @return The number of signs.

    38

	 * @post Return value is always non-negative.

    39

	 */

    40

	static int32 GetSignCount();

    41

    42

	/**

    43

	 * Checks whether the given sign index is valid.

    44

	 * @param sign_id The index to check.

    45

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

    46

	 */

    47

	static bool IsValidSign(SignID sign_id);

    48

    49

	/**

    50

	 * Get the text on the sign.

    51

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

    52

	 * @pre IsValidSign(sign_id).

    53

	 * @return The text on the sign.

    54

	 */

    55

	static char *GetText(SignID sign_id);

    56

    57

	/**

    58

	 * Gets the location of the sign.

    59

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

    60

	 * @pre IsValidSign(sign_id).

    61

	 * @return The location of the sign.

    62

	 */

    63

	static TileIndex GetLocation(SignID sign_id);

    64

    65

	/**

    66

	 * Builds a sign on the map.

    67

	 * @param location The place to build the sign.

    68

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

    69

	 * @pre AIMap::IsValidTile(location).

    72

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

    73

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

    74

	 *   failure.

    75

	 */

    76

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

    77

    78

	/**

    79

	 * Removes a sign from the map.

    80

	 * @param sign_id The sign to remove.

    81

	 * @pre IsValidSign(sign_id).

    82

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

    83

	 */

    84

	static bool RemoveSign(SignID sign_id);

    85

};

    86

    87

#endif /* AI_SIGN_HPP */