BIS fnc EXP camp IFF: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (rollback)
(added image)
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.62


|1.62|Game version=
|gr1= Campaign


<!---|arg= local |Multiplayer Arguments=--->
|gr2= GUI


<!---|eff= local |Multiplayer Effects=--->
|arg= local


| <pre>/*
|eff= local
Author: Thomas Ryan


Description:
|descr= Simple handling of the Support Team's scripted IFF.</br>
Simple handling of the Support Team's scripted IFF.
Must be executed locally.


Notes:
[[File: BIS_fnc_EXP_camp_IFF.png|350px]]
- To always show the icon and name of a unit, use: <unit> setVariable ["BIS_iconAlways", true]
- Otherwise, icons can be hidden with: <unit> setVariable ["BIS_iconShow", false]
- And names can be hidden with: <unit> setVariable ["BIS_iconName", false]


Parameters:
{{Feature|informative|See {{Link|#Example 2}} for icon and name options.}}
_this: ARRAY - Array of Support Team units.


Returns:
|s1= [units] call [[BIS_fnc_EXP_camp_IFF]]
True if successfully initialized, false if not.
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_EXP_camp_IFF]]|Syntax=
|p1= units: [[Array]] - an array of units on which to apply IFF effect


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|r1= [[Boolean]] - [[true]] if successful, [[false]] if not


|Datatype - description|Return value=
|x1= <sqf>[units group player] call BIS_fnc_EXP_camp_IFF;</sqf>


|x1= <code></code>|Example 1=
|x2= <sqf>
individualUnit setVariable ["BIS_iconAlways", true]; // to always show the icon and name of a unit
individualUnit setVariable ["BIS_iconShow", false]; // to hide the icon
individualUnit setVariable ["BIS_iconName", false]; // to hide the name
</sqf>


|exec= call |Execution=
|seealso=
 
| |See also=
}}
}}
[[Category:Function Group: Campaign|{{uc:EXP_camp_IFF}}]]
[[Category:Functions|{{uc:EXP_camp_IFF}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:EXP_camp_IFF}}]]

Latest revision as of 15:09, 10 February 2024

Hover & click on the images for description

Description

Description:
Simple handling of the Support Team's scripted IFF.
BIS fnc EXP camp IFF.png
See Example 2 for icon and name options.
Execution:
call
Groups:
CampaignGUI

Syntax

Syntax:
[units] call BIS_fnc_EXP_camp_IFF
Parameters:
units: Array - an array of units on which to apply IFF effect
Return Value:
Boolean - true if successful, false if not

Examples

Example 1:
[units group player] call BIS_fnc_EXP_camp_IFF;
Example 2:
individualUnit setVariable ["BIS_iconAlways", true]; // to always show the icon and name of a unit individualUnit setVariable ["BIS_iconShow", false]; // to hide the icon individualUnit setVariable ["BIS_iconName", false]; // to hide the name

Additional Information

See also:
See also needed

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