findEmptyPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. classification)
(Fix description)
 
(71 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Search for the position nearest (up to maxDistance) to the center,with,the free area (vehicle of the given type can be placed anywhere) of the,given radius. When not found,empty array is returned.  |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| center '''findEmptyPosition''' [radius,maxDistance] or [radius,maxDistance,vehicleType] |= Syntax
|game4= arma3
|version4= 0.50


|p1= center: [[Array]] -  |= PARAMETER1
|gr1= Positions


|p2= [radius,maxDistance,vehicleType]: Array -  |= PARAMETER2
|descr= Searches for an empty area around the specified position, starting from the ''center'' looking for an empty ''areaRadius'' and looks as far away as ''areaRadius'' + ''maxDistance''.
This command ignores moving objects present within the search area. The search area can be preloaded with [[findEmptyPositionReady]] command.


|p3= |= PARAMETER3
{{Feature|informative|
This command does not work outside of [[worldSize|world dimensions]] and will always return the provided ''center''.
Objects outside the world dimensions will not be considered in the detection either.
}}
 
|s1= center [[findEmptyPosition]] [areaRadius, maxDistance, vehicleType]
 
|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


| [[Array]] |= RETURNVALUE
|p2= areaRadius: [[Number]] - wanted area radius


|p3= maxDistance: [[Number]] - stop searching no further than {{hl|areaRadius + maxDistance}} from the center


|x1= <code>(example)</code>|= EXAMPLE1
|p4= vehicleType: [[String]] - (Optional) classname of a vehicle to accommodate


____________________________________________________________________________________________
|r1= [[Array]] - a suitable empty position in format [[Position#Introduction|Position3D]] or empty array <sqf inline>[]</sqf> if not found


| |= SEEALSO
|x1= <sqf>_position = getPosASL player findEmptyPosition [0, 100];</sqf>


| |= MPBEHAVIOUR
|x2= <sqf>_position = _center findEmptyPosition [10,100,"UH60M_EP1"];</sqf>
____________________________________________________________________________________________
 
|x3= Check if exact position is empty:
<sqf>_position = _center findEmptyPosition [0, 0, "B_Boat_Armed_01_minigun_F"];</sqf>
 
|seealso= [[findEmptyPositionReady]] [[selectBestPlaces]] [[isFlatEmpty]] [[BIS_fnc_findSafePos]]
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Killzone_Kid
<!-- Note Section BEGIN -->
|timestamp= 20131106181000
|text= Keep search radius short and sweet, under 50 metres maybe. Searching big area takes long time and will result in your game stop responding until the search is over. [[isFlatEmpty]] is probably more suitable for a larger area search.
}}


<!-- Note Section END -->
{{Note
</dl>
|user= old_man_auz
|timestamp= 20120306005000
|text= I think the '''radius''' parameter should be treated as a 'minimum distance' from the '''centre''' position. I found that the parameter name '''radius''' was not very clear. Also, if '''radius''' is greater than '''max distance''' then the function will always return an empty array.


<h3 style='display:none'>Bottom Section</h3>
Here is an snippet of code I use to find a safe landing zone for an extraction helicopter. It may be useful for someone.
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
<sqf>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
_centre = [getMarkerPos "marker", random 150, random 360] call BIS_fnc_relPos;
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
_extraction_point = [];
_max_distance = 100;
while { count _extraction_point < 1 } do
{
_extraction_point = _centre findEmptyPosition [30, _max_distance, "UH60M_EP1"];
_max_distance = _max_distance + 50;
};
</sqf>
In the above example, make sure that "_max_distance" is greater than 30, otherwise the while loop will go forever.
}}

Latest revision as of 23:21, 20 December 2022

Hover & click on the images for description

Description

Description:
Searches for an empty area around the specified position, starting from the center looking for an empty areaRadius and looks as far away as areaRadius + maxDistance. This command ignores moving objects present within the search area. The search area can be preloaded with findEmptyPositionReady command.
This command does not work outside of world dimensions and will always return the provided center. Objects outside the world dimensions will not be considered in the detection either.
Groups:
Positions

Syntax

Syntax:
center findEmptyPosition [areaRadius, maxDistance, vehicleType]
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
areaRadius: Number - wanted area radius
maxDistance: Number - stop searching no further than areaRadius + maxDistance from the center
vehicleType: String - (Optional) classname of a vehicle to accommodate
Return Value:
Array - a suitable empty position in format Position3D or empty array [] if not found

Examples

Example 1:
_position = getPosASL player findEmptyPosition [0, 100];
Example 2:
_position = _center findEmptyPosition [10,100,"UH60M_EP1"];
Example 3:
Check if exact position is empty:
_position = _center findEmptyPosition [0, 0, "B_Boat_Armed_01_minigun_F"];

Additional Information

See also:
findEmptyPositionReady selectBestPlaces isFlatEmpty BIS_fnc_findSafePos

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
Killzone_Kid - c
Posted on Nov 06, 2013 - 18:10 (UTC)
Keep search radius short and sweet, under 50 metres maybe. Searching big area takes long time and will result in your game stop responding until the search is over. isFlatEmpty is probably more suitable for a larger area search.
old_man_auz - c
Posted on Mar 06, 2012 - 00:50 (UTC)
I think the radius parameter should be treated as a 'minimum distance' from the centre position. I found that the parameter name radius was not very clear. Also, if radius is greater than max distance then the function will always return an empty array. Here is an snippet of code I use to find a safe landing zone for an extraction helicopter. It may be useful for someone.
_centre = [getMarkerPos "marker", random 150, random 360] call BIS_fnc_relPos; _extraction_point = []; _max_distance = 100; while { count _extraction_point < 1 } do { _extraction_point = _centre findEmptyPosition [30, _max_distance, "UH60M_EP1"]; _max_distance = _max_distance + 50; };
In the above example, make sure that "_max_distance" is greater than 30, otherwise the while loop will go forever.