BIS fnc ORBATRemoveGroupOverlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code> *([^<|{]*) *<\/code>" to "<sqf>$1</sqf>")
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(3 intermediate revisions by the same user not shown)
Line 8: Line 8:
|descr= Unregister texture(s) to be displayed over CfgORBAT group.
|descr= Unregister texture(s) to be displayed over CfgORBAT group.


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


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


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


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


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

Latest revision as of 17:27, 8 November 2023

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

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