File diff r15609:02b794721f9c → r15610:623a23fb6560
src/water_map.h
Show inline comments
 
@@ -45,13 +45,14 @@ enum LockPart {
 
	LOCK_MIDDLE = 0x10,
 
	LOCK_LOWER  = 0x14,
 
	LOCK_UPPER  = 0x18,
 
	LOCK_END    = 0x1C
 
};
 

	
 
/** Get the water tile type at a tile.
 
/**
 
 * Get the water tile type at a tile.
 
 * @param t Water tile to query.
 
 * @return Water tile type at the tile.
 
 */
 
static inline WaterTileType GetWaterTileType(TileIndex t)
 
{
 
	assert(IsTileType(t, MP_WATER));
 
@@ -61,23 +62,25 @@ static inline WaterTileType GetWaterTile
 
	if (IsInsideMM(_m[t].m5, LOCK_MIDDLE, LOCK_END)) return WATER_TILE_LOCK;
 

	
 
	assert(IsInsideMM(_m[t].m5, DEPOT_NORTH, DEPOT_END));
 
	return WATER_TILE_DEPOT;
 
}
 

	
 
/** Get the water class at a tile.
 
/**
 
 * Get the water class at a tile.
 
 * @param t Water tile to query.
 
 * @return Water class at the tile.
 
 */
 
static inline WaterClass GetWaterClass(TileIndex t)
 
{
 
	assert(IsTileType(t, MP_WATER) || IsTileType(t, MP_STATION) || IsTileType(t, MP_INDUSTRY));
 
	return (WaterClass)(IsTileType(t, MP_INDUSTRY) ? GB(_m[t].m1, 5, 2) : GB(_m[t].m3, 0, 2));
 
}
 

	
 
/** Set the water class at a tile.
 
/**
 
 * Set the water class at a tile.
 
 * @param t  Water tile to change.
 
 * @param wc New water class.
 
 */
 
static inline void SetWaterClass(TileIndex t, WaterClass wc)
 
{
 
	assert(IsTileType(t, MP_WATER) || IsTileType(t, MP_STATION) || IsTileType(t, MP_INDUSTRY));
 
@@ -85,140 +88,155 @@ static inline void SetWaterClass(TileInd
 
		SB(_m[t].m1, 5, 2, wc);
 
	} else {
 
		SB(_m[t].m3, 0, 2, wc);
 
	}
 
}
 

	
 
/** Is it a plain water tile?
 
/**
 
 * Is it a plain water tile?
 
 * @param t Water tile to query.
 
 * @return \c true if any type of clear water like ocean, river, or canal.
 
 */
 
static inline bool IsWater(TileIndex t)
 
{
 
	return GetWaterTileType(t) == WATER_TILE_CLEAR;
 
}
 

	
 
/** Is it a sea water tile?
 
/**
 
 * Is it a sea water tile?
 
 * @param t Water tile to query.
 
 * @return \c true if it is a sea water tile.
 
 */
 
static inline bool IsSea(TileIndex t)
 
{
 
	return IsWater(t) && GetWaterClass(t) == WATER_CLASS_SEA;
 
}
 

	
 
/** Is it a canal tile?
 
/**
 
 * Is it a canal tile?
 
 * @param t Water tile to query.
 
 * @return \c true if it is a canal tile.
 
 */
 
static inline bool IsCanal(TileIndex t)
 
{
 
	return IsWater(t) && GetWaterClass(t) == WATER_CLASS_CANAL;
 
}
 

	
 
/** Is it a river water tile?
 
/**
 
 * Is it a river water tile?
 
 * @param t Water tile to query.
 
 * @return \c true if it is a river water tile.
 
 */
 
static inline bool IsRiver(TileIndex t)
 
{
 
	return IsWater(t) && GetWaterClass(t) == WATER_CLASS_RIVER;
 
}
 

	
 
/** Is it a water tile with plain water?
 
/**
 
 * Is it a water tile with plain water?
 
 * @param t Tile to query.
 
 * @return \c true if it is a plain water tile.
 
 */
 
static inline bool IsWaterTile(TileIndex t)
 
{
 
	return IsTileType(t, MP_WATER) && IsWater(t);
 
}
 

	
 
/** Is it a coast tile?
 
/**
 
 * Is it a coast tile?
 
 * @param t Water tile to query.
 
 * @return \c true if it is a sea water tile.
 
 */
 
static inline bool IsCoast(TileIndex t)
 
{
 
	return GetWaterTileType(t) == WATER_TILE_COAST;
 
}
 

	
 
/** Get the other tile of the ship depot.
 
/**
 
 * Get the other tile of the ship depot.
 
 * @param t Tile to query, containing one section of a ship depot.
 
 * @return Tile containing the other section of the depot.
 
 */
 
static inline TileIndex GetOtherShipDepotTile(TileIndex t)
 
{
 
	return t + (HasBit(_m[t].m5, 0) ? -1 : 1) * (HasBit(_m[t].m5, 1) ? TileDiffXY(0, 1) : TileDiffXY(1, 0));
 
}
 

	
 
/** Is it a water tile with a ship depot on it?
 
/**
 
 * Is it a water tile with a ship depot on it?
 
 * @param t Water tile to query.
 
 * @return \c true if it is a ship depot tile.
 
 */
 
static inline bool IsShipDepot(TileIndex t)
 
{
 
	return IsInsideMM(_m[t].m5, DEPOT_NORTH, DEPOT_END);
 
}
 

	
 
/** Is it a ship depot tile?
 
/**
 
 * Is it a ship depot tile?
 
 * @param t Tile to query.
 
 * @return \c true if it is a ship depot tile.
 
 */
 
static inline bool IsShipDepotTile(TileIndex t)
 
{
 
	return IsTileType(t, MP_WATER) && IsShipDepot(t);
 
}
 

	
 
/** Get the axis of the ship depot.
 
/**
 
 * Get the axis of the ship depot.
 
 * @param t Water tile to query.
 
 * @return Axis of the depot.
 
 */
 
static inline Axis GetShipDepotAxis(TileIndex t)
 
{
 
	return (Axis)GB(_m[t].m5, 1, 1);
 
}
 

	
 
/** Get the direction of the ship depot.
 
/**
 
 * Get the direction of the ship depot.
 
 * @param t Water tile to query.
 
 * @return Direction of the depot.
 
 */
 
static inline DiagDirection GetShipDepotDirection(TileIndex t)
 
{
 
	return XYNSToDiagDir(GetShipDepotAxis(t), GB(_m[t].m5, 0, 1));
 
}
 

	
 
/** Is it a water lock tile?
 
/**
 
 * Is it a water lock tile?
 
 * @param t Water tile to query.
 
 * @return \c true if it is a water lock tile.
 
 */
 
static inline bool IsLock(TileIndex t)
 
{
 
	return IsInsideMM(_m[t].m5, LOCK_MIDDLE, LOCK_END);
 
}
 

	
 
/** Get the direction of the water lock.
 
/**
 
 * Get the direction of the water lock.
 
 * @param t Water tile to query.
 
 * @return Direction of the lock.
 
 */
 
static inline DiagDirection GetLockDirection(TileIndex t)
 
{
 
	return (DiagDirection)GB(_m[t].m5, 0, 2);
 
}
 

	
 
/** Get a section of a depot or a lock.
 
/**
 
 * Get a section of a depot or a lock.
 
 * @param t Water tile to query.
 
 * @return The section.
 
 */
 
static inline byte GetSection(TileIndex t)
 
{
 
	assert(GetWaterTileType(t) == WATER_TILE_LOCK || GetWaterTileType(t) == WATER_TILE_DEPOT);
 
	return GB(_m[t].m5, 0, 4);
 
}
 

	
 
/** Get the random bits of the water tile.
 
/**
 
 * Get the random bits of the water tile.
 
 * @param t Water tile to query.
 
 * @return Random bits of the tile.
 
 */
 
static inline byte GetWaterTileRandomBits(TileIndex t)
 
{
 
	return _m[t].m4;
 
@@ -309,13 +327,14 @@ static inline void MakeShipDepot(TileInd
 
	_m[t].m4 = 0;
 
	_m[t].m5 = base + a * 2;
 
	SB(_m[t].m6, 2, 4, 0);
 
	_me[t].m7 = 0;
 
}
 

	
 
/** Make a lock section.
 
/**
 
 * Make a lock section.
 
 * @param t Tile to place the water lock section.
 
 * @param o Owner of the lock.
 
 * @param section Section to place.
 
 * @param original_water_class Original water class.
 
 * @see MakeLock
 
 */