IsSubmerged

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  GitHub Search
Info
Added in 4.0.6 / 1.13.2

Returns whether the player character is submerged in water.

isSubmerged = IsSubmerged([unit])

Arguments

unit

string? : UnitToken

Returns

isSubmerged

boolean - True if the unit is submerged.

Details

• This function is similar to IsSwimming, but also returns 1 when running at the bottom of a surface of water.
• This function is available within the RestrictedEnvironment

See also

• IsSwimming
• IsFlying