surfaceIsWater: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Position3D" to "Position3D")
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
Line 33: Line 33:
|x2= <code>_isWater = [[surfaceIsWater]] [[position]] [[player]];</code>
|x2= <code>_isWater = [[surfaceIsWater]] [[position]] [[player]];</code>


|seealso= [[surfaceType]], [[surfaceNormal]], [[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[isOnRoad]]
|seealso= [[surfaceType]] [[surfaceNormal]], [[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[isOnRoad]]
}}
}}


Revision as of 18:17, 20 January 2022

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns whether there is water at given position. In Arma 3, it also detects pond objects, but only if they are loaded in memory (normally only true if the objects are within the object view distance)
Groups:
Positions

Syntax

Syntax:
surfaceIsWater position
Parameters:
position: Array - format Position2D or Position3D in which case Z will be ignored
Return Value:
Boolean

Examples

Example 1:
_isWater= surfaceIsWater [1000, 3000];
Example 2:
_isWater = surfaceIsWater position player;

Additional Information

See also:
surfaceType surfaceNormalnearRoadsroadsConnectedToroadAtisOnRoad

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Posted on 4 May, 2012
Osmo
Does not work with inland water. Works only with sea water.
Posted on July 19, 2021 - 06:11 (UTC)
Leopard20
The above note is not true in Arma 3. The command does detect pond objects and will return true if there is a pond object at that position. However, the object must have been loaded in memory (normally only true if the object is within the object view distance)
Retrieved from "https://community.bistudio.com/wiki?title=surfaceIsWater&oldid=304761"