BIS fnc randomPos: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
Lou Montana (talk | contribs) m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)") |
||
(27 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=function | ||
| | |game1= tkoh | ||
| | |version1= 1.00 | ||
| | |game2= arma3 | ||
| | |version2= 0.50 | ||
|gr1 = | |gr1= Positions | ||
| | |descr= Selects random position according to given params within given area | ||
|s1= [whitelist, blacklist, code] call [[BIS_fnc_randomPos]] | |||
|p1 | |p1= whitelist: [[Array]] - whitelisted areas. If not given, whole map is used. Areas can be: | ||
* [[Object]] - trigger | * [[Object]] - trigger | ||
* [[String]] - marker | * [[String]] - marker | ||
* [[Array]] - in format [center, radius] or [center, [a, b, angle, rect]] | * [[Array]] - in format [center, radius] or [center, [a, b, angle, rect]] | ||
* [[Location]] - location | * [[Location]] - location | ||
| | |||
|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 | ||
* [[Array]] - in format [center, radius] or [center, [a, b, angle, rect]] | * [[Array]] - in format [center, radius] or [center, [a, b, angle, rect]] | ||
* [[Location]] - location | * [[Location]] - location | ||
|[[ | |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 | ||
|x1= <sqf>private _randomPosMapNoWater = [] call BIS_fnc_randomPos;</sqf> | |||
| [ | |x2= <sqf>private _randomPosMapNoWater = [nil, ["water"]] call BIS_fnc_randomPos;</sqf> | ||
|x3= <sqf>private _randomPosMapNoLand = [nil, ["ground"]] call BIS_fnc_randomPos;</sqf> | |||
< | |x4= <sqf>private _randomPosMap = [nil, []] call BIS_fnc_randomPos;</sqf> | ||
|x5= <sqf>private _randomPosAroundPlayer = [[[position player, 50]], []] call BIS_fnc_randomPos;</sqf> | |||
|seealso= [[BIS_fnc_randomPosTrigger]] [[BIS_fnc_getArea]] [[BIS_fnc_findSafePos]] | |||
}} | |||
{{Note | |||
|user= Tankbuster | |||
|timestamp= 20200330213300 | |||
|text= The code parameter here can be quite powerful. | |||
If using {{Link|#Example 5}} above, adding code as below will make the returned positions always be on a road. | |||
<sqf>private _randomRoadPosAroundPlayer = [[[position player, 50]], [], { isOnRoad _this }] call BIS_fnc_randomPos;</sqf> | |||
}} | |||
The code parameter here can be quite powerful. | |||
If using | |||
< | |||
Latest revision as of 18:09, 8 November 2023
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:
- 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:
- Example 2:
- Example 3:
- Example 4:
- Example 5:
Additional Information
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
- 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.