BIS fnc ORBATAddGroupOverlay: 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")
 
(46 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= Register texture(s) to be displayed over CfgORBAT group.
____________________________________________________________________________________________


| <pre>/*
|s1= [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]]


Description:
|p1= target: [[Config]] - path to group in CfgORBAT
Register texture(s) to be displayed over CfgORBAT group.
|p2= texture: [[String]] - texture
|p3= colour: [[Array]] - colour in format [R,G,B,A]
|p4= widthMulti: [[Number]] - original icon width multiplier
|p5= heightMulti: [[Number]] - original icon height multiplier
|p6= angle: [[Number]] - angle
|p7= text: [[String]] - text
|p8= shadow: [[Boolean]] - shadow outlining the texture


Parameter(s):
|r1= [[Number]] - overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]
0: CONFIG - path to group in CfgORBAT.
1: STRING - texture
2: ARRAY - color in format [R,G,B,A]
3: NUMBER - original icon width multiplier
4: NUMBER - original icon height multiplier
5: NUMBER - angle
6: STRING - text
7: BOOL - shadow


Returns:
|x1= <sqf>[configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_1", "\A3\weapons_f\data\UI\icon_MG_CA.paa", [0,0,01], 3, 3, 0, "Some Text", true] call BIS_fnc_ORBATAddGroupOverlay;</sqf>
NUMBER - overlay ID (used by BIS_fnc_ORBATRemoveGroupOverlay)
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_ORBATAddGroupOverlay]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[ORBAT Viewer]] [[BIS_fnc_ORBATAnimate]] [[BIS_fnc_ORBATConfigPreview]] [[BIS_fnc_ORBATGetGroupParams]] [[BIS_fnc_ORBATOpen]] [[BIS_fnc_ORBATRemoveGroupOverlay]] [[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:ORBATAddGroupOverlay}}]]
[[Category:Functions|{{uc:ORBATAddGroupOverlay}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ORBATAddGroupOverlay}}]]

Latest revision as of 17:27, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

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

Syntax

Syntax:
[target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call BIS_fnc_ORBATAddGroupOverlay
Parameters:
target: Config - path to group in CfgORBAT
texture: String - texture
colour: Array - colour in format [R,G,B,A]
widthMulti: Number - original icon width multiplier
heightMulti: Number - original icon height multiplier
angle: Number - angle
text: String - text
shadow: Boolean - shadow outlining the texture
Return Value:
Number - overlay ID, used by BIS_fnc_ORBATRemoveGroupOverlay

Examples

Example 1:
[configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_1", "\A3\weapons_f\data\UI\icon_MG_CA.paa", [0,0,01], 3, 3, 0, "Some Text", true] call BIS_fnc_ORBATAddGroupOverlay;

Additional Information

See also:
ORBAT Viewer BIS_fnc_ORBATAnimate BIS_fnc_ORBATConfigPreview BIS_fnc_ORBATGetGroupParams BIS_fnc_ORBATOpen BIS_fnc_ORBATRemoveGroupOverlay 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_ORBATAddGroupOverlay&oldid=349398"