BIS fnc randomPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>\[\[private\]\] (_?[a-zA-Z0-9_]+) = \[([^\[]*)\] \[\[(call|spawn)\]\] \[\[(BI(N|S)_fnc_[a-zA-Z0-9_]+)\]\];?<\/code>" to "<sqf>private $1 = [$2] $3 $4;</sqf>")
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(4 intermediate revisions by 2 users not shown)
Line 7: Line 7:
|version2= 0.50
|version2= 0.50


|gr1= Map and Markers
|gr1= Positions


|descr= Selects random position according to given params within given area
|descr= Selects random position according to given params within given area
Line 19: Line 19:
* [[Location]] - location
* [[Location]] - location


|p2= blacklist: [[Array]] - (Optional, default []) blacklisted areas. If not given, water is blacklisted. Areas can be:
|p2= blacklist: [[Array]] - (Optional, default <sqf inline>[]</sqf>) blacklisted areas. If not given, water is blacklisted. Areas can be:
* [[Object]] - trigger
* [[Object]] - trigger
* [[String]] - marker name or special tags names: "water" - exclude water, "ground" - exclude land
* [[String]] - marker name or special tags names: "water" - exclude water, "ground" - exclude land
Line 25: Line 25:
* [[Location]] - location
* [[Location]] - location


|p3= code: [[Code]] - (Optional, default {{ic|{ [[true]] }<nowiki/>}}) custom condition which should return true for current position candidate passed in [[Magic Variables#this|_this]] variable to be accepted. If not specified all candidates are accepted
|p3= code: [[Code]] - (Optional, default <sqf inline>{ true }</sqf>) custom condition which should return true for current position candidate passed in [[Magic Variables#this|_this]] variable to be accepted. If not specified all candidates are accepted


|r1= [[Array]] - position candidate in format [x,y,z] or [0,0] if position cannot be found
|r1= [[Array]] - position candidate in format [x,y,z] or [0,0] if position cannot be found
Line 31: Line 31:
|x1= <sqf>private _randomPosMapNoWater = [] call BIS_fnc_randomPos;</sqf>
|x1= <sqf>private _randomPosMapNoWater = [] call BIS_fnc_randomPos;</sqf>


|x2= <code>[[private]] _randomPosMapNoWater = [<nowiki/>[[nil]], ["water"]] [[call]] [[BIS_fnc_randomPos]];</code>
|x2= <sqf>private _randomPosMapNoWater = [nil, ["water"]] call BIS_fnc_randomPos;</sqf>


|x3= <code>[[private]] _randomPosMapNoLand = [<nowiki/>[[nil]], ["ground"]] [[call]] [[BIS_fnc_randomPos]];</code>
|x3= <sqf>private _randomPosMapNoLand = [nil, ["ground"]] call BIS_fnc_randomPos;</sqf>


|x4= <code>[[private]] _randomPosMap = [<nowiki/>[[nil]], []] [[call]] [[BIS_fnc_randomPos]];</code>
|x4= <sqf>private _randomPosMap = [nil, []] call BIS_fnc_randomPos;</sqf>


|x5= <code>[[private]] _randomPosAroundPlayer = <nowiki>[[[</nowiki>[[position]] [[player]], 50]], []] [[call]] [[BIS_fnc_randomPos]];</code>
|x5= <sqf>private _randomPosAroundPlayer = [[[position player, 50]], []] call BIS_fnc_randomPos;</sqf>


|seealso= [[BIS_fnc_randomPosTrigger]] [[BIS_fnc_getArea]] [[BIS_fnc_findSafePos]]
|seealso= [[BIS_fnc_randomPosTrigger]] [[BIS_fnc_getArea]] [[BIS_fnc_findSafePos]]
Line 46: Line 46:
|timestamp= 20200330213300
|timestamp= 20200330213300
|text= The code parameter here can be quite powerful.
|text= The code parameter here can be quite powerful.
If using {{HashLink|#Example 5}} above, adding code as below will make the returned positions always be on a road.
If using {{Link|#Example 5}} above, adding code as below will make the returned positions always be on a road.
<code>[[private]] _randomRoadPosAroundPlayer = <nowiki>[[[</nowiki>[[position]] [[player]], 50]], [], { [[isOnRoad]] _this }] [[call]] [[BIS_fnc_randomPos]];</code>
<sqf>private _randomRoadPosAroundPlayer = [[[position player, 50]], [], { isOnRoad _this }] call BIS_fnc_randomPos;</sqf>
}}
}}

Latest revision as of 19:09, 8 November 2023

tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Selects random position according to given params within given area
Execution:
call
Groups:
Positions

Syntax

Syntax:
[whitelist, blacklist, code] call BIS_fnc_randomPos
Parameters:
whitelist: Array - whitelisted areas. If not given, whole map is used. Areas can be:
blacklist: Array - (Optional, default []) blacklisted areas. If not given, water is blacklisted. Areas can be:
  • Object - trigger
  • String - marker name or special tags names: "water" - exclude water, "ground" - exclude land
  • Array - in format [center, radius] or [center, [a, b, angle, rect]]
  • Location - location
code: Code - (Optional, default { true }) custom condition which should return true for current position candidate passed in _this variable to be accepted. If not specified all candidates are accepted
Return Value:
Array - position candidate in format [x,y,z] or [0,0] if position cannot be found

Examples

Example 1:
private _randomPosMapNoWater = [] call BIS_fnc_randomPos;
Example 2:
private _randomPosMapNoWater = [nil, ["water"]] call BIS_fnc_randomPos;
Example 3:
private _randomPosMapNoLand = [nil, ["ground"]] call BIS_fnc_randomPos;
Example 4:
private _randomPosMap = [nil, []] call BIS_fnc_randomPos;
Example 5:
private _randomPosAroundPlayer = [[[position player, 50]], []] call BIS_fnc_randomPos;

Additional Information

See also:
BIS_fnc_randomPosTrigger BIS_fnc_getArea 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
Tankbuster - c
Posted on Mar 30, 2020 - 21:33 (UTC)
The code parameter here can be quite powerful. If using Example 5 above, adding code as below will make the returned positions always be on a road.
private _randomRoadPosAroundPlayer = [[[position player, 50]], [], { isOnRoad _this }] call BIS_fnc_randomPos;
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_randomPos&oldid=349485"