BIS fnc ORBATAddGroupOverlay: Difference between revisions
Jump to navigation
Jump to search
m (example formatting) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Register texture(s) to be displayed over CfgORBAT group. |= | | Register texture(s) to be displayed over CfgORBAT group. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] |= | | [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] |SYNTAX= | ||
|p1= target: [[Config]] - Path to group in CfgORBAT|= | |p1= target: [[Config]] - Path to group in CfgORBAT|PARAMETER1= | ||
|p2= texture: [[String]] - Texture|= | |p2= texture: [[String]] - Texture|PARAMETER2= | ||
|p3= colour: [[Array]] - Colour in format [R,G,B,A]|= | |p3= colour: [[Array]] - Colour in format [R,G,B,A]|PARAMETER3= | ||
|p4= widthMulti: [[Number]] - Original icon width multiplier|= | |p4= widthMulti: [[Number]] - Original icon width multiplier|PARAMETER4= | ||
|p5= heightMulti: [[Number]] - Original icon height multiplier|= | |p5= heightMulti: [[Number]] - Original icon height multiplier|PARAMETER5= | ||
|p6= angle: [[Number]] - Angle|= | |p6= angle: [[Number]] - Angle|PARAMETER6= | ||
|p7= text: [[String]] - Text|= | |p7= text: [[String]] - Text|PARAMETER7= | ||
|p8= shadow: [[Boolean]] - Shadow outlining the texture|= | |p8= shadow: [[Boolean]] - Shadow outlining the texture|PARAMETER8= | ||
| [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]|= | | [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]]|RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 28: | Line 28: | ||
______________ | ______________ | ||
| [[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> | <h3 style="display:none">Notes</h3> | ||
Revision as of 15:32, 7 April 2019
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_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