water.h File Reference

Functions related to water management. More...

#include "water_map.h"
#include "economy_func.h"

Go to the source code of this file.

Enumerations
enum class	FloodingBehaviour : uint8_t { None , Active , Passive , DryOut }
	Describes the behaviour of a tile during flooding. More...

Functions
FloodingBehaviour	GetFloodingBehaviour (TileIndex tile)
	Returns the behaviour of a tile during flooding.
void	ClearNeighbourNonFloodingStates (TileIndex tile)
	Clear non-flooding state of the tiles around a tile.
void	TileLoop_Water (TileIndex tile)
	Tile callback function signature for running periodic tile updates.
bool	FloodHalftile (TileIndex t)
	Called from water_cmd if a non-flat rail-tile gets flooded and should be converted to shore.
void	ConvertGroundTilesIntoWaterTiles ()
void	DrawShipDepotSprite (int x, int y, Axis axis, DepotPart part)
void	DrawWaterClassGround (const struct TileInfo *ti)
void	DrawShoreTile (Slope tileh)
void	MakeWaterKeepingClass (TileIndex tile, Owner o)
void	CheckForDockingTile (TileIndex t)
	Mark the supplied tile as a docking tile if it is suitable for docking.
void	MakeRiverAndModifyDesertZoneAround (TileIndex tile)
	Make a river tile and remove desert directly around it.
void	RiverMakeWider (TileIndex tile, TileIndex origin_tile)
	Widen a river by expanding into adjacent tiles via circular tile search.
bool	RiverFlowsDown (TileIndex begin, TileIndex end)
	Check whether a river at begin could (logically) flow down to end.
bool	IsWateredTile (TileIndex tile, Direction from)
	return true if a tile is a water tile wrt.
Money	CanalMaintenanceCost (uint32_t num)
	Calculates the maintenance cost of a number of canal tiles.

Variables
static const uint	RIVER_OFFSET_DESERT_DISTANCE = 5
	Circular tile search diameter to create non-desert around a river tile.

Detailed Description

Functions related to water management.

Definition in file water.h.

Enumeration Type Documentation

FloodingBehaviour

enum class FloodingBehaviour : uint8_t

strong

Describes the behaviour of a tile during flooding.

Enumerator
None	The tile does not flood neighboured tiles.
Active	The tile floods neighboured tiles.
Passive	The tile does not actively flood neighboured tiles, but it prevents them from drying out.
DryOut	The tile drys out if it is not constantly flooded from neighboured tiles.

Definition at line 19 of file water.h.

Function Documentation

CanalMaintenanceCost()

Money CanalMaintenanceCost ( uint32_t num )

inline

Calculates the maintenance cost of a number of canal tiles.

Parameters

num	Number of canal tiles.

Returns

Total cost.

Definition at line 53 of file water.h.

References _price, InfrastructureWater, and IntSqrt().

Referenced by CompaniesGenStatistics().

CheckForDockingTile()

void CheckForDockingTile

(

TileIndex

t

)

Mark the supplied tile as a docking tile if it is suitable for docking.

Tiles surrounding the tile are tested to be docks with correct orientation.

Parameters

t	Tile to test.

Definition at line 201 of file water_cmd.cpp.

References OrthogonalTileArea::Add(), Begin, Station::docking_station, End, BaseStation::GetByTile(), Industry::GetByTile(), Industry, IsDockTile(), IsDockWaterPart(), IsOilRig(), IsTileType(), IsValidTile(), Industry::neutral_station, SetDockingTile(), Station, and TileOffsByDiagDir().

Referenced by ClearDockingTilesCheckingNeighbours(), CmdBuildBridge(), CmdBuildBuoy(), CmdBuildCanal(), CmdBuildShipDepot(), CmdBuildSingleRail(), DoBuildLock(), and DoFloodTile().

ClearNeighbourNonFloodingStates()

void ClearNeighbourNonFloodingStates

(

TileIndex

tile

)

Clear non-flooding state of the tiles around a tile.

Parameters

tile	The centre of the tile where other tiles' non-flooding state is cleared.

Definition at line 98 of file water_cmd.cpp.

References Begin, End, IsTileType(), IsValidTile(), SetNonFloodingWaterTile(), TileOffsByDir(), and Water.

Referenced by BuildObject(), ClearTile_Water(), CmdBuildBuoy(), CmdLandscapeClear(), PlantTreesOnTile(), and RemoveLock().

ConvertGroundTilesIntoWaterTiles()

void ConvertGroundTilesIntoWaterTiles

(

)

Definition at line 1347 of file water_cmd.cpp.

DrawShipDepotSprite()

void DrawShipDepotSprite	(	int	x,
		int	y,
		Axis	axis,
		DepotPart	part )

Definition at line 1007 of file water_cmd.cpp.

DrawShoreTile()

void DrawShoreTile

(

Slope

tileh

)

Definition at line 950 of file water_cmd.cpp.

FloodHalftile()

bool FloodHalftile

(

TileIndex

t

)

Called from water_cmd if a non-flat rail-tile gets flooded and should be converted to shore.

The function floods the lower halftile, if the tile has a halftile foundation.

Parameters

t	The tile to flood.

Returns

true if something was flooded.

Definition at line 761 of file rail_cmd.cpp.

References _current_company, ApplyFoundationToSlope(), CornerToTrackBits(), Execute, FindFirstTrack(), GetHighestSlopeCorner(), GetRailFoundation(), GetRailGroundType(), GetTileSlope(), GetTrackBits(), HalfTileWater, IsNonContinuousFoundation(), IsPlainRailTile(), IsSlopeWithOneCornerRaised(), IsSlopeWithThreeCornersRaised(), IsSteepSlope(), MakeShore(), MarkTileDirtyByTile(), OppositeCorner(), OWNER_WATER, SetRailGroundType(), and TRACK_BIT_NONE.

