src/bridge_map.h
author celestar
Tue, 12 Jun 2007 11:56:35 +0000
branchgamebalance
changeset 9908 0fa543611bbe
parent 6486 4f8af35b11eb
child 9624 b71483f2330f
permissions -rw-r--r--
(svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
     1
/* $Id$ */
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
     2
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
     3
/** @file bridge_map.h Map accessor functions for bridges. */
6449
e520244dc71e (svn r8859) -Cleanup: doxygen changes. Mostly @files missing tags and a few comments style.
belugas
parents: 5847
diff changeset
     4
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
     5
#ifndef BRIDGE_MAP_H
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
     6
#define BRIDGE_MAP_H
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
     7
3196
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
     8
#include "direction.h"
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
     9
#include "macros.h"
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
    10
#include "map.h"
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
    11
#include "rail.h"
3234
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    12
#include "road_map.h"
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
    13
#include "tile.h"
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
    14
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
    15
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    16
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    17
 * Checks if this is a bridge, instead of a tunnel
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    18
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    19
 * @pre IsTileType(t, MP_TUNNELBRIDGE)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    20
 * @return true if the structure is a bridge one
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    21
 */
3234
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    22
static inline bool IsBridge(TileIndex t)
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    23
{
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3355
diff changeset
    24
	assert(IsTileType(t, MP_TUNNELBRIDGE));
3234
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    25
	return HASBIT(_m[t].m5, 7);
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    26
}
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    27
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    28
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    29
 * checks if there is a bridge on this tile
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    30
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    31
 * @return true if a bridge is present
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    32
 */
3234
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    33
static inline bool IsBridgeTile(TileIndex t)
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    34
{
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    35
	return IsTileType(t, MP_TUNNELBRIDGE) && IsBridge(t);
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    36
}
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
    37
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    38
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    39
 * checks for the possibility that a bridge may be on this tile
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    40
 * These are in fact all the tile types on which a bridge can be found
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    41
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    42
 * @return true if a bridge migh be present
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    43
 */
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    44
static inline bool MayHaveBridgeAbove(TileIndex t)
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
    45
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    46
	return
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    47
		IsTileType(t, MP_CLEAR) ||
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    48
		IsTileType(t, MP_RAILWAY) ||
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    49
		IsTileType(t, MP_STREET) ||
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    50
		IsTileType(t, MP_WATER) ||
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    51
		IsTileType(t, MP_TUNNELBRIDGE) ||
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    52
		IsTileType(t, MP_UNMOVABLE);
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
    53
}
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
    54
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    55
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    56
 * checks if a bridge is set above the ground of this tile
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    57
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    58
 * @pre MayHaveBridgeAbove(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    59
 * @return true if a bridge is detected above
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    60
 */
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    61
static inline bool IsBridgeAbove(TileIndex t)
3933
a5f08e17f4a0 (svn r5070) Merged the bridge branch
celestar
parents: 3466
diff changeset
    62
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    63
	assert(MayHaveBridgeAbove(t));
5847
9ce114e1d90d (svn r8050) -Codechange: Rename map member extra to m6, since its usage has been widden.
belugas
parents: 5726
diff changeset
    64
	return GB(_m[t].m6, 6, 2) != 0;
3231
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    65
}
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    66
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    67
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    68
/**
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    69
 * Determines the type of bridge on a tile
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    70
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    71
 * @pre IsBridgeTile(t)
3231
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    72
 * @return The bridge type
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    73
 */
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3355
diff changeset
    74
static inline uint GetBridgeType(TileIndex t)
3231
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    75
{
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3355
diff changeset
    76
	assert(IsBridgeTile(t));
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3355
diff changeset
    77
	return GB(_m[t].m2, 4, 4);
3231
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    78
}
eb74c2e361f9 (svn r3904) Move GetBridgePiece() and GetBridgeType() to bridge_map.h and make the only place which still extracted that info diretly use the wrapper
tron
parents: 3226
diff changeset
    79
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
    80
3196
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    81
/**
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    82
 * Get the direction pointing onto the bridge
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    83
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    84
 * @pre IsBridgeTile(t)
6449
e520244dc71e (svn r8859) -Cleanup: doxygen changes. Mostly @files missing tags and a few comments style.
belugas
parents: 5847
diff changeset
    85
 * @return the above mentionned direction
3196
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    86
 */
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    87
static inline DiagDirection GetBridgeRampDirection(TileIndex t)
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    88
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    89
	assert(IsBridgeTile(t));
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
    90
	return (DiagDirection)GB(_m[t].m5, 0, 2);
