openttd-ottdgrfs: comparison src/bridge

equal deleted inserted replaced

-:cc3f6bb84d6d
+:3ba37b6fa39b
 /* $Id$ */
-/** @file bridge_map.h */
+/** @file bridge_map.h Map accessor functions for bridges. */
 #ifndef BRIDGE_MAP_H
 #define BRIDGE_MAP_H
 #include "direction.h"
 }
 /**
 * checks if a bridge is set above the ground of this tile
 * @param t The tile to analyze
+* @pre MayHaveBridgeAbove(t)
 * @return true if a bridge is detected above
 */
 static inline bool IsBridgeAbove(TileIndex t)
 {
 	assert(MayHaveBridgeAbove(t));
 /**
 * Determines the type of bridge on a tile
 * @param t The tile to analyze
+* @pre IsBridgeTile(t)
 * @return The bridge type
 */
 static inline uint GetBridgeType(TileIndex t)
 {
 	assert(IsBridgeTile(t));
 /**
 * Get the direction pointing onto the bridge
 * @param t The tile to analyze
+* @pre IsBridgeTile(t)
 * @return the above mentionned direction
 */
 static inline DiagDirection GetBridgeRampDirection(TileIndex t)
 {
 	assert(IsBridgeTile(t));
 	return (DiagDirection)GB(_m[t].m5, 0, 2);
 }
+/**
+* Get the axis of the bridge that goes over the tile. Not the axis or the ramp.
+* @param t The tile to analyze
+* @pre IsBridgeAbove(t)
+* @return the above mentioned axis
+*/
 static inline Axis GetBridgeAxis(TileIndex t)
 {
 	assert(IsBridgeAbove(t));
 	return (Axis)(GB(_m[t].m6, 6, 2) - 1);
 }
+/**
+* Get the transport type of the bridge's ramp.
+* @param t The ramp tile to analyze
+* @pre IsBridgeTile(t)
+* @return the transport type of the bridge
+*/
 static inline TransportType GetBridgeTransportType(TileIndex t)
 {
 	assert(IsBridgeTile(t));
 	return (TransportType)GB(_m[t].m5, 2, 2);
 }
+/**
+* Does the bridge ramp lie in a snow or desert area?
+* @param t The ramp tile to analyze
+* @pre IsBridgeTile(t)
+* @return true if and only if in a snow or desert area
+*/
 static inline bool HasBridgeSnowOrDesert(TileIndex t)
 {
 	assert(IsBridgeTile(t));
 	return HASBIT(_m[t].m4, 7);
 }
+/**
+* Sets whether the bridge ramp lies in a snow or desert area.
+* @param t              The ramp tile to set (un)make a snow/desert area
+* @param snow_or_desert Make (true) or unmake the tile a snow/desert area
+* @pre IsBridgeTile(t)
+*/
 static inline void SetBridgeSnowOrDesert(TileIndex t, bool snow_or_desert)
 {
 	assert(IsBridgeTile(t));
 	SB(_m[t].m4, 7, 1, snow_or_desert);
 }
 /**
 * Finds the end of a bridge in the specified direction starting at a middle tile
-*/
+* @param t the bridge tile to find the bridge ramp for
-TileIndex GetBridgeEnd(TileIndex, DiagDirection);
+* @param d the direction to search in
+*/
+TileIndex GetBridgeEnd(TileIndex t, DiagDirection d);
 /**
 * Finds the northern end of a bridge starting at a middle tile
+* @param t the bridge tile to find the bridge ramp for
 */
 TileIndex GetNorthernBridgeEnd(TileIndex t);
 /**
 * Finds the southern end of a bridge starting at a middle tile
+* @param t the bridge tile to find the bridge ramp for
 */
 TileIndex GetSouthernBridgeEnd(TileIndex t);
 /**
 * Starting at one bridge end finds the other bridge end
-*/
+* @param t the bridge ramp tile to find the other bridge ramp for
-TileIndex GetOtherBridgeEnd(TileIndex);
+*/
+TileIndex GetOtherBridgeEnd(TileIndex t);
+/**
+* Get the height ('z') of a bridge in pixels.
+* @param tile the bridge ramp tile to get the bridge height from
+* @return the height of the bridge in pixels
+*/
 uint GetBridgeHeight(TileIndex tile);
-uint GetBridgeFoundation(Slope tileh, Axis axis);
+/**
+* Remove the bridge over the given axis.
+* @param t the tile to remove the bridge from
+* @param a the axis of the bridge to remove
+* @pre MayHaveBridgeAbove(t)
+*/
 static inline void ClearSingleBridgeMiddle(TileIndex t, Axis a)
 {
 	assert(MayHaveBridgeAbove(t));
 	CLRBIT(_m[t].m6, 6 + a);
 }
+/**
+* Removes bridges from the given, that is bridges along the X and Y axis.
+* @param t the tile to remove the bridge from
+* @pre MayHaveBridgeAbove(t)
+*/
 static inline void ClearBridgeMiddle(TileIndex t)
 {
 	ClearSingleBridgeMiddle(t, AXIS_X);
 	ClearSingleBridgeMiddle(t, AXIS_Y);
 }
+/**
+* Set that there is a bridge over the given axis.
+* @param t the tile to add the bridge to
+* @param a the axis of the bridge to add
+* @pre MayHaveBridgeAbove(t)
+*/
 static inline void SetBridgeMiddle(TileIndex t, Axis a)
 {
 	assert(MayHaveBridgeAbove(t));
 	SETBIT(_m[t].m6, 6 + a);
 }
+/**
+* Generic part to make a bridge ramp for both roads and rails.
+* @param t          the tile to make a bridge ramp
+* @param o          the new owner of the bridge ramp
+* @param bridgetype the type of bridge this bridge ramp belongs to
+* @param d          the direction this ramp must be facing
+* @param tt         the transport type of the bridge
+* @note this function should not be called directly.
+*/
 static inline void MakeBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d, TransportType tt)
 {
 	SetTileType(t, MP_TUNNELBRIDGE);
 	SetTileOwner(t, o);
 	_m[t].m2 = bridgetype << 4;
 	_m[t].m4 = 0;
 	_m[t].m5 = 1 << 7 | tt << 2 | d;
 }
+/**
+* Make a bridge ramp for roads.
+* @param t          the tile to make a bridge ramp
+* @param o          the new owner of the bridge ramp
+* @param bridgetype the type of bridge this bridge ramp belongs to
+* @param d          the direction this ramp must be facing
+*/
 static inline void MakeRoadBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d)
 {
 	MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_ROAD);
 	_m[t].m3 = 0;
 }
+/**
+* Make a bridge ramp for rails.
+* @param t          the tile to make a bridge ramp
+* @param o          the new owner of the bridge ramp
+* @param bridgetype the type of bridge this bridge ramp belongs to
+* @param d          the direction this ramp must be facing
+* @param r          the rail type of the bridge
+*/
 static inline void MakeRailBridgeRamp(TileIndex t, Owner o, uint bridgetype, DiagDirection d, RailType r)
 {
 	MakeBridgeRamp(t, o, bridgetype, d, TRANSPORT_RAIL);
 	_m[t].m3 = r;
 }

changeset 6914	3ba37b6fa39b
parent 6912	f1dafa4911fb
child 7157	270bc5b64e08