surfaceIsWater: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma1 |Game name= | | arma1 |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Positions |GROUP1= | |gr1= Positions |GROUP1= | ||
| Returns whether water is at given position. |DESCRIPTION= | | Returns whether water is at given position. |DESCRIPTION= | ||
|'''surfaceIsWater''' position |SYNTAX= | |'''surfaceIsWater''' position |SYNTAX= | ||
| Line 18: | Line 15: | ||
| [[Boolean]] |RETURNVALUE= | | [[Boolean]] |RETURNVALUE= | ||
|x1= <code>_isWater= [[surfaceIsWater]] [1000, 3000];</code>|EXAMPLE1= | |x1= <code>_isWater= [[surfaceIsWater]] [1000, 3000];</code>|EXAMPLE1= | ||
|x2= <code>_isWater = [[surfaceIsWater]] [[position]] [[player]];</code>|EXAMPLE2= | |x2= <code>_isWater = [[surfaceIsWater]] [[position]] [[player]];</code>|EXAMPLE2= | ||
| [[surfaceType]], [[surfaceNormal]], [[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[isOnRoad]] |SEEALSO= | | [[surfaceType]], [[surfaceNormal]], [[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[isOnRoad]] |SEEALSO= | ||
Revision as of 04:45, 17 January 2021
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
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
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Command Group: Positions
- Operation Flashpoint: Elite: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands