surfaceIsWater: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
BrettMayson (talk | contribs) mNo edit summary |
||
| (56 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |game1= ofpe | ||
|version1= 1.00 | |||
|1.00 | |game2= arma1 | ||
|version2= 1.00 | |||
| | |game3= arma2 | ||
|version3= 1.00 | |||
| | |game4= arma2oa | ||
|version4= 1.50 | |||
| | |game5= tkoh | ||
|version5= 1.00 | |||
| | |game6= arma3 | ||
|version6= 0.50 | |||
|gr1= Positions | |||
| | |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 | ||
| [[ | |p1= position: [[Array]] format [[Position#Introduction|Position2D]] or [[Array]] format [[Position#Introduction|Position3D]] - when using [[Position#Introduction|Position3D]] Z will be ignored | ||
|r1= [[Boolean]] | |||
|x1= <sqf>private _result = surfaceIsWater [1000, 3000];</sqf> | |||
|x2= <sqf>_isWater = surfaceIsWater position player;</sqf> | |||
|seealso= [[surfaceType]] [[surfaceNormal]] [[nearRoads]] [[roadsConnectedTo]] [[roadAt]] [[isOnRoad]] | |||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
< | |||
<dd class="notedate">Posted on 4 May, 2012 | <dt></dt> | ||
<dt class="note"> | <dd class="notedate">Posted on 4 May, 2012</dd> | ||
<dt class="note">[[User:Osmo|Osmo]]</dt> | |||
<dd class="note"> | |||
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
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:
- Example 2:
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
- 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)
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint: Elite version 1.00
- Operation Flashpoint: Elite: New Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Positions