1

/* $Id$ */

     2

     3

/** @file ai_map.hpp Everything to query map metadata */

     4

     5

#ifndef AI_MAP_HPP

     6

#define AI_MAP_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

class AIMap : public AIObject {

    11

public:

    12

	/**

    13

	 * Checks whether the given tile is valid

    14

	 * @param t the tile to check

    15

	 * @return true is the tile it within the boundaries of the map

    16

	 */

    17

	bool IsValidTile(TileIndex t);

    18

    19

	/**

    20

	 * Gets the number of tiles in the map

    21

	 * @return the size of the map in tiles

    22

	 * @post return > 0

    23

	 */

    24

	TileIndex GetMapSize();

    25

    26

	/**

    27

	 * Gets the amount of tiles along the SW and NE border

    28

	 * @return the length along the SW and NE borders

    29

	 * @post return > 0

    30

	 */

    31

	uint32 GetMapSizeX();

    32

    33

	/**

    34

	 * Gets the amount of tiles along the SE and NW border

    35

	 * @return the length along the SE and NW borders

    36

	 * @post return > 0

    37

	 */

    38

	uint32 GetMapSizeY();

    39

    40

	/**

    41

	 * Gets the X (place along the SW/NE border)

    42

	 * @param t the tile to get the X of

    43

	 * @pre this->IsValidTile(t)

    44

	 * @return the x-position

    45

	 * @post return <= this->GetMapSizeX()

    46

	 */

    47

	uint32 GetTileX(TileIndex t);

    48

    49

	/**

    50

	 * Gets the Y (place along the SE/NW border)

    51

	 * @param t the tile to get the Y of

    52

	 * @pre this->IsValidTile(t)

    53

	 * @return the y-position

    54

	 * @post return <= this->GetMapSizeY()

    55

	 */

    56

	uint32 GetTileY(TileIndex t);

    57

};

    58

    59

#ifdef SQUIRREL_CLASS

    61

	DefSQClass <AIMap> SQAIMap("AIMap");

    70

}

    71

#endif /* SQUIRREL_CLASS */

    72

    73

#endif /* AI_MAP_HPP */