surfaceIsWater: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Positions |GROUP1=
|gr1= Positions


| Returns whether water is at given position. |DESCRIPTION=
| Returns whether water is at given position.


|'''surfaceIsWater''' position |SYNTAX=
|'''surfaceIsWater''' position


|p1= position: [[Array]] - format [[Position2D]]  or [[Position3D]] in which case Z will be ignored |PARAMETER1=
|p1= position: [[Array]] - format [[Position2D]]  or [[Position3D]] in which case Z will be ignored


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]




|x1= <code>_isWater= [[surfaceIsWater]] [1000, 3000];</code>|EXAMPLE1=
|x1= <code>_isWater= [[surfaceIsWater]] [1000, 3000];</code>


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


| [[surfaceType]], [[surfaceNormal]], [[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[isOnRoad]] |SEEALSO=
| [[surfaceType]], [[surfaceNormal]], [[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[isOnRoad]]


}}
}}

Revision as of 11:26, 18 January 2021

Logo A1 black.png1.00
Hover & click on the images for description

Description

Description:
Returns whether water is at given position.
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

Notes

Posted on 4 May, 2012
Osmo
Does not work with inland water. Works only with sea water.

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=surfaceIsWater&oldid=211012"