BIS fnc ORBATRemoveGroupOverlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Strategic


|1.00|= Game version
|descr= Unregister texture(s) to be displayed over CfgORBAT group.
____________________________________________________________________________________________


| <pre>/*
|s1= [path, number] call [[BIS_fnc_ORBATRemoveGroupOverlay]]


Description:
|p1= path: [[Config]] - path to group in CfgORBAT. [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade"
Unregister texture(s) to be displayed over CfgORBAT group.
|p2= number: [[Display]] - overlay ID returned by [[BIS_fnc_ORBATAddGroupOverlay]]


Parameter(s):
|r1= [[Boolean]]  - [[true]] if overlay entry was removed
0: CONFIG - path to group in CfgORBAT.
1: NUMBER - overlay ID returned by BIS_fnc_ORBATAddGroupOverlay


Returns:
|x1= <sqf>[configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade", 4] call BIS_fnc_ORBATRemoveGroupOverlay;</sqf>
BOOL - true if overlay entry no longer exists
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_ORBATRemoveGroupOverlay]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|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]]
}}
}}
<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: Strategic|{{uc:ORBATRemoveGroupOverlay}}]]
[[Category:Functions|{{uc:ORBATRemoveGroupOverlay}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ORBATRemoveGroupOverlay}}]]

Latest revision as of 17:27, 8 November 2023

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ORBATRemoveGroupOverlay&oldid=349426"