BIS fnc isPosBlacklisted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
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...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1 = Positions |GROUP1=
|gr1 = Positions


| Function checks a blacklist and sees if the given position is in it or not. |DESCRIPTION=
| Function checks a blacklist and sees if the given position is in it or not.


| [position, blacklistArea] call [[BIS_fnc_isPosBlacklisted]] |SYNTAX=
| [position, blacklistArea] call [[BIS_fnc_isPosBlacklisted]]


|p1= position: [[Position]] |PARAMETER1=
|p1= position: [[Position]]


|p2= blacklistArea:
|p2= blacklistArea:
Line 17: Line 17:
* [[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]])


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


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


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


| [[BIS_fnc_inTrigger]], [[inArea]], [[distance2D]] |SEEALSO=
| [[BIS_fnc_inTrigger]], [[inArea]], [[distance2D]]
}}
}}



Revision as of 00:08, 18 January 2021

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


Bottom Section