BIS fnc ORBATAddGroupOverlay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Strategic
____________________________________________________________________________________________


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


| [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] |SYNTAX=
|s1= [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]]


|p1= target: [[Config]] - Path to group in CfgORBAT|PARAMETER1=
|p1= target: [[Config]] - path to group in CfgORBAT
|p2= texture: [[String]] - Texture|PARAMETER2=
|p2= texture: [[String]] - texture
|p3= colour: [[Array]] - Colour in format [R,G,B,A]|PARAMETER3=
|p3= colour: [[Array]] - colour in format [R,G,B,A]
|p4= widthMulti: [[Number]] - Original icon width multiplier|PARAMETER4=
|p4= widthMulti: [[Number]] - original icon width multiplier
|p5= heightMulti: [[Number]] - Original icon height multiplier|PARAMETER5=
|p5= heightMulti: [[Number]] - original icon height multiplier
|p6= angle: [[Number]] - Angle|PARAMETER6=
|p6= angle: [[Number]] - angle
|p7= text: [[String]] - Text|PARAMETER7=
|p7= text: [[String]] - text
|p8= shadow: [[Boolean]] - Shadow outlining the texture|PARAMETER8=
|p8= shadow: [[Boolean]] - shadow outlining the texture


|r1= [[Number]] - overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]


| [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]|RETURNVALUE=
|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>
____________________________________________________________________________________________


|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> |=
|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]]
______________
 
| [[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=
}}
}}
<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 18: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"