OpenTTD Source  20241108-master-g80f628063a
water.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef WATER_H
11 #define WATER_H
12 
13 #include "water_map.h"
14 #include "economy_func.h"
15 
24 };
25 
28 
29 void TileLoop_Water(TileIndex tile);
30 bool FloodHalftile(TileIndex t);
31 
32 void ConvertGroundTilesIntoWaterTiles();
33 
34 void DrawShipDepotSprite(int x, int y, Axis axis, DepotPart part);
35 void DrawWaterClassGround(const struct TileInfo *ti);
36 void DrawShoreTile(Slope tileh);
37 
38 void MakeWaterKeepingClass(TileIndex tile, Owner o);
40 
42 static const uint RIVER_OFFSET_DESERT_DISTANCE = 5;
43 
44 bool IsWateredTile(TileIndex tile, Direction from);
45 
51 inline Money CanalMaintenanceCost(uint32_t num)
52 {
53  return (_price[PR_INFRASTRUCTURE_WATER] * num * (1 + IntSqrt(num))) >> 6; // 6 bits scaling.
54 }
55 
56 #endif /* WATER_H */
Owner
Enum for all companies/owners.
Definition: company_type.h:18
uint32_t IntSqrt(uint32_t num)
Compute the integer square root.
Definition: math_func.cpp:42
Direction
Defines the 8 directions on the map.
Axis
Allow incrementing of DiagDirDiff variables.
Functions related to the economy.
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
Tile information, used while rendering the tile.
Definition: tile_cmd.h:43
void TileLoop_Water(TileIndex tile)
Let a water tile floods its diagonal adjoining tiles called from tunnelbridge_cmd,...
Definition: water_cmd.cpp:1245
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:762
void ClearNeighbourNonFloodingStates(TileIndex tile)
Clear non-flooding state of the tiles around a tile.
Definition: water_cmd.cpp:97
FloodingBehaviour GetFloodingBehaviour(TileIndex tile)
Returns the behaviour of a tile during flooding.
Definition: water_cmd.cpp:1092
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
Definition: water_cmd.cpp:195
static const uint RIVER_OFFSET_DESERT_DISTANCE
Circular tile search radius to create non-desert around a river tile.
Definition: water.h:42
FloodingBehaviour
Describes the behaviour of a tile during flooding.
Definition: water.h:19
@ FLOOD_NONE
The tile does not flood neighboured tiles.
Definition: water.h:20
@ FLOOD_ACTIVE
The tile floods neighboured tiles.
Definition: water.h:21
@ FLOOD_DRYUP
The tile drys up if it is not constantly flooded from neighboured tiles.
Definition: water.h:23
@ FLOOD_PASSIVE
The tile does not actively flood neighboured tiles, but it prevents them from drying up.
Definition: water.h:22
void MakeRiverAndModifyDesertZoneAround(TileIndex tile)
Make a river tile and remove desert directly around it.
Definition: water_cmd.cpp:454
bool IsWateredTile(TileIndex tile, Direction from)
return true if a tile is a water tile wrt.
Definition: water_cmd.cpp:636
Money CanalMaintenanceCost(uint32_t num)
Calculates the maintenance cost of a number of canal tiles.
Definition: water.h:51
Map accessors for water tiles.
DepotPart
Sections of the water depot.
Definition: water_map.h:58