findEmptyPositionReady: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "")
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
Line 17: Line 17:
|descr= 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>{{Feature | important | Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart}}
|descr= 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>{{Feature | important | Preloading large areas may take a long time, we are talking minutes. However once preloaded, it stays preloaded even after mission restart}}


|s1= center '''findEmptyPositionReady''' [radius, maxDistance]
|s1= 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]]
|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]]

Revision as of 22:04, 19 June 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