BIS fnc isPosBlacklisted: Difference between revisions

Latest revision as of 14:08, 13 July 2022

1.00

1.50

1.00

0.50

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:

Array of Positions - array to format [topLeft, bottomRight]
Object - a trigger. Check the trigger area (see inArea or BIS_fnc_inTrigger)

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma2
-____________________________________________________________________________________________
+|version1= 1.00
-| arma2 |= Game name
+|game2= arma2oa
+|version2= 1.50
-|1.00|= Game version
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| <pre>
+|game4= arma3
-/*
+|version4= 0.50
-	File: isPosBlacklisted.sqf
-	Description:
+|gr1= Positions
-	Function checks a blacklist and sees if the given position is on it or not.
-	Parameter(s):
-	_this select 0: position (Array)
-	_this select 1: blacklist (Array or Object/Trigger)
-	Returns:
-	Is the position blacklisted or not (Boolean)
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|descr= Function checks a blacklist and sees if the given position is in it or not.
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_isPosBlacklisted]]; --> |= Syntax
+|s1= [position, blacklistArea] call [[BIS_fnc_isPosBlacklisted]]
-|p1= |= Parameter 1
+|p1= position: [[Array]] format [[Position]]
-| |= Return value
+|p2= blacklistArea:
-____________________________________________________________________________________________
+* [[Array]] of [[Position]]s - array to format [topLeft, bottomRight]
+* [[Object]] - a trigger. Check the trigger area (see [[inArea]] or [[BIS_fnc_inTrigger]])
-|x1= <code></code> |=
+|r1= [[Boolean]] - is the position blacklisted or not
-____________________________________________________________________________________________
-| |= See also
+|x1= <sqf>[[50,50], [[0,0], [100,100]]] call BIS_fnc_isPosBlacklisted;</sqf>
+|x2= <sqf>[getPosATL player, myTrigger] call BIS_fnc_isPosBlacklisted;</sqf>
+|seealso= [[BIS_fnc_inTrigger]] [[inArea]] [[distance2D]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Misc|{{uc:isPosBlacklisted}}]]
-[[Category:Functions|{{uc:isPosBlacklisted}}]]
-[[Category:{{Name|arma2}}: Functions|{{uc:isPosBlacklisted}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:isPosBlacklisted}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:isPosBlacklisted}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:isPosBlacklisted}}]]