BIS fnc isPosBlacklisted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |s1=[" to " |s1= [")
m (Some wiki formatting)
 
(One intermediate revision by the same user not shown)
Line 19: Line 19:
|s1= [position, blacklistArea] call [[BIS_fnc_isPosBlacklisted]]
|s1= [position, blacklistArea] call [[BIS_fnc_isPosBlacklisted]]


|p1= position: [[Position]]
|p1= position: [[Array]] format [[Position]]


|p2= blacklistArea:
|p2= blacklistArea:
* [[Array]] of [[Position|Positions]] - array to format [topLeft, bottomRight]
* [[Array]] of [[Position]]s - array to format [topLeft, bottomRight]
* [[Object]] - a trigger. Check the trigger area (see [[inArea]] or [[BIS_fnc_inTrigger]])
* [[Object]] - a trigger. Check the trigger area (see [[inArea]] or [[BIS_fnc_inTrigger]])


|r1= [[Boolean]] - is the position blacklisted or not
|r1= [[Boolean]] - is the position blacklisted or not


|x1= <code><nowiki>[</nowiki>[50,50], [<nowiki/>[0,0], [100,100]]] [[call]] [[BIS_fnc_isPosBlacklisted]];</code>
|x1= <sqf>[[50,50], [[0,0], [100,100]]] call BIS_fnc_isPosBlacklisted;</sqf>


|x2= <code><nowiki>[</nowiki>[[getPos]] [[player]], myTrigger] [[call]] [[BIS_fnc_isPosBlacklisted]];</code>
|x2= <sqf>[getPosATL player, myTrigger] call BIS_fnc_isPosBlacklisted;</sqf>


|seealso= [[BIS_fnc_inTrigger]] [[inArea]] [[distance2D]]
|seealso= [[BIS_fnc_inTrigger]] [[inArea]] [[distance2D]]
}}
}}

Latest revision as of 14:08, 13 July 2022

Hover & click on the images for description

Description

Description:
Function checks a blacklist and sees if the given position is in it or not.
Execution:
call
Groups:
Positions

Syntax

Syntax:
[position, blacklistArea] call BIS_fnc_isPosBlacklisted
Parameters:
position: Array format Position
blacklistArea:
Return Value:
Boolean - is the position blacklisted or not

Examples

Example 1:
[[50,50], [[0,0], [100,100]]] call BIS_fnc_isPosBlacklisted;
Example 2:
[getPosATL player, myTrigger] call BIS_fnc_isPosBlacklisted;

Additional Information

See also:
BIS_fnc_inTrigger inArea distance2D

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