3196
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    91
}
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    92
29717e930f9a (svn r3857) Add and use GetBridgeRampDirection()
tron
parents: 3189
diff changeset
    93
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    94
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    95
 * Get the axis of the bridge that goes over the tile. Not the axis or the ramp.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    96
 * @param t The tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    97
 * @pre IsBridgeAbove(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    98
 * @return the above mentioned axis
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
    99
 */
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   100
static inline Axis GetBridgeAxis(TileIndex t)
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   101
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   102
	assert(IsBridgeAbove(t));
5847
9ce114e1d90d (svn r8050) -Codechange: Rename map member extra to m6, since its usage has been widden.
belugas
parents: 5726
diff changeset
   103
	return (Axis)(GB(_m[t].m6, 6, 2) - 1);
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   104
}
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   105
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   106
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   107
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   108
 * Get the transport type of the bridge's ramp.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   109
 * @param t The ramp tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   110
 * @pre IsBridgeTile(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   111
 * @return the transport type of the bridge
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   112
 */
3234
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
   113
static inline TransportType GetBridgeTransportType(TileIndex t)
986c30171e92 (svn r3907) Replace many bridge related direct map accesses with calls to shiny new functions and mark some strange constructs with XXX
tron
parents: 3231
diff changeset
   114
{
3369
00c2ca209a89 (svn r4166) Sprinkle several map accessors with assert()s
tron
parents: 3355
diff changeset
   115
	assert(IsBridgeTile(t));
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   116
	return (TransportType)GB(_m[t].m5, 2, 2);
3977
edb5b94e2094 (svn r5155) - Remove the bridge branch merge (revision r5070)
tron
parents: 3953
diff changeset
   117
}
edb5b94e2094 (svn r5155) - Remove the bridge branch merge (revision r5070)
tron
parents: 3953
diff changeset
   118
edb5b94e2094 (svn r5155) - Remove the bridge branch merge (revision r5070)
tron
parents: 3953
diff changeset
   119
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   120
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   121
 * Does the bridge ramp lie in a snow or desert area?
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   122
 * @param t The ramp tile to analyze
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   123
 * @pre IsBridgeTile(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   124
 * @return true if and only if in a snow or desert area
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   125
 */
5661
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   126
static inline bool HasBridgeSnowOrDesert(TileIndex t)
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   127
{
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   128
	assert(IsBridgeTile(t));
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   129
	return HASBIT(_m[t].m4, 7);
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   130
}
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   131
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   132
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   133
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   134
 * Sets whether the bridge ramp lies in a snow or desert area.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   135
 * @param t              The ramp tile to set (un)make a snow/desert area
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   136
 * @param snow_or_desert Make (true) or unmake the tile a snow/desert area
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   137
 * @pre IsBridgeTile(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   138
 */
5661
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   139
static inline void SetBridgeSnowOrDesert(TileIndex t, bool snow_or_desert)
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   140
{
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   141
	assert(IsBridgeTile(t));
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   142
	SB(_m[t].m4, 7, 1, snow_or_desert);
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   143
}
6c6145677e7c (svn r7607) -Codechange: remove direct map accesses for snow/desert on tunnels and bridges.
rubidium
parents: 5573
diff changeset
   144
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
   145
/**
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   146
 * Finds the end of a bridge in the specified direction starting at a middle tile
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   147
 * @param t the bridge tile to find the bridge ramp for
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   148
 * @param d the direction to search in
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   149
 */
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   150
TileIndex GetBridgeEnd(TileIndex t, DiagDirection d);
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   151
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   152
/**
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   153
 * Finds the northern end of a bridge starting at a middle tile
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   154
 * @param t the bridge tile to find the bridge ramp for
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   155
 */
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   156
TileIndex GetNorthernBridgeEnd(TileIndex t);
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   157
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   158
/**
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   159
 * Finds the southern end of a bridge starting at a middle tile
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   160
 * @param t the bridge tile to find the bridge ramp for
3225
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   161
 */
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   162
TileIndex GetSouthernBridgeEnd(TileIndex t);
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   163
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   164
655763f3861c (svn r3898) Add functions to find a bridge end starting at a middle tile
tron
parents: 3216
diff changeset
   165
/**
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
   166
 * Starting at one bridge end finds the other bridge end
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   167
 * @param t the bridge ramp tile to find the other bridge ramp for
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
   168
 */
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   169
TileIndex GetOtherBridgeEnd(TileIndex t);
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
   170
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   171
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   172
 * Get the height ('z') of a bridge in pixels.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   173
 * @param tile the bridge ramp tile to get the bridge height from
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   174
 * @return the height of the bridge in pixels
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   175
 */
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   176
uint GetBridgeHeight(TileIndex tile);
3214
172b409bf612 (svn r3887) Add a function to get the other bridge end when you're at a bridge ramp
tron
parents: 3209
diff changeset
   177
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   178
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   179
 * Remove the bridge over the given axis.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   180
 * @param t the tile to remove the bridge from
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   181
 * @param a the axis of the bridge to remove
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   182
 * @pre MayHaveBridgeAbove(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   183
 */
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   184
static inline void ClearSingleBridgeMiddle(TileIndex t, Axis a)
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
   185
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   186
	assert(MayHaveBridgeAbove(t));
5847
9ce114e1d90d (svn r8050) -Codechange: Rename map member extra to m6, since its usage has been widden.
belugas
parents: 5726
diff changeset
   187
	CLRBIT(_m[t].m6, 6 + a);
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
   188
}
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
   189
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   190
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   191
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   192
 * Removes bridges from the given, that is bridges along the X and Y axis.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   193
 * @param t the tile to remove the bridge from
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   194
 * @pre MayHaveBridgeAbove(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   195
 */
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   196
static inline void ClearBridgeMiddle(TileIndex t)
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
   197
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   198
	ClearSingleBridgeMiddle(t, AXIS_X);
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   199
	ClearSingleBridgeMiddle(t, AXIS_Y);
3977
edb5b94e2094 (svn r5155) - Remove the bridge branch merge (revision r5070)
tron
parents: 3953
diff changeset
   200
}
edb5b94e2094 (svn r5155) - Remove the bridge branch merge (revision r5070)
tron
parents: 3953
diff changeset
   201
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   202
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   203
 * Set that there is a bridge over the given axis.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   204
 * @param t the tile to add the bridge to
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   205
 * @param a the axis of the bridge to add
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   206
 * @pre MayHaveBridgeAbove(t)
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   207
 */
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   208
static inline void SetBridgeMiddle(TileIndex t, Axis a)
3977
edb5b94e2094 (svn r5155) - Remove the bridge branch merge (revision r5070)
tron
parents: 3953
diff changeset
   209
{
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   210
	assert(MayHaveBridgeAbove(t));
5847
9ce114e1d90d (svn r8050) -Codechange: Rename map member extra to m6, since its usage has been widden.
belugas
parents: 5726
diff changeset
   211
	SETBIT(_m[t].m6, 6 + a);
3189
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
   212
}
1af302c5abd0 (svn r3846) Add functions to set the type of stuff (clear, water, rail, road) under bridges
tron
parents:
diff changeset
   213
3209
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   214
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   215
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   216
 * Generic part to make a bridge ramp for both roads and rails.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   217
 * @param t          the tile to make a bridge ramp
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   218
 * @param o          the new owner of the bridge ramp
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   219
 * @param bridgetype the type of bridge this bridge ramp belongs to
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   220
 * @param d          the direction this ramp must be facing
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   221
 * @param tt         the transport type of the bridge
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   222
 * @note this function should not be called directly.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   223
 */
3209
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   224
static inline void MakeBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d, TransportType tt)
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   225
{
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   226
	SetTileType(t, MP_TUNNELBRIDGE);
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   227
	SetTileOwner(t, o);
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   228
	_m[t].m2 = bridgetype << 4;
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   229
	_m[t].m4 = 0;
5573
afa6f92a71fd (svn r7573) -Merged the bridge branch. Allows to build bridges of arbitrary rail/road combinations (including signals)
celestar
parents: 4666
diff changeset
   230
	_m[t].m5 = 1 << 7 | tt << 2 | d;
3209
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   231
}
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   232
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   233
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   234
 * Make a bridge ramp for roads.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   235
 * @param t          the tile to make a bridge ramp
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   236
 * @param o          the new owner of the bridge ramp
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   237
 * @param bridgetype the type of bridge this bridge ramp belongs to
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   238
 * @param d          the direction this ramp must be facing
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   239
 */
3209
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   240
static inline void MakeRoadBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d)
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   241
{
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   242
	MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_ROAD);
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   243
	_m[t].m3 = 0;
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   244
}
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   245
9908
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   246
/**
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   247
 * Make a bridge ramp for rails.
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   248
 * @param t          the tile to make a bridge ramp
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   249
 * @param o          the new owner of the bridge ramp
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   250
 * @param bridgetype the type of bridge this bridge ramp belongs to
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   251
 * @param d          the direction this ramp must be facing
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   252
 * @param r          the rail type of the bridge
0fa543611bbe (svn r10112) [gamebalance] -Sync: r9520:9620 from trunk
celestar
parents: 6486
diff changeset
   253
 */
3209
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   254
static inline void MakeRailBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d, RailType r)
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   255
{
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   256
	MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_RAIL);
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   257
	_m[t].m3 = r;
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   258
}
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   259
e0b7d48351a3 (svn r3877) Add functions to turn a tile into a rail/road bridge ramp/middle part
tron
parents: 3196
diff changeset
   260
4666
850b5b6e4bac (svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents: 4158
diff changeset
   261
#endif /* BRIDGE_MAP_H */