tile.h
author celestar
Wed, 13 Jul 2005 09:51:01 +0000
changeset 2048 54fd558314dc
parent 1967 a01f4d5dd957
child 2049 538e73c53f54
permissions -rw-r--r--
(svn r2557) -Add: Added the AUTOBRIEF option to the Doxyfile
1209
2e00193652b2 (svn r1713) Split off several functions which query/set information about a single tile from map.h and put them into a seperate file tile.h
tron
parents: 1202
diff changeset
     1
#ifndef TILE_H
2e00193652b2 (svn r1713) Split off several functions which query/set information about a single tile from map.h and put them into a seperate file tile.h
tron
parents: 1202
diff changeset
     2
#define TILE_H
926
a6d140a6a4de (svn r1414) Move TileIndex, TILE_MASK and GET_TILE_[XY] to map.h and turn the latter into inline functions names Tile[XY]
tron
parents: 909
diff changeset
     3
1394
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
     4
#include "macros.h"
1209
2e00193652b2 (svn r1713) Split off several functions which query/set information about a single tile from map.h and put them into a seperate file tile.h
tron
parents: 1202
diff changeset
     5
#include "map.h"
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
     6
1944
dd9cba5fab2a (svn r2450) * Codechange: Replaced all uses of the arrays in tile.h with calls to the associated wrapper functions.
matthijs
parents: 1942
diff changeset
     7
typedef enum TileTypes {
1214
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
     8
	MP_CLEAR,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
     9
	MP_RAILWAY,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    10
	MP_STREET,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    11
	MP_HOUSE,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    12
	MP_TREES,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    13
	MP_STATION,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    14
	MP_WATER,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    15
	MP_VOID, // invisible tiles at the SW and SE border
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    16
	MP_INDUSTRY,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    17
	MP_TUNNELBRIDGE,
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    18
	MP_UNMOVABLE
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    19
} TileType;
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    20
1942
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    21
/* Direction as commonly used in v->direction, 8 way. */
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    22
typedef enum Directions {
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    23
	DIR_N   = 0,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    24
	DIR_NE  = 1,      /* Northeast, upper right on your monitor */
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    25
	DIR_E   = 2,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    26
	DIR_SE  = 3,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    27
	DIR_S   = 4,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    28
	DIR_SW  = 5,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    29
	DIR_W   = 6,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    30
	DIR_NW  = 7,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    31
	DIR_END,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    32
	INVALID_DIR = 0xFF,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    33
} Direction;
1749
711c154a1fb7 (svn r2253) - Fix: [ 1190896 1184378 ] [NPF] Trains ignoring their railtype (mono, maglev) (glx)
matthijs
parents: 1394
diff changeset
    34
1942
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    35
/* Direction commonly used as the direction of entering and leaving tiles, 4-way */
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    36
typedef enum DiagonalDirections {
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    37
	DIAGDIR_NE  = 0,      /* Northeast, upper right on your monitor */
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    38
	DIAGDIR_SE  = 1,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    39
	DIAGDIR_SW  = 2,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    40
	DIAGDIR_NW  = 3,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    41
	DIAGDIR_END,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    42
	INVALID_DIAGDIR = 0xFF,
c5d5cf5b0263 (svn r2448) General cleanup of rail related code, more to follow.
matthijs
parents: 1927
diff changeset
    43
} DiagDirection;
1749
711c154a1fb7 (svn r2253) - Fix: [ 1190896 1184378 ] [NPF] Trains ignoring their railtype (mono, maglev) (glx)
matthijs
parents: 1394
diff changeset
    44
1211
43ae74415fdd (svn r1715) Move [GS]etMapExtraBits to tile.[ch]
tron
parents: 1209
diff changeset
    45
void SetMapExtraBits(TileIndex tile, byte flags);
43ae74415fdd (svn r1715) Move [GS]etMapExtraBits to tile.[ch]
tron
parents: 1209
diff changeset
    46
uint GetMapExtraBits(TileIndex tile);
43ae74415fdd (svn r1715) Move [GS]etMapExtraBits to tile.[ch]
tron
parents: 1209
diff changeset
    47
1335
a5f223b9f549 (svn r1839) Move GetTileSlope() and GetTileZ() into tile.[ch] and use more explicit types as parameters
tron
parents: 1333
diff changeset
    48
uint GetTileSlope(TileIndex tile, uint *h);
a5f223b9f549 (svn r1839) Move GetTileSlope() and GetTileZ() into tile.[ch] and use more explicit types as parameters
tron
parents: 1333
diff changeset
    49
uint GetTileZ(TileIndex tile);
a5f223b9f549 (svn r1839) Move GetTileSlope() and GetTileZ() into tile.[ch] and use more explicit types as parameters
tron
parents: 1333
diff changeset
    50
1394
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    51
static inline bool CorrectZ(uint tileh)
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    52
{
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    53
	/* tile height must be corrected if the north corner is not raised, but
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    54
	 * any other corner is. These are the cases 1 till 7 */
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    55
	return IS_INT_INSIDE(tileh, 1, 8);
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    56
}
79cb56d80a3a (svn r1898) Remove some unused macros from macros.h and move some others to more appropriate headers
tron
parents: 1335
diff changeset
    57
1044
63e0601a43cc (svn r1545) Add TileHeight() which returns the height (not multiplied by 8)
tron
parents: 1041
diff changeset
    58
