OpenTTD Source: WaterRegionDesc Struct Reference

OpenTTD Source 15.3

Public Member Functions | Data Fields
WaterRegionDesc Struct Reference

Describes a single square water region. More...

`#include <water_regions.h>`

## Public Member Functions
| WaterRegionDesc (const int x, const int y)
| WaterRegionDesc (const WaterRegionPatchDesc &water_region_patch)
bool | operator== (const WaterRegionDesc &other) const

## Data Fields
int | x
| The X coordinate of the water region, i.e. X=2 is the 3rd water region along the X-axis.
int | y
| The Y coordinate of the water region, i.e. Y=2 is the 3rd water region along the Y-axis.

## Detailed Description

Describes a single square water region.

Definition at line 39 of file water_regions.h.

## Constructor & Destructor Documentation

## ◆ WaterRegionDesc() [1/2]

WaterRegionDesc::WaterRegionDesc | ( | const int | x,
|  | const int | y
| ) |  |
| inline

Definition at line 43 of file water_regions.h.

## ◆ WaterRegionDesc() [2/2]

WaterRegionDesc::WaterRegionDesc | ( | const WaterRegionPatchDesc & | water_region_patch | ) |
| inline

Definition at line 44 of file water_regions.h.

## Member Function Documentation

## ◆ operator==()

bool WaterRegionDesc::operator== | ( | const WaterRegionDesc & | other | ) | const
| inline

Definition at line 46 of file water_regions.h.

## Field Documentation

## ◆ x

int WaterRegionDesc::x

The X coordinate of the water region, i.e. X=2 is the 3rd water region along the X-axis.

Definition at line 40 of file water_regions.h.

Referenced by GetWaterRegionCenterTile(), and GetWaterRegionIndex().

## ◆ y

int WaterRegionDesc::y

The Y coordinate of the water region, i.e. Y=2 is the 3rd water region along the Y-axis.

Definition at line 41 of file water_regions.h.

Referenced by GetWaterRegionCenterTile(), and GetWaterRegionIndex().

The documentation for this struct was generated from the following file:

- src/pathfinder/water_regions.h