OpenTTD
water.h
Go to the documentation of this file.
1 /* $Id$ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #ifndef WATER_H
13 #define WATER_H
14 
15 #include "water_map.h"
16 #include "economy_func.h"
17 
26 };
27 
29 
30 void TileLoop_Water(TileIndex tile);
31 bool FloodHalftile(TileIndex t);
32 void DoFloodTile(TileIndex target);
33 
34 void ConvertGroundTilesIntoWaterTiles();
35 
36 void DrawShipDepotSprite(int x, int y, Axis axis, DepotPart part);
37 void DrawWaterClassGround(const struct TileInfo *ti);
38 void DrawShoreTile(Slope tileh);
39 
40 void MakeWaterKeepingClass(TileIndex tile, Owner o);
42 
43 bool RiverModifyDesertZone(TileIndex tile, void *data);
44 static const uint RIVER_OFFSET_DESERT_DISTANCE = 5;
45 
46 bool IsWateredTile(TileIndex tile, Direction from);
47 
53 static inline Money CanalMaintenanceCost(uint32 num)
54 {
55  return (_price[PR_INFRASTRUCTURE_WATER] * num * (1 + IntSqrt(num))) >> 6; // 6 bits scaling.
56 }
57 
58 #endif /* WATER_H */
Owner
Enum for all companies/owners.
Definition: company_type.h:20
The tile drys up if it is not constantly flooded from neighboured tiles.
Definition: water.h:25
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
void TileLoop_Water(TileIndex tile)
Let a water tile floods its diagonal adjoining tiles called from tunnelbridge_cmd, and by TileLoop_Industry() and TileLoop_Track()
Definition: water_cmd.cpp:1208
FloodingBehaviour
Describes the behaviour of a tile during flooding.
Definition: water.h:21
The tile does not flood neighboured tiles.
Definition: water.h:22
bool IsWateredTile(TileIndex tile, Direction from)
return true if a tile is a water tile wrt.
Definition: water_cmd.cpp:601
bool RiverModifyDesertZone(TileIndex tile, void *data)
Callback to create non-desert around a river tile.
Definition: water_cmd.cpp:427
FloodingBehaviour GetFloodingBehaviour(TileIndex tile)
Returns the behaviour of a tile during flooding.
Definition: water_cmd.cpp:1058
Map accessors for water tiles.
Direction
Defines the 8 directions on the map.
The tile does not actively flood neighboured tiles, but it prevents them from drying up...
Definition: water.h:24
bool FloodHalftile(TileIndex t)
Called from water_cmd if a non-flat rail-tile gets flooded and should be converted to shore...
Definition: rail_cmd.cpp:766
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
DepotPart
Sections of the water depot.
Definition: water_map.h:59
Functions related to the economy.
The tile floods neighboured tiles.
Definition: water.h:23
Slope
Enumeration for the slope-type.
Definition: slope_type.h:50
static Money CanalMaintenanceCost(uint32 num)
Calculates the maintenance cost of a number of canal tiles.
Definition: water.h:53
static const uint RIVER_OFFSET_DESERT_DISTANCE
Circular tile search radius to create non-desert around a river tile.
Definition: water.h:44
uint32 IntSqrt(uint32 num)
Compute the integer square root.
Definition: math_func.cpp:79
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
Definition: water_cmd.cpp:184
Axis
Allow incrementing of DiagDirDiff variables.
void DoFloodTile(TileIndex target)
Floods a tile.
Definition: water_cmd.cpp:1094