BIS fnc ORBATAddGroupOverlay: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\|= " to " ") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = Strategic | |gr1 = Strategic | ||
| Register texture(s) to be displayed over CfgORBAT group. | | Register texture(s) to be displayed over CfgORBAT group. | ||
| [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] | | [target, texture, colour, widthMulti, heightMulti, angle, text, shadow] call [[BIS_fnc_ORBATAddGroupOverlay]] | ||
|p1= target: [[Config]] - Path to group in CfgORBAT | |p1= target: [[Config]] - Path to group in CfgORBAT | ||
|p2= texture: [[String]] - Texture | |p2= texture: [[String]] - Texture | ||
|p3= colour: [[Array]] - Colour in format [R,G,B,A] | |p3= colour: [[Array]] - Colour in format [R,G,B,A] | ||
|p4= widthMulti: [[Number]] - Original icon width multiplier | |p4= widthMulti: [[Number]] - Original icon width multiplier | ||
|p5= heightMulti: [[Number]] - Original icon height multiplier | |p5= heightMulti: [[Number]] - Original icon height multiplier | ||
|p6= angle: [[Number]] - Angle | |p6= angle: [[Number]] - Angle | ||
|p7= text: [[String]] - Text | |p7= text: [[String]] - Text | ||
|p8= shadow: [[Boolean]] - Shadow outlining the texture | |p8= shadow: [[Boolean]] - Shadow outlining the texture | ||
| [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]] | | [[Number]] - Overlay ID, used by [[BIS_fnc_ORBATRemoveGroupOverlay]] | ||
|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]] | | [[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]] | ||
}} | }} | ||
Revision as of 23:18, 17 January 2021
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