BIS fnc ambientBlacklist: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Ambient
____________________________________________________________________________________________


| <pre>/*
|gr2= Positions


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


Parameter(s):
|s1= [input] call [[BIS_fnc_ambientBlacklist]]
_this select 0: BIS_fnc_position compatible position - check if position is blacklisted
NUMBER - initialize blacklisted areas


Returns:
|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
BOOL - true when in blacklisted area
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
|r1= [[Boolean]] - returns [[Boolean]] when in blacklisted area, when initialization was triggered, it returns [[nil]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ambientBlacklist]]; --> |SYNTAX=
|x1= <sqf>[1337,1337,0] call BIS_fnc_ambientBlacklist;</sqf>


|p1= |PARAMETER1=
|x2= <sqf>[0] call BIS_fnc_ambientBlacklist;</sqf>
 
| |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |SEEALSO=


|seealso= [[BIS_fnc_ambientBlacklistAdd]]
}}
}}
<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: Ambient|{{uc:ambientBlacklist}}]]
[[Category:Functions|{{uc:ambientBlacklist}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:ambientBlacklist}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ambientBlacklist}}]]

Latest revision as of 16: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"