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

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

    16

    17

	/**

    18

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

    19

	 * @return The maximum sign index.

    20

	 * @post Return value is always non-negative.

    21

	 */

    22

	static SignID GetMaxSignID();

    23

    24

	/**

    25

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

    26

	 *   because of the way OpenTTD works internally.

    27

	 * @return The number of signs.

    28

	 * @post Return value is always non-negative.

    29

	 */

    30

	static int32 GetSignCount();

    31

    32

	/**

    33

	 * Checks whether the given sign index is valid.

    34

	 * @param sign_id The index to check.

    35

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

    36

	 */

    37

	static bool IsValidSign(SignID sign_id);

    38

    39

	/**

    40

	 * Get the text on the sign.

    41

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

    42

	 * @pre IsValidSign(sign_id).

    43

	 * @return The text on the sign.

    44

	 */

    45

	static char *GetText(SignID sign_id);

    46

    47

	/**

    48

	 * Gets the location of the sign.

    49

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

    50

	 * @pre IsValidSign(sign_id).

    51

	 * @return The location of the sign.

    52

	 */

    53

	static TileIndex GetLocation(SignID sign_id);

    54

    55

	/**

    56

	 * Builds a sign on the map.

    57

	 * @param location The place to build the sign.

    58

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

    59

	 * @pre AIMap::IsValidTile(location).

    60

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

    61

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

    62

	 *   failure.

    63

	 */

    64

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

    65

    66

	/**

    67

	 * Removes a sign from the map.

    68

	 * @param sign_id The sign to remove.

    69

	 * @pre IsValidSign(sign_id).

    70

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

    71

	 */

    72

	static bool RemoveSign(SignID sign_id);

    73

};

    74

    75

#endif /* AI_SIGN_HPP */