BIS fnc ORBATSetGroupFade: Difference between revisions

Latest revision as of 17:27, 8 November 2023

1.00

Hover & click on the images for description

Description

Description:: Set fade value of CfgORBAT group and all groups below it.
Execution:: call
Groups:: Strategic

Syntax

Syntax:: [path, alpha, time] call BIS_fnc_ORBATSetGroupFade
Parameters:: path: Config - path to group in CfgORBAT. If only this parameter is passed, visibility settings for the group are removed.
: alpha: Number - alpha (0 = transparent, 1 = full color)
: time: time - commit time in seconds
Return Value:: Boolean

Examples

Example 1:: [configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade", 0.5, 5] call BIS_fnc_ORBATSetGroupFade;

Additional Information

See also:: ORBAT Viewer BIS_fnc_ORBATAddGroupOverlay BIS_fnc_ORBATAnimate BIS_fnc_ORBATConfigPreview BIS_fnc_ORBATGetGroupParams BIS_fnc_ORBATOpen BIS_fnc_ORBATRemoveGroupOverlay BIS_fnc_ORBATSetGroupParams BIS_fnc_ORBATTooltip

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Strategic
-|gr1 = Strategic |GROUP1=
+|descr= Set fade value of CfgORBAT group and all groups below it.
-____________________________________________________________________________________________
-| Set fade value of CfgORBAT group and all groups below it.|DESCRIPTION=
+|s1= [path, alpha, time] call [[BIS_fnc_ORBATSetGroupFade]]
-____________________________________________________________________________________________
-| [path, alpha, time] call [[BIS_fnc_ORBATSetGroupFade]] |SYNTAX=
+|p1= path: [[Config]] - path to group in CfgORBAT. If only this parameter is passed, visibility settings for the group are removed.
+|p2= alpha: [[Number]] - alpha (0 = transparent, 1 = full color)
+|p3= time: [[time]] - commit time in seconds
-|p1= path: [[Config]] - Path to group in CfgORBAT. If only this parameter is passed, visibility settings for the group are removed.|PARAMETER1=
+|r1= [[Boolean]]
-|p2= alpha: [[Number]] - Alpha (0 = transparent, 1 = full color) |PARAMETER2=
-|p3= time: [[time]] - Commit time in seconds|PARAMETER3=
-| [[Boolean]] |RETURNVALUE=
+|x1= <sqf>[configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade", 0.5, 5] call BIS_fnc_ORBATSetGroupFade;</sqf>
-____________________________________________________________________________________________
-|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade", 0.5, 5 ] [[call]] [[BIS_fnc_ORBATSetGroupFade]];</code> |=
+|seealso= [[ORBAT Viewer]] [[BIS_fnc_ORBATAddGroupOverlay]] [[BIS_fnc_ORBATAnimate]] [[BIS_fnc_ORBATConfigPreview]] [[BIS_fnc_ORBATGetGroupParams]] [[BIS_fnc_ORBATOpen]] [[BIS_fnc_ORBATRemoveGroupOverlay]] [[BIS_fnc_ORBATSetGroupParams]] [[BIS_fnc_ORBATTooltip]]
-______________
-| [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]] |SEEALSO=
 }}
-<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:Functions|{{uc:ORBATSetGroupFade}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:ORBATSetGroupFade}}]]