static inline uint TileHeight(TileIndex tile)
63e0601a43cc (svn r1545) Add TileHeight() which returns the height (not multiplied by 8)
tron
parents: 1041
diff changeset
    59
{
63e0601a43cc (svn r1545) Add TileHeight() which returns the height (not multiplied by 8)
tron
parents: 1041
diff changeset
    60
	assert(tile < MapSize());
1852
a7f9f961c5e1 (svn r2358) Add macros for getting (GB) and setting (SB) a range of bits
tron
parents: 1749
diff changeset
    61
	return GB(_map_type_and_height[tile], 0, 4);
1044
63e0601a43cc (svn r1545) Add TileHeight() which returns the height (not multiplied by 8)
tron
parents: 1041
diff changeset
    62
}
63e0601a43cc (svn r1545) Add TileHeight() which returns the height (not multiplied by 8)
tron
parents: 1041
diff changeset
    63
1059
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    64
static inline void SetTileHeight(TileIndex tile, uint height)
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    65
{
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    66
	assert(tile < MapSize());
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    67
	assert(height < 16);
1852
a7f9f961c5e1 (svn r2358) Add macros for getting (GB) and setting (SB) a range of bits
tron
parents: 1749
diff changeset
    68
	SB(_map_type_and_height[tile], 0, 4, height);
1059
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    69
}
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    70
1041
94db182c3614 (svn r1542) Rename TileHeight to TilePixelHeight, because this is what it actually returns
tron
parents: 1035
diff changeset
    71
static inline uint TilePixelHeight(TileIndex tile)
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    72
{
1044
63e0601a43cc (svn r1545) Add TileHeight() which returns the height (not multiplied by 8)
tron
parents: 1041
diff changeset
    73
	return TileHeight(tile) * 8;
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    74
}
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    75
1214
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    76
static inline TileType GetTileType(TileIndex tile)
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    77
{
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    78
	assert(tile < MapSize());
1852
a7f9f961c5e1 (svn r2358) Add macros for getting (GB) and setting (SB) a range of bits
tron
parents: 1749
diff changeset
    79
	return GB(_map_type_and_height[tile], 4, 4);
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    80
}
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    81
1214
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    82
static inline void SetTileType(TileIndex tile, TileType type)
1059
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    83
{
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    84
	assert(tile < MapSize());
1852
a7f9f961c5e1 (svn r2358) Add macros for getting (GB) and setting (SB) a range of bits
tron
parents: 1749
diff changeset
    85
	SB(_map_type_and_height[tile], 4, 4, type);
1059
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    86
}
fe97d81a1b4f (svn r1560) Introduce SetTileType() and SetTileHeight()
tron
parents: 1044
diff changeset
    87
1214
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    88
static inline bool IsTileType(TileIndex tile, TileType type)
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    89
{
1214
8262981ac274 (svn r1718) Use the enum TileType as parameter/return type for [GS]etTileType() instead of plain int.
tron
parents: 1211
diff changeset
    90
	return GetTileType(tile) == type;
1035
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    91
}
812f837ee03f (svn r1536) Move GET_TILEHEIGHT, GET_TILETYPE and IS_TILETYPE to map.h, turn them into inline functions and add some asserts
tron
parents: 979
diff changeset
    92
1333
2ca5d5b4b37b (svn r1837) GetTileOwner returns Owner, not bool
tron
parents: 1330
diff changeset
    93
static inline Owner GetTileOwner(TileIndex tile)
1330
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
    94
{
1333
2ca5d5b4b37b (svn r1837) GetTileOwner returns Owner, not bool
tron
parents: 1330
diff changeset
    95
	assert(tile < MapSize());
1898
0b84ad3a8c92 (svn r2404) assert that GetTileOwner() isn't called for tiles, which don't store owner information
tron
parents: 1852
diff changeset
    96
	assert(!IsTileType(tile, MP_HOUSE));
0b84ad3a8c92 (svn r2404) assert that GetTileOwner() isn't called for tiles, which don't store owner information
tron
parents: 1852
diff changeset
    97
	assert(!IsTileType(tile, MP_VOID));
0b84ad3a8c92 (svn r2404) assert that GetTileOwner() isn't called for tiles, which don't store owner information
tron
parents: 1852
diff changeset
    98
	assert(!IsTileType(tile, MP_INDUSTRY));
0b84ad3a8c92 (svn r2404) assert that GetTileOwner() isn't called for tiles, which don't store owner information
tron
parents: 1852
diff changeset
    99
1330
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   100
	return _map_owner[tile];
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   101
}
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   102
1902
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   103
static inline void SetTileOwner(TileIndex tile, Owner owner)
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   104
{
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   105
	assert(tile < MapSize());
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   106
	assert(!IsTileType(tile, MP_HOUSE));
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   107
	assert(!IsTileType(tile, MP_VOID));
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   108
	assert(!IsTileType(tile, MP_INDUSTRY));
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   109
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   110
	_map_owner[tile] = owner;
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   111
}
86b7fb11f938 (svn r2408) Introduce SetTileOwner() and use it
tron
parents: 1898
diff changeset
   112
1330
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   113
static inline bool IsTileOwner(TileIndex tile, Owner owner)
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   114
{
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   115
	return GetTileOwner(tile) == owner;
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   116
}
5d76a0522a11 (svn r1834) - Fix: NPF does not check the owner of its target, busses try to enter other players' depots. TODO
matthijs
parents: 1214
diff changeset
   117
679
04ca2cd69420 (svn r1117) Move map arrays and some related macros into their own files map.c and map.h
tron
parents:
diff changeset
   118
#endif