BIS fnc ORBATAddGroupOverlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Strategic(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Strategic |GROUP1=
|gr1 = Strategic |GROUP1=
____________________________________________________________________________________________


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


| [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] |SYNTAX=
| [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] |SYNTAX=
Line 25: Line 22:


| [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]|RETURNVALUE=
| [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]|RETURNVALUE=
____________________________________________________________________________________________


|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> |=
|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_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]] |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]] |SEEALSO=

Revision as of 23:33, 16 January 2021

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