surfaceIsWater: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "")
mNo edit summary
 
(21 intermediate revisions by 2 users not shown)
Line 21: Line 21:
|gr1= Positions
|gr1= Positions


|descr= Returns whether water is at given position.
|descr= 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 [[setObjectViewDistance|object view distance]])


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


|p1= position: [[Array]] - format [[Position2D]]  or [[Position3D]] in which case Z will be ignored
|p1= position: [[Array]] format [[Position#Introduction|Position2D]]  or [[Array]] format [[Position#Introduction|Position3D]] - when using [[Position#Introduction|Position3D]] Z will be ignored


|r1= [[Boolean]]
|r1= [[Boolean]]


|x1= <code>_isWater= [[surfaceIsWater]] [1000, 3000];</code>
|x1= <sqf>private _result = surfaceIsWater [1000, 3000];</sqf>


|x2= <code>_isWater = [[surfaceIsWater]] [[position]] [[player]];</code>
|x2= <sqf>_isWater = surfaceIsWater position player;</sqf>


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


Line 44: Line 44:
Does not work with inland water. Works only with sea water.
Does not work with inland water. Works only with sea water.


<dt></dt>
<dd class="notedate">Posted on 2021-07-19 - 06:11 (UTC)</dd>
<dt class="note">[[User:Leopard20|Leopard20]]</dt>
<dd class="note">
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)
</dd>
</dl>
</dl>

Latest revision as of 21:39, 28 September 2023

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 Array format Position3D - when using Position3D Z will be ignored
Return Value:
Boolean

Examples

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

Additional Information

See also:
surfaceType surfaceNormal nearRoads roadsConnectedTo roadAt isOnRoad

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 2021-07-19 - 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=347629"