1

/* $Id$ */

     2

     3

/** @file tile_map.h Map writing/reading functions for tiles. */

     4

     5

#ifndef TILE_MAP_H

     6

#define TILE_MAP_H

     7

     8

#include "tile_type.h"

     9

#include "slope_type.h"

    10

#include "player_type.h"

    11

#include "map_func.h"

    12

#include "core/bitmath_func.hpp"

    13

    14

/**

    15

 * Returns the height of a tile

    16

 *

    17

 * This function returns the height of the northern corner of a tile.

    18

 * This is saved in the global map-array. It does not take affect by

    19

 * any slope-data of the tile.

    20

 *

    21

 * @param tile The tile to get the height from

    22

 * @return the height of the tile

    23

 * @pre tile < MapSize()

    24

 */

    25

static inline uint TileHeight(TileIndex tile)

    26

{

    27

	assert(tile < MapSize());

    28

	return GB(_m[tile].type_height, 0, 4);

    29

}

    30

    31

/**

    32

 * Sets the height of a tile.

    33

 *

    34

 * This function sets the height of the northern corner of a tile.

    35

 *

    36

 * @param tile The tile to change the height

    37

 * @param height The new height value of the tile

    38

 * @pre tile < MapSize()

    39

 * @pre heigth <= MAX_TILE_HEIGHT

    40

 */

    41

static inline void SetTileHeight(TileIndex tile, uint height)

    42

{

    43

	assert(tile < MapSize());

    44

	assert(height <= MAX_TILE_HEIGHT);

    45

	SB(_m[tile].type_height, 0, 4, height);

    46

}

    47

    48

/**

    49

 * Returns the height of a tile in pixels.

    50

 *

    51

 * This function returns the height of the northern corner of a tile in pixels.

    52

 *

    53

 * @param tile The tile to get the height

    54

 * @return The height of the tile in pixel

    55

 */

    56

static inline uint TilePixelHeight(TileIndex tile)

    57

{

    58

	return TileHeight(tile) * TILE_HEIGHT;

    59

}

    60

    61

/**

    62

 * Get the tiletype of a given tile.

    63

 *

    64

 * @param tile The tile to get the TileType

    65

 * @return The tiletype of the tile

    66

 * @pre tile < MapSize()

    67

 */

    68

static inline TileType GetTileType(TileIndex tile)

    69

{

    70

	assert(tile < MapSize());

    71

	return (TileType)GB(_m[tile].type_height, 4, 4);

    72

}

    73

    74

/**

    75

 * Set the type of a tile

    76

 *

    77

 * This functions sets the type of a tile. If the type

    78

 * MP_VOID is selected the tile must be at the south-west or

    79

 * south-east edges of the map and vice versa.

    80

 *

    81

 * @param tile The tile to save the new type

    82

 * @param type The type to save

    83

 * @pre tile < MapSize()

    84

 * @pre type MP_VOID <=> tile is on the south-east or south-west edge.

    85

 */

    86

static inline void SetTileType(TileIndex tile, TileType type)

    87

{

    88

	assert(tile < MapSize());

    89

	/* VOID tiles (and no others) are exactly allowed at the lower left and right

    90

	 * edges of the map */

    91

	assert((TileX(tile) == MapMaxX() || TileY(tile) == MapMaxY()) == (type == MP_VOID));

    92

	SB(_m[tile].type_height, 4, 4, type);

    93

}

    94

    95

/**

    96

 * Checks if a tile is a give tiletype.

    97

 *

    98

 * This function checks if a tile got the given tiletype.

    99

 *

   100

 * @param tile The tile to check

   101

 * @param type The type to check agains

   102

 * @return true If the type matches agains the type of the tile

   103

 */

   104

static inline bool IsTileType(TileIndex tile, TileType type)

   105

{

   106

	return GetTileType(tile) == type;

   107

}

   108

   109

/**

   110

 * Returns the owner of a tile

   111

 *

   112

 * This function returns the owner of a tile. This cannot used

   113

 * for tiles which type is one of MP_HOUSE, MP_VOID and MP_INDUSTRY

   114

 * as no player owned any of these buildings.

   115

 *

   116

 * @param tile The tile to check

   117

 * @return The owner of the tile

   118

 * @pre tile < MapSize()

   119

 * @pre The type of the tile must not be MP_HOUSE, MP_VOID and MP_INDUSTRY

   120

 */

   121

static inline Owner GetTileOwner(TileIndex tile)

   122

{

   123

	assert(tile < MapSize());

   124

	assert(!IsTileType(tile, MP_HOUSE));

   125

	assert(!IsTileType(tile, MP_VOID));

   126

	assert(!IsTileType(tile, MP_INDUSTRY));

   127

   128

	return (Owner)_m[tile].m1;

   129

}

   130

   131

/**

   132

 * Sets the owner of a tile

   133

 *

   134

 * This function sets the owner status of a tile. Note that you cannot

   135

 * set a owner for tiles of type MP_HOUSE, MP_VOID and MP_INDUSTRY.

   136

 *

   137

 * @param tile The tile to change the owner status.

   138

 * @param owner The new owner.

   139

 * @pre tile < MapSize()

   140

 * @pre The type of the tile must not be MP_HOUSE, MP_VOID and MP_INDUSTRY

   141

 */

   142

static inline void SetTileOwner(TileIndex tile, Owner owner)

   143

{

   144

	assert(tile < MapSize());

   145

	assert(!IsTileType(tile, MP_HOUSE));

   146

	assert(!IsTileType(tile, MP_VOID));

   147

	assert(!IsTileType(tile, MP_INDUSTRY));

   148

   149

	_m[tile].m1 = owner;

   150

}

   151

   152

/**

   153

 * Checks if a tile belongs to the given owner

   154

 *

   155

 * @param tile The tile to check

   156

 * @param owner The owner to check agains

   157

 * @return True if a tile belongs the the given owner

   158

 */

   159

static inline bool IsTileOwner(TileIndex tile, Owner owner)

   160

{

   161

	return GetTileOwner(tile) == owner;

   162

}

   163

   164

/**

   165

 * Set the tropic zone

   166

 * @param tile the tile to set the zone of

   167

 * @param type the new type

   168

 * @pre assert(tile < MapSize());

   169

 */

   170

static inline void SetTropicZone(TileIndex tile, TropicZone type)

   171

{

   172

	assert(tile < MapSize());

   173

	SB(_m[tile].m6, 0, 2, type);

   174

}

   175

   176

/**

   177

 * Get the tropic zone

   178

 * @param tile the tile to get the zone of

   179

 * @pre assert(tile < MapSize());

   180

 * @return the zone type

   181

 */

   182

static inline TropicZone GetTropicZone(TileIndex tile)

   183

{

   184

	assert(tile < MapSize());

   185

	return (TropicZone)GB(_m[tile].m6, 0, 2);

   186

}

   187

   188

Slope GetTileSlope(TileIndex tile, uint *h);

   189

uint GetTileZ(TileIndex tile);

   190

uint GetTileMaxZ(TileIndex tile);

   191

   192

#endif /* TILE_TYPE_H */