Files
@ r7423:ba5e87b6ea9b
Branch filter:
Location: cpp/openttd-patchpack/source/src/tile.h - annotation
r7423:ba5e87b6ea9b
6.0 KiB
text/x-c
(svn r10821) -Cleanup: remove the strings that are not needed anymore since r10820.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6422:5983361e241a r6422:5983361e241a r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5587:034e5e185dc2 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7313:4260ca461c14 r7313:4260ca461c14 r7313:4260ca461c14 r7313:4260ca461c14 r7313:4260ca461c14 r7313:4260ca461c14 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r6248:b940b09d7ab8 r7365:42ddcb060daf r7365:42ddcb060daf r7370:ef5901b27aca r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r6248:b940b09d7ab8 r7365:42ddcb060daf r7365:42ddcb060daf r7370:ef5901b27aca r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r7365:42ddcb060daf r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5596:84985796bbd9 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5596:84985796bbd9 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 | /* $Id$ */
/** @file tile.h */
#ifndef TILE_H
#define TILE_H
#include "macros.h"
#include "openttd.h"
#include "map.h"
#include "slope.h"
/** Maximum allowed tile height */
#define MAX_TILE_HEIGHT 15
/** Maximum allowed snowline height */
#define MAX_SNOWLINE_HEIGHT (MAX_TILE_HEIGHT - 2)
/**
* The different type of a tile.
*
* Each tile belongs to one type, according whatever is build on it.
*
* @note A railway with a crossing street is marked as MP_ROAD.
*/
enum TileType {
MP_CLEAR, ///< A tile without any structures, i.e. grass, rocks, farm fields etc.
MP_RAILWAY, ///< A railway
MP_ROAD, ///< A tile with road (or tram tracks)
MP_HOUSE, ///< A house by a town
MP_TREES, ///< Tile got trees
MP_STATION, ///< A tile of a station
MP_WATER, ///< Water tile
MP_VOID, ///< Invisible tiles at the SW and SE border
MP_INDUSTRY, ///< Part of an industry
MP_TUNNELBRIDGE, ///< Tunnel entry/exit and bridge heads
MP_UNMOVABLE, ///< Contains an object with cannot be removed like transmitters
};
/**
* Additional infos of a tile on a tropic game.
*
* Each non-water tile in a tropic game is either a rainforest tile or a
* desert one.
*/
enum TropicZone {
TROPICZONE_INVALID = 0, ///< Invalid tropiczone-type
TROPICZONE_DESERT = 1, ///< Tile is desert
TROPICZONE_RAINFOREST = 2, ///< Rainforest tile
};
Slope GetTileSlope(TileIndex tile, uint *h);
uint GetTileZ(TileIndex tile);
uint GetTileMaxZ(TileIndex tile);
/**
* Returns the height of a tile
*
* This function returns the height of the northern corner of a tile.
* This is saved in the global map-array. It does not take affect by
* any slope-data of the tile.
*
* @param tile The tile to get the height from
* @return the height of the tile
* @pre tile < MapSize()
*/
static inline uint TileHeight(TileIndex tile)
{
assert(tile < MapSize());
return GB(_m[tile].type_height, 0, 4);
}
/**
* Sets the height of a tile.
*
* This function sets the height of the northern corner of a tile.
*
* @param tile The tile to change the height
* @param height The new height value of the tile
* @pre tile < MapSize()
* @pre heigth <= MAX_TILE_HEIGHT
*/
static inline void SetTileHeight(TileIndex tile, uint height)
{
assert(tile < MapSize());
assert(height <= MAX_TILE_HEIGHT);
SB(_m[tile].type_height, 0, 4, height);
}
/**
* Returns the height of a tile in pixels.
*
* This function returns the height of the northern corner of a tile in pixels.
*
* @param tile The tile to get the height
* @return The height of the tile in pixel
*/
static inline uint TilePixelHeight(TileIndex tile)
{
return TileHeight(tile) * TILE_HEIGHT;
}
/**
* Get the tiletype of a given tile.
*
* @param tile The tile to get the TileType
* @return The tiletype of the tile
* @pre tile < MapSize()
*/
static inline TileType GetTileType(TileIndex tile)
{
assert(tile < MapSize());
return (TileType)GB(_m[tile].type_height, 4, 4);
}
/**
* Set the type of a tile
*
* This functions sets the type of a tile. If the type
* MP_VOID is selected the tile must be at the south-west or
* south-east edges of the map and vice versa.
*
* @param tile The tile to save the new type
* @param type The type to save
* @pre tile < MapSize()
* @pre type MP_VOID <=> tile is on the south-east or south-west edge.
*/
static inline void SetTileType(TileIndex tile, TileType type)
{
assert(tile < MapSize());
/* VOID tiles (and no others) are exactly allowed at the lower left and right
* edges of the map */
assert((TileX(tile) == MapMaxX() || TileY(tile) == MapMaxY()) == (type == MP_VOID));
SB(_m[tile].type_height, 4, 4, type);
}
/**
* Checks if a tile is a give tiletype.
*
* This function checks if a tile got the given tiletype.
*
* @param tile The tile to check
* @param type The type to check agains
* @return true If the type matches agains the type of the tile
*/
static inline bool IsTileType(TileIndex tile, TileType type)
{
return GetTileType(tile) == type;
}
/**
* Returns the owner of a tile
*
* This function returns the owner of a tile. This cannot used
* for tiles which type is one of MP_HOUSE, MP_VOID and MP_INDUSTRY
* as no player owned any of these buildings.
*
* @param tile The tile to check
* @return The owner of the tile
* @pre tile < MapSize()
* @pre The type of the tile must not be MP_HOUSE, MP_VOID and MP_INDUSTRY
*/
static inline Owner GetTileOwner(TileIndex tile)
{
assert(tile < MapSize());
assert(!IsTileType(tile, MP_HOUSE));
assert(!IsTileType(tile, MP_VOID));
assert(!IsTileType(tile, MP_INDUSTRY));
return (Owner)_m[tile].m1;
}
/**
* Sets the owner of a tile
*
* This function sets the owner status of a tile. Note that you cannot
* set a owner for tiles of type MP_HOUSE, MP_VOID and MP_INDUSTRY.
*
* @param tile The tile to change the owner status.
* @param owner The new owner.
* @pre tile < MapSize()
* @pre The type of the tile must not be MP_HOUSE, MP_VOID and MP_INDUSTRY
*/
static inline void SetTileOwner(TileIndex tile, Owner owner)
{
assert(tile < MapSize());
assert(!IsTileType(tile, MP_HOUSE));
assert(!IsTileType(tile, MP_VOID));
assert(!IsTileType(tile, MP_INDUSTRY));
_m[tile].m1 = owner;
}
/**
* Checks if a tile belongs to the given owner
*
* @param tile The tile to check
* @param owner The owner to check agains
* @return True if a tile belongs the the given owner
*/
static inline bool IsTileOwner(TileIndex tile, Owner owner)
{
return GetTileOwner(tile) == owner;
}
/**
* Set the tropic zone
* @param tile the tile to set the zone of
* @param type the new type
* @pre assert(tile < MapSize());
*/
static inline void SetTropicZone(TileIndex tile, TropicZone type)
{
assert(tile < MapSize());
SB(_m[tile].m6, 0, 2, type);
}
/**
* Get the tropic zone
* @param tile the tile to get the zone of
* @pre assert(tile < MapSize());
* @return the zone type
*/
static inline TropicZone GetTropicZone(TileIndex tile)
{
assert(tile < MapSize());
return (TropicZone)GB(_m[tile].m6, 0, 2);
}
#endif /* TILE_H */
|