BIS fnc ambientBlacklist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |exec= call " to " ")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(11 intermediate revisions by the same user not shown)
Line 2: Line 2:


|game1= tkoh
|game1= tkoh
|version1= 1.00


|version1= 1.00
|game2= arma3
|version2= 0.50


|gr1 = Ambient
|gr1= Ambient


|gr2 = Positions
|gr2= Positions


|descr= Check if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.
|descr= Check if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.


||s1= [input] call [[BIS_fnc_ambientBlacklist]]|=Syntax
|s1= [input] call [[BIS_fnc_ambientBlacklist]]


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


|r1= [[Boolean]] - Returns [[Boolean]] when in blacklisted area, when initialization was triggered, it returns [[nil]]
|r1= [[Boolean]] - returns [[Boolean]] when in blacklisted area, when initialization was triggered, it returns [[nil]]


|x1= <code>[1337,1337,0] [[call]] [[BIS_fnc_ambientBlacklist]];</code>
|x1= <sqf>[1337,1337,0] call BIS_fnc_ambientBlacklist;</sqf>


|x2= <code>[0] [[call]] [[BIS_fnc_ambientBlacklist]];</code>
|x2= <sqf>[0] call BIS_fnc_ambientBlacklist;</sqf>


|seealso= [[BIS_fnc_ambientBlacklistAdd]]
|seealso= [[BIS_fnc_ambientBlacklistAdd]]
}}
}}
[[Category:{{Name|tkoh}}: Functions|{{uc:ambientBlacklist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ambientBlacklist}}]]

Latest revision as of 15:47, 8 November 2023

tkoh logo small.png1.00Arma 3 logo black.png0.50
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.
Execution:
call
Groups:
AmbientPositions

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 triggered, 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ambientBlacklist&oldid=349062"