BIS fnc randomPos: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \|(\[\[[a-zA-Z]+\]\].+) * \|x1=" to " |r1= $1 |x1=") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| | |game1= tkoh | ||
| | |version1= 1.00 | ||
| | |game2= arma3 | ||
| | |version2= 0.50 | ||
|gr1= Map and Markers | |gr1= Map and Markers | ||
| [whitelist, blacklist, code] call '''BIS_fnc_randomPos''' | |descr= Selects random position according to given params within given area | ||
|s1= [whitelist, blacklist, code] call '''BIS_fnc_randomPos''' | |||
|p1= [whitelist, blacklist, code]: [[Array]] | |p1= [whitelist, blacklist, code]: [[Array]] | ||
|p2=whitelist (Optional): [[Array]] - whitelisted areas. If not given, whole map is used. Areas could be: | |||
|p2= whitelist (Optional): [[Array]] - whitelisted areas. If not given, whole map is used. Areas could 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. | ||
|p3=blacklist (Optional): [[Array]] - blacklisted areas. If not given, water is blacklisted. Areas could be: | |||
|p3= blacklist (Optional): [[Array]] - blacklisted areas. If not given, water is blacklisted. Areas could 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. | ||
|p4= code (Optional): [[Code]] - 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 | |p4= code (Optional): [[Code]] - 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 | ||
| Line 28: | Line 32: | ||
|x1= <code>_randomPosMapNoWater = [] [[call]] [[BIS_fnc_randomPos]];</code> | |x1= <code>_randomPosMapNoWater = [] [[call]] [[BIS_fnc_randomPos]];</code> | ||
|x2= <code>_randomPosMapNoWater = [<nowiki/>[[nil]], ["water"]] [[call]] [[BIS_fnc_randomPos]];</code> | |x2= <code>_randomPosMapNoWater = [<nowiki/>[[nil]], ["water"]] [[call]] [[BIS_fnc_randomPos]];</code> | ||
|x3= <code>_randomPosMapNoLand = [<nowiki/>[[nil]], ["ground"]] [[call]] [[BIS_fnc_randomPos]];</code> | |x3= <code>_randomPosMapNoLand = [<nowiki/>[[nil]], ["ground"]] [[call]] [[BIS_fnc_randomPos]];</code> | ||
|x4= <code>_randomPosMap = [<nowiki/>[[nil]], []] [[call]] [[BIS_fnc_randomPos]];</code> | |x4= <code>_randomPosMap = [<nowiki/>[[nil]], []] [[call]] [[BIS_fnc_randomPos]];</code> | ||
|x5= <code>_randomPosAroundPlayer = <nowiki>[[[</nowiki>[[position]] [[player]], 50]],[]] [[call]] [[BIS_fnc_randomPos]];</code> | |x5= <code>_randomPosAroundPlayer = <nowiki>[[[</nowiki>[[position]] [[player]], 50]],[]] [[call]] [[BIS_fnc_randomPos]];</code> | ||
|seealso= [[BIS_fnc_randomPosTrigger]], [[BIS_fnc_getArea]], [[BIS_fnc_findSafePos]] | |seealso= [[BIS_fnc_randomPosTrigger]], [[BIS_fnc_getArea]], [[BIS_fnc_findSafePos]] | ||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
Revision as of 18:23, 10 June 2021
Description
- Description:
- Selects random position according to given params within given area
- Execution:
- call
- Groups:
- Map and Markers
Syntax
- Syntax:
- [whitelist, blacklist, code] call BIS_fnc_randomPos
- Parameters:
- [whitelist, blacklist, code]: Array
- whitelist (Optional): Array - whitelisted areas. If not given, whole map is used. Areas could be:
- blacklist (Optional): Array - blacklisted areas. If not given, water is blacklisted. Areas could be:
- code (Optional): Code - 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:
_randomPosMapNoWater = [] call BIS_fnc_randomPos;- Example 2:
_randomPosMapNoWater = [nil, ["water"]] call BIS_fnc_randomPos;- Example 3:
_randomPosMapNoLand = [nil, ["ground"]] call BIS_fnc_randomPos;- Example 4:
_randomPosMap = [nil, []] call BIS_fnc_randomPos;- Example 5:
_randomPosAroundPlayer = [[[position player, 50]],[]] call BIS_fnc_randomPos;
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 March 30, 2020 - 21:33 (UTC)
- Tankbuster
-
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.
randomRoadPosAroundPlayer = [[[position player,50]],[], {isOnRoad _this}] call BIS_fnc_randomPos;