getGroupIconParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (global args)
(description)
Line 4: Line 4:
| arma2 |= Game name
| arma2 |= Game name
|1.00|= Game version
|1.00|= Game version
|arg= global|= Arguments in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns group icons params. [color,text,scale,visible] |= Description
| Returns group icons params used for command bar drawing such as color, text, scale, visibility, waypoint visibility, waypoint color. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''getGroupIconParams''' group |= Syntax
| '''getGroupIconParams''' group |= Syntax


|p1= group: [[Group]] - |= PARAMETER1  
|p1= group: [[Group]]  |= PARAMETER1  


|p2= |= PARAMETER2  
|p2= |= PARAMETER2  
Line 18: Line 17:
|p3= |= PARAMETER3  
|p3= |= PARAMETER3  


| [[Array]] |= RETURNVALUE  
| [[Array]] in format [color, text, scale, visibility, WPvisibility WPcolor], where:
* color: [[Array]] - icon color in format [r,g,b,a]
* text: [[String]] - icon text
* scale: [[Number]] - icon scale
* visibility: [[Boolean]] - icon visibility
* WPvisibility: [[Boolean]] - waypoint visibility
* WPcolor: [[Array]] - waypoint color in format [r,g,b,a]
|= RETURNVALUE  




|x1= <pre>_icon = _this getVariable "icon";
|x1= <code>_iconParams = [[getGroupIconParams]] [[group]] [[player]];</code>|= EXAMPLE1  
//[color,text,scale,visible]
_params = getGroupIconParams _icon;
_color        = _params select 0;
_text        = _params select 1;
_scale        = _params select 2;
_visible    = _params select 3;</pre>|= EXAMPLE1  


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 13:02, 4 May 2017

Hover & click on the images for description

Description

Description:
Returns group icons params used for command bar drawing such as color, text, scale, visibility, waypoint visibility, waypoint color.
Groups:
Uncategorised

Syntax

Syntax:
getGroupIconParams group
Parameters:
group: Group
Return Value:
Array in format [color, text, scale, visibility, WPvisibility WPcolor], where:
  • color: Array - icon color in format [r,g,b,a]
  • text: String - icon text
  • scale: Number - icon scale
  • visibility: Boolean - icon visibility
  • WPvisibility: Boolean - waypoint visibility
  • WPcolor: Array - waypoint color in format [r,g,b,a]

Examples

Example 1:
_iconParams = getGroupIconParams group player;

Additional Information

See also:
addGroupIconclearGroupIconsgetGroupIcongroupIconSelectablegroupIconsVisibleonGroupIconClickremoveGroupIconsetGroupIconsetGroupIconParamssetGroupIconsSelectablesetGroupIconsVisible

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