BIS fnc ORBATAddGroupOverlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Register texture(s) to be displayed over CfgORBAT group. |= Description
 
Description:
Register texture(s) to be displayed over CfgORBAT group.
 
Parameter(s):
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:
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
| [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] |= Syntax


|p1= |= Parameter 1
|p1= target: [[Config]] - Path to group in CfgORBAT|= Parameter 1
|p2= texture: [[String]] - Texture|= Parameter 2
|p3= colour: [[Array]] - Colour in format [R,G,B,A]|= Parameter 3
|p4= widthMulti: [[Number]] - Original icon width multiplier|= Parameter 4
|p5= heightMulti: [[Number]] - Original icon height multiplier|= Parameter 5
|p6= angle: [[Number]] - Angle|= Parameter 6
|p7= text: [[String]] - Text|= Parameter 7
|p8= shadow: [[Boolean]] - Shadow outlining the texture|= Parameter 8


| |= Return value
____________________________________________________________________________________________


|x1= <code></code> |=  
| [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]|= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|x1= <code>[ [[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]];</code> |=
______________


| [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]] |= See also
}}
}}
<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">

Revision as of 02:41, 27 May 2018

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

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ORBATAddGroupOverlay&oldid=107554"