OpenTTD Source
20241108-master-g80f628063a
|
Handles dividing the water in the map into regions to assist pathfinding. More...
Go to the source code of this file.
Data Structures | |
struct | WaterRegionPatchDesc |
Describes a single interconnected patch of water within a particular water region. More... | |
struct | WaterRegionDesc |
Describes a single square water region. More... | |
Typedefs | |
using | TWaterRegionPatchLabel = uint8_t |
using | TWaterRegionIndex = uint |
using | TVisitWaterRegionPatchCallBack = std::function< void(const WaterRegionPatchDesc &)> |
Functions | |
int | CalculateWaterRegionPatchHash (const WaterRegionPatchDesc &water_region_patch) |
Calculates a number that uniquely identifies the provided water region patch. More... | |
TileIndex | GetWaterRegionCenterTile (const WaterRegionDesc &water_region) |
Returns the center tile of a particular water region. More... | |
WaterRegionDesc | GetWaterRegionInfo (TileIndex tile) |
Returns basic water region information for the provided tile. More... | |
WaterRegionPatchDesc | GetWaterRegionPatchInfo (TileIndex tile) |
Returns basic water region patch information for the provided tile. More... | |
void | InvalidateWaterRegion (TileIndex tile) |
Marks the water region that tile is part of as invalid. More... | |
void | VisitWaterRegionPatchNeighbors (const WaterRegionPatchDesc &water_region_patch, TVisitWaterRegionPatchCallBack &callback) |
Calls the provided callback function on all accessible water region patches in each cardinal direction, plus any others that are reachable via aqueducts. More... | |
void | AllocateWaterRegions () |
Allocates the appropriate amount of water regions for the current map size. | |
void | PrintWaterRegionDebugInfo (TileIndex tile) |
Handles dividing the water in the map into regions to assist pathfinding.
Definition in file water_regions.h.
int CalculateWaterRegionPatchHash | ( | const WaterRegionPatchDesc & | water_region_patch | ) |
Calculates a number that uniquely identifies the provided water region patch.
water_region_patch | The Water region to calculate the hash for. |
Definition at line 271 of file water_regions.cpp.
References GetWaterRegionIndex(), and WaterRegionPatchDesc::label.
TileIndex GetWaterRegionCenterTile | ( | const WaterRegionDesc & | water_region | ) |
Returns the center tile of a particular water region.
water_region | The water region to find the center tile for. |
Definition at line 281 of file water_regions.cpp.
References TileXY(), and WaterRegionDesc::x.
WaterRegionDesc GetWaterRegionInfo | ( | TileIndex | tile | ) |
Returns basic water region information for the provided tile.
tile | The tile for which the information will be calculated. |
Definition at line 290 of file water_regions.cpp.
WaterRegionPatchDesc GetWaterRegionPatchInfo | ( | TileIndex | tile | ) |
Returns basic water region patch information for the provided tile.
tile | The tile for which the information will be calculated. |
Definition at line 299 of file water_regions.cpp.
void InvalidateWaterRegion | ( | TileIndex | tile | ) |
Marks the water region that tile is part of as invalid.
tile | Tile within the water region that we wish to invalidate. |
Definition at line 309 of file water_regions.cpp.
References GetWaterRegionIndex(), and IsValidTile().
void VisitWaterRegionPatchNeighbors | ( | const WaterRegionPatchDesc & | water_region_patch, |
TVisitWaterRegionPatchCallBack & | callback | ||
) |
Calls the provided callback function on all accessible water region patches in each cardinal direction, plus any others that are reachable via aqueducts.
water_region_patch | Water patch within the water region to start searching from |
callback | The function that will be called for each accessible water patch that is found |
Definition at line 387 of file water_regions.cpp.
References WaterRegionPatchDesc::label.