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

#include "ai_error.hpp"

    10

#include "ai_company.hpp"

    11

    12

/**

    13

 * Class that handles all sign related functions.

    14

 */

    15

class AISign : public AIObject {

    16

public:

    17

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

    18

    19

	/**

    20

	 * All sign related error messages.

    21

	 */

    22

	enum ErrorMessages {

    23

    24

		/** Base for sign building related errors */

    25

		ERR_SIGN_BASE = AIError::ERR_CAT_SIGN << AIError::ERR_CAT_BIT_SIZE,

    26

    27

		/** Too many signs have been placed */

    28

		ERR_SIGN_TOO_MANY_SIGNS,             // [STR_2808_TOO_MANY_SIGNS]

    29

	};

    30

    31

	/**

    32

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

    33

	 * @return The maximum sign index.

    34

	 * @post Return value is always non-negative.

    35

	 */

    36

	static SignID GetMaxSignID();

    37

    38

	/**

    39

	 * Checks whether the given sign index is valid.

    40

	 * @param sign_id The index to check.

    41

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

    42

	 */

    43

	static bool IsValidSign(SignID sign_id);

    44

    45

	/**

    46

	 * Get the text on the sign.

    47

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

    48

	 * @pre IsValidSign(sign_id).

    49

	 * @return The text on the sign.

    50

	 */

    51

	static char *GetText(SignID sign_id);

    52

    53

	/**

    54

	 * Gets the location of the sign.

    55

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

    56

	 * @pre IsValidSign(sign_id).

    57

	 * @return The location of the sign.

    58

	 */

    59

	static TileIndex GetLocation(SignID sign_id);

    60

    61

	/**

    62

	 * Builds a sign on the map.

    63

	 * @param location The place to build the sign.

    64

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

    65

	 * @pre AIMap::IsValidTile(location).

    66

	 * @pre text is of non-zero length.

    67

	 * @exception ERR_SIGN_TOO_MANY_SIGNS

    68

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

    69

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

    70

	 *   failure.

    71

	 */

    72

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

    73

    74

	/**

    75

	 * Removes a sign from the map.

    76

	 * @param sign_id The sign to remove.

    77

	 * @pre IsValidSign(sign_id).

    78

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

    79

	 */

    80

	static bool RemoveSign(SignID sign_id);

    81

};

    82

    83

#endif /* AI_SIGN_HPP */