Referenced by DoFloodTile().

GetFloodingBehaviour()

FloodingBehaviour GetFloodingBehaviour

(

TileIndex

tile

)

Returns the behaviour of a tile during flooding.

Parameters

tile	The tile to get the behaviour for.

Returns

Behaviour of the tile

Definition at line 1140 of file water_cmd.cpp.

References Active, DryOut, GetRailGroundType(), GetTileSlope(), GetTileType(), GetTreeGround(), GetWaterClass(), HalfTileWater, Industry, IsCoast(), IsSlopeWithOneCornerRaised(), None, Object, Railway, Sea, Shore, Station, Trees, Void, and Water.

Referenced by CheckRailSlope(), and TileLoop_Water().

IsWateredTile()

bool IsWateredTile	(	TileIndex	tile,
		Direction	from )

return true if a tile is a water tile wrt.

a certain direction.

Parameters

tile	The tile of interest.
from	The direction of interest.

Returns

true iff the tile is water in the view of 'from'.

Definition at line 675 of file water_cmd.cpp.

References Clear, Coast, Depot, DiagDirToAxis(), DirToDiagDir(), E, GetIndustryIndex(), GetLockDirection(), GetRailGroundType(), GetTileSlope(), GetTileType(), GetTunnelBridgeDirection(), GetTunnelBridgeTransportType(), GetWaterTileType(), HalfTileWater, Industry, IsBuoy(), IsDock(), IsOilRig(), IsPlainRail(), IsTileFlat(), IsTileOnWater(), IsTileType(), Lock, N, NE, NW, Object, Railway, ReverseDiagDir(), S, SE, SLOPE_E, SLOPE_N, SLOPE_S, SLOPE_W, Station, SW, TileOffsByDir(), TRANSPORT_WATER, TunnelBridge, Void, W, and Water.

Referenced by DrawWaterEdges(), and CanalScopeResolver::GetVariable().

MakeRiverAndModifyDesertZoneAround()

void MakeRiverAndModifyDesertZoneAround

(

TileIndex

tile

)

Make a river tile and remove desert directly around it.

Parameters

tile	The tile to change into river and create non-desert around

Definition at line 479 of file water_cmd.cpp.

References Desert, GetTropicZone(), MakeRiver(), MarkTileDirtyByTile(), Normal, RIVER_OFFSET_DESERT_DISTANCE, and SetTropicZone().

Referenced by MakeLake(), MakeWetlands(), and RiverMakeWider().

MakeWaterKeepingClass()

void MakeWaterKeepingClass	(	TileIndex	tile,
		Owner	o )

Definition at line 225 of file water_cmd.cpp.

RiverFlowsDown()

bool RiverFlowsDown	(	TileIndex	begin,
		TileIndex	end )

Check whether a river at begin could (logically) flow down to end.

Parameters

begin	The origin of the flow.
end	The destination of the flow.

Returns

True iff the water can be flowing down.

Definition at line 1322 of file landscape.cpp.

References DistanceManhattan(), GetTileSlopeZ(), IsInclinedSlope(), and SLOPE_FLAT.

Referenced by FlowRiver(), and YapfRiverBuilder::PfFollowNode().

RiverMakeWider()

void RiverMakeWider	(	TileIndex	tile,
		TileIndex	origin_tile )

Widen a river by expanding into adjacent tiles via circular tile search.

Parameters

tile	The tile to try expanding the river into.
origin_tile	The tile to try surrounding the river around.

Definition at line 1181 of file landscape.cpp.

References Auto, Begin, ChangeDiagDir(), ComplementSlope(), End, Execute, GetInclinedSlopeDirection(), GetTileMaxZ(), GetTileSlope(), GetTileZ(), IsInclinedSlope(), IsRiver(), IsSlopeWithOneCornerRaised(), IsSlopeWithThreeCornersRaised(), IsSteepSlope(), IsTileFlat(), IsValidTile(), IsWaterTile(), Left90, MakeRiverAndModifyDesertZoneAround(), ReverseDiagDir(), Right90, SLOPE_FLAT, and TileAddByDiagDir().

TileLoop_Water()

void TileLoop_Water

(

TileIndex

tile

)

Tile callback function signature for running periodic tile updates.

Parameters

tile	The tile to update.

See also

RunTileLoop

Let a water tile floods its diagonal adjoining tiles called by TileLoop_Industry, TileLoop_Rail, TileLoop_Station, TileLoop_Object, TileLoop_Trees and TileLoop_Void.

Definition at line 1292 of file water_cmd.cpp.

References _flood_from_dirs, Active, AddTileIndexDiffCWrap(), AmbientSoundEffect(), Begin, DoDryUp(), DoFloodTile(), DryOut, End, GetFloodingBehaviour(), GetFoundationSlope(), GetTreeGround(), INVALID_TILE, IsBuoy(), IsDock(), IsNonFloodingWaterTile(), IsTileType(), IsValidTile(), Passive, ReverseDir(), SetNonFloodingWaterTile(), Shore, SLOPE_HALFTILE_MASK, SLOPE_STEEP, Station, TileIndexDiffCByDir(), Trees, and Water.

Referenced by TileLoop_Industry(), TileLoop_Object(), TileLoop_Rail(), TileLoop_Station(), TileLoop_Trees(), and TileLoop_Void().

Variable Documentation

RIVER_OFFSET_DESERT_DISTANCE

const uint RIVER_OFFSET_DESERT_DISTANCE = 5

static

Circular tile search diameter to create non-desert around a river tile.

Definition at line 44 of file water.h.

Referenced by CmdBuildCanal(), and MakeRiverAndModifyDesertZoneAround().