BIS fnc ORBATRemoveGroupOverlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= * " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Strategic |GROUP1=
|gr1 = Strategic


| Unregister texture(s) to be displayed over CfgORBAT group.|DESCRIPTION=
| Unregister texture(s) to be displayed over CfgORBAT group.


| [path, number] call [[BIS_fnc_ORBATRemoveGroupOverlay]] |SYNTAX=
| [path, number] call [[BIS_fnc_ORBATRemoveGroupOverlay]]


|p1= path: [[Config]] - Path to group in CfgORBAT. [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade"|PARAMETER1=
|p1= path: [[Config]] - Path to group in CfgORBAT. [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade"
|p2= number: [[Display]] - Overlay ID returned by [[BIS_fnc_ORBATAddGroupOverlay]] |PARAMETER2=
|p2= number: [[Display]] - Overlay ID returned by [[BIS_fnc_ORBATAddGroupOverlay]]




| [[Boolean]]  - [[true|True]] if overlay entry was removed |RETURNVALUE=
| [[Boolean]]  - [[true|True]] if overlay entry was removed


|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade", 4 ] [[call]] [[BIS_fnc_ORBATRemoveGroupOverlay]];</code>
|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade", 4 ] [[call]] [[BIS_fnc_ORBATRemoveGroupOverlay]];</code>


| [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]] |SEEALSO=
| [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]]
}}
}}



Revision as of 22:18, 17 January 2021

Hover & click on the images for description

Description

Description:
Unregister texture(s) to be displayed over CfgORBAT group.
Execution:
call
Groups:
Strategic

Syntax

Syntax:
[path, number] call BIS_fnc_ORBATRemoveGroupOverlay
Parameters:
path: Config - Path to group in CfgORBAT. configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade"
number: Display - Overlay ID returned by BIS_fnc_ORBATAddGroupOverlay
Return Value:
Boolean - True if overlay entry was removed

Examples

Example 1:
[ configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade", 4 ] call BIS_fnc_ORBATRemoveGroupOverlay;

Additional Information

See also:
ORBAT ViewerBIS_fnc_ORBATAddGroupOverlayBIS_fnc_ORBATAnimateBIS_fnc_ORBATConfigPreviewBIS_fnc_ORBATGetGroupParamsBIS_fnc_ORBATOpenBIS_fnc_ORBATSetGroupFadeBIS_fnc_ORBATSetGroupParamsBIS_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


Bottom Section