findEmptyPositionReady: 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|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Positions |GROUP1=
|gr1= Positions


| 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>
| 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>
{{Important | Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart}} |DESCRIPTION=
{{Important | Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart}}


| center '''findEmptyPositionReady''' [radius, maxDistance] |SYNTAX=
| center '''findEmptyPositionReady''' [radius, maxDistance]


|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]] |PARAMETER1=
|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]] - |PARAMETER2=
|p2= [radius, maxDistance]: [[Array]] -


|p3= radius: [[Number]] - distance from the center |PARAMETER3=
|p3= radius: [[Number]] - distance from the center
|p4= maxDistance: [[Number]] - distance from the end of radius |PARAMETER4=
|p4= maxDistance: [[Number]] - distance from the end of radius


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




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




| [[findEmptyPosition]] |SEEALSO=
| [[findEmptyPosition]]


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  

Revision as of 00:33, 18 January 2021

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 - Search area center position in format [x,y] or [x,y,z] in which case z is ignored. Accepts Position2D or Position3D
[radius, maxDistance]: Array -
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

Notes

Bottom Section