surfaceIsWater: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ")
No edit summary
Line 21: Line 21:
|gr1= Positions
|gr1= Positions


|descr= Returns whether water is at given position.
|descr= Returns whether water is at given position. In Arma 3, it also detects the pond objects, but only if the object is loaded in memory (normally only true if it's in visual range)


|s1= [[surfaceIsWater]] position
|s1= [[surfaceIsWater]] position

Revision as of 08:08, 19 July 2021

Hover & click on the images for description

Description

Description:
Returns whether water is at given position. In Arma 3, it also detects the pond objects, but only if the object is loaded in memory (normally only true if it's in visual range)
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:
surfaceTypesurfaceNormalnearRoadsroadsConnectedToroadAtisOnRoad

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.