Description
Checks whether the BaseObject character is currently in the water area type specified by S1.
"Sea" reads the character's own cached natural water-area state (FB2Character::IsInWaterArea),
which is refreshed elsewhere from FB2TerritoryManager::IsInWaterTerritory(GetLocation()).
"SwimmingPool" checks whether the character's current location is inside a site swimming pool grid,
via FB2SiteManager::IsInWaterSiteGrid().
Parameters
| Parameter | Description |
|---|
| BaseObject | The character whose water-area state is checked (Self or Target). |
| CompareType | Type of comparison operation (Equal or NotEqual). |
| S1 | Which water area type to check: "Sea" or "SwimmingPool". |
Examples
| Description | BaseObject | Command | CompareType | S1 |
|---|
| Checks whether Self is currently in the sea (not a pool) | Self | IsInWaterArea | Equal | Sea |
| Checks whether Self is NOT in the sea | Self | IsInWaterArea | NotEqual | Sea |
| Checks whether Self is currently inside a site swimming pool | Self | IsInWaterArea | Equal | SwimmingPool |