BIS fnc isPosBlacklisted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Function checks a blacklist and sees if the given position is in it or not. |= Description
/*
____________________________________________________________________________________________
File: isPosBlacklisted.sqf
 
Description:
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
| [position, blacklistArea] call [[BIS_fnc_isPosBlacklisted]] |= Syntax
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_isPosBlacklisted]]; --> |= Syntax
|p1= position: [[Position]] |= Parameter 1


|p1= |= Parameter 1
|p2= blacklistArea:
* [[Array]] of [[Position|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 |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code><nowiki>[</nowiki>[50,50], <nowiki>[</nowiki>[0,0], [100,100]]] [[call]] [[BIS_fnc_isPosBlacklisted]];</code> |= Example 1
 
|x2= <code><nowiki>[</nowiki>[[getPos]] [[player]], myTrigger] [[call]] [[BIS_fnc_isPosBlacklisted]];</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_inTrigger]], [[inArea]], [[distance2D]] |= See also
 
}}
}}



Revision as of 14:44, 24 May 2018

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:
Uncategorised

Syntax

Syntax:
[position, blacklistArea] call BIS_fnc_isPosBlacklisted
Parameters:
position: 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:
[getPos player, myTrigger] call BIS_fnc_isPosBlacklisted;

Additional Information

See also:
BIS_fnc_inTriggerinAreadistance2D

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

Notes

Bottom Section