BIS fnc ambientBlacklist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
m (filled page)
Line 1: Line 1:
{{Function|Comments=
{{Function
____________________________________________________________________________________________


| tkoh |Game name=
|game1= tkoh


|1.00|Game version=
|version1= 1.00
____________________________________________________________________________________________


| <pre>/*
<!--|exec= server|=-->


Description:
<!--|arg= local-->
Check if area is blacklisted.
Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.


Parameter(s):
<!--|eff= local-->
_this select 0: BIS_fnc_position compatible position - check if position is blacklisted
NUMBER - initialize blacklisted areas


Returns:
|descr= Check if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99. {{Feature arma3|Function is broken}}
BOOL - true when in blacklisted area
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ambientBlacklist]]; --> |SYNTAX=
||s1= [input] call [[BIS_fnc_ambientBlacklist]]|=Syntax


|p1= |PARAMETER1=
|p1= input: [[Array]] - If array, function checks if givin position is in blacklisted areas. If any [[Number]] is passed to the function instead of an [[Array]] blacklisted areas are initialized and saved in BIS_ambientBlacklist


| |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code></code> |EXAMPLE1=
|r1= [[Boolean]] - Returns [[Boolean]] when in blacklisted area, when initialization was triggred, it returns [[nil]]
____________________________________________________________________________________________


| |SEEALSO=
|x1= <code>[1337,1337,0] [[call]] [[BIS_fnc_ambientBlacklist]];</code>
 
|x2= <code>[0] [[call]] [[BIS_fnc_ambientBlacklist]];</code>
 
|exec= call
 
|seealso= [[BIS_fnc_ambientBlacklistAdd]]


}}
}}

Revision as of 18:59, 8 January 2020

tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
Check if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.
Arma 3
Function is broken
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[input] call BIS_fnc_ambientBlacklist
Parameters:
input: Array - If array, function checks if givin position is in blacklisted areas. If any Number is passed to the function instead of an Array blacklisted areas are initialized and saved in BIS_ambientBlacklist
Return Value:
Boolean - Returns Boolean when in blacklisted area, when initialization was triggred, it returns nil

Examples

Example 1:
[1337,1337,0] call BIS_fnc_ambientBlacklist;
Example 2:
[0] call BIS_fnc_ambientBlacklist;

Additional Information

See also:
BIS_fnc_ambientBlacklistAdd

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientBlacklist&oldid=146281"