OpenTTD Source: src/water.h Source File

OpenTTD Source 14.0-RC3

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
19 enum FloodingBehaviour {
20 FLOOD_NONE,
21 FLOOD_ACTIVE,
22 FLOOD_PASSIVE,
23 FLOOD_DRYUP,
24 };
25
26 FloodingBehaviour GetFloodingBehaviour(TileIndex tile);
27
28 void TileLoop_Water(TileIndex tile);
29 bool FloodHalftile(TileIndex t);
30 void DoFloodTile(TileIndex target);
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);
39 void CheckForDockingTile(TileIndex t);
40
41 bool RiverModifyDesertZone(TileIndex tile, void *data);
42 void MakeRiverAndModifyDesertZoneAround(TileIndex tile);
43 static const uint RIVER_OFFSET_DESERT_DISTANCE = 5;
44
45 bool IsWateredTile(TileIndex tile, Direction from);
46
52 inline Money CanalMaintenanceCost(uint32_t num)
53 {
54 return (_price[PR_INFRASTRUCTURE_WATER] * num * (1 + IntSqrt(num))) >> 6; // 6 bits scaling.
55 }
56
57 #endif /* WATER_H */
FLOOD_DRYUP
@ FLOOD_DRYUP
The tile drys up if it is not constantly flooded from neighboured tiles.
Definition: water.h:23
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
TileInfo
Tile information, used while rendering the tile.
Definition: tile_cmd.h:43
CanalMaintenanceCost
Money CanalMaintenanceCost(uint32_t num)
Calculates the maintenance cost of a number of canal tiles.
Definition: water.h:52
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition: direction_type.h:116
IntSqrt
uint32_t IntSqrt(uint32_t num)
Compute the integer square root.
Definition: math_func.cpp:42
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
economy_func.h
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
CheckForDockingTile
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
Definition: water_cmd.cpp:184
DoFloodTile
void DoFloodTile(TileIndex target)
Floods a tile.
Definition: water_cmd.cpp:1119
IsWateredTile
bool IsWateredTile(TileIndex tile, Direction from)
return true if a tile is a water tile wrt.
Definition: water_cmd.cpp:623
TileLoop_Water
void TileLoop_Water(TileIndex tile)
Let a water tile floods its diagonal adjoining tiles called from tunnelbridge_cmd,...
Definition: water_cmd.cpp:1233
water_map.h
GetFloodingBehaviour
FloodingBehaviour GetFloodingBehaviour(TileIndex tile)
Returns the behaviour of a tile during flooding.
Definition: water_cmd.cpp:1080
FLOOD_PASSIVE
@ FLOOD_PASSIVE
The tile does not actively flood neighboured tiles, but it prevents them from drying up.
Definition: water.h:22
FloodingBehaviour
FloodingBehaviour
Describes the behaviour of a tile during flooding.
Definition: water.h:19
RIVER_OFFSET_DESERT_DISTANCE
static const uint RIVER_OFFSET_DESERT_DISTANCE
Circular tile search radius to create non-desert around a river tile.
Definition: water.h:43
FLOOD_NONE
@ FLOOD_NONE
The tile does not flood neighboured tiles.
Definition: water.h:20
FloodHalftile
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
FLOOD_ACTIVE
@ FLOOD_ACTIVE
The tile floods neighboured tiles.
Definition: water.h:21
OverflowSafeInt< int64_t >
MakeRiverAndModifyDesertZoneAround
void MakeRiverAndModifyDesertZoneAround(TileIndex tile)
Make a river tile and remove desert directly around it.
Definition: water_cmd.cpp:443
DepotPart
DepotPart
Sections of the water depot.
Definition: water_map.h:66
RiverModifyDesertZone
bool RiverModifyDesertZone(TileIndex tile, void *data)
Callback to create non-desert around a river tile.
Definition: water_cmd.cpp:433