getGroupIconParams: Difference between revisions

Latest revision as of 13:36, 4 January 2026

1.00

1.50

1.00

0.50

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:: High Command

Syntax

Syntax:

getGroupIconParams group

Parameters:

group: Group

Return Value:

Array with [color, text, scale, visibility, WPvisibility, WPcolor]

color: Color (RGB) - icon color
text: String - icon text
scale: Number - icon scale
visibility: Boolean - icon visibility
WPvisibility: Boolean - waypoint visibility
WPcolor: Color (RGB) - waypoint color

Examples

Example 1:: _iconParams = getGroupIconParams group player;
Example 2:: getGroupIconParams group player params ["_color", "_text", "_scale", "_visibility", "_WPVisibility", "_WPColor"];

Additional Information

See also:: addGroupIcon clearGroupIcons getGroupIcon groupIconSelectable groupIconsVisible onGroupIconClick removeGroupIcon setGroupIcon setGroupIconParams setGroupIconsSelectable setGroupIconsVisible

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
-|1.00|= Game version
+|version1= 1.00
-____________________________________________________________________________________________
-| Returns group icons params used for command bar drawing such as color, text, scale, visibility, waypoint visibility, waypoint color. |= Description
+|game2= arma2oa
-____________________________________________________________________________________________
+|version2= 1.50
-| '''getGroupIconParams''' group |= Syntax
+|game3= tkoh
+|version3= 1.00
-|p1= group: [[Group]]  |= PARAMETER1
+|game4= arma3
+|version4= 0.50
-|p2= |= PARAMETER2
+|gr1= High Command
-|p3= |= PARAMETER3
+|descr= Returns group icons params used for command bar drawing such as color, text, scale, visibility, waypoint visibility, waypoint color.
-| [[Array]] in format [color, text, scale, visibility, WPvisibility WPcolor], where:
+|s1= [[getGroupIconParams]] group
-* color: [[Array]] - icon color in format [r,g,b,a]
+|p1= group: [[Group]]
+|r1= [[Array]] with [color, text, scale, visibility, WPvisibility, WPcolor]
+* color: [[Color|Color (RGB)]] - icon color
 * 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]
+* WPcolor: [[Color|Color (RGB)]] - waypoint color
-|= RETURNVALUE
-|x1= <code>_iconParams = [[getGroupIconParams]] [[group]] [[player]];</code>|= EXAMPLE1
+|x1= <sqf>_iconParams = getGroupIconParams group player;</sqf>
-____________________________________________________________________________________________
+|x2= <sqf>getGroupIconParams group player params ["_color", "_text", "_scale", "_visibility", "_WPVisibility", "_WPColor"];</sqf>
-| [[addGroupIcon]], [[clearGroupIcons]], [[getGroupIcon]], [[groupIconSelectable]], [[groupIconsVisible]], [[onGroupIconClick]], [[removeGroupIcon]], [[setGroupIcon]], [[setGroupIconParams]], [[setGroupIconsSelectable]], [[setGroupIconsVisible]] |= SEEALSO
+|seealso= [[addGroupIcon]] [[clearGroupIcons]] [[getGroupIcon]] [[groupIconSelectable]] [[groupIconsVisible]] [[onGroupIconClick]] [[removeGroupIcon]] [[setGroupIcon]] [[setGroupIconParams]] [[setGroupIconsSelectable]] [[setGroupIconsVisible]]
-|  |= MPBEHAVIOUR
-____________________________________________________________________________________________
 }}
-<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]