findEmptyPositionReady: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
m (Some wiki formatting)
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50


|gr1= Positions
|game3= tkoh
|version3= 1.00


| Preloads area to be used with [[findEmptyPosition]] command and returns [[true]] when area is ready. The size of the area preloaded is from <tt>center - radius - maxDistance</tt> to <tt>center + radius + maxDistance</tt><br><br>
|game4= arma3
{{Important | Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart}}
|version4= 0.50


| center '''findEmptyPositionReady''' [radius, maxDistance]
|gr1= Positions
 
|p1= center: [[Array]] - Search area center position in format [x,y] or [x,y,z] in which case z is ignored. Accepts [[Position2D]] or [[Position3D]]


|p2= [radius, maxDistance]: [[Array]] -
|descr= Preloads area to be used with [[findEmptyPosition]] command and returns [[true]] when area is ready.
The size of the area preloaded is from {{hl|center - radius - maxDistance}} to {{hl|center + radius + maxDistance}}
{{Feature|important|Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart.}}


|p3= radius: [[Number]] - distance from the center
|s1= center [[findEmptyPositionReady]] [radius, maxDistance]
|p4= maxDistance: [[Number]] - distance from the end of radius


| [[Boolean]] - [[true]] when ready
|p1= center: [[Array]] format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - search area center position in format [x,y] or [x,y,z] in which case z is ignored


|p2= radius: [[Number]] - distance from the center


|x1= Preload aread within 500m: <code>_ready = _center [[findEmptyPositionReady]] [0, 500];</code>
|p3= maxDistance: [[Number]] - distance from the end of radius


|r1= [[Boolean]] - [[true]] when ready


| [[findEmptyPosition]]
|x1= Preload aread within 500m:
<sqf>_ready = _center findEmptyPositionReady [0, 500];</sqf>


| |MPBEHAVIOUR=  
|seealso= [[findEmptyPosition]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:02, 15 August 2022

Logo 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:
Preloads area to be used with findEmptyPosition command and returns true when area is ready. The size of the area preloaded is from center - radius - maxDistance to center + radius + maxDistance
⚠
Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart.
Groups:
Positions

Syntax

Syntax:
center findEmptyPositionReady [radius, maxDistance]
Parameters:
center: Array format Position2D or Position3D - search area center position in format [x,y] or [x,y,z] in which case z is ignored
radius: Number - distance from the center
maxDistance: Number - distance from the end of radius
Return Value:
Boolean - true when ready

Examples

Example 1:
Preload aread within 500m:
_ready = _center findEmptyPositionReady [0, 500];

Additional Information

See also:
findEmptyPosition

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
Retrieved from "https://community.bistudio.com/wiki?title=findEmptyPositionReady&oldid=330049"