setGroupIcon: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
(updated SeeAlso)
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= High Command |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Sets group icon properties. |DESCRIPTION=
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| group '''setGroupIcon''' [id, icon, offset] |SYNTAX=
|gr1= High Command


|p1= group: [[Group]]  |PARAMETER1=
|descr= Sets group icon properties.
|p2= [id, icon, offset] : [[Array]] |PARAMETER2=


|p3= id: [[Number]] - The icon ID returned by [[addGroupIcon]] |PARAMETER3=
|s1= group [[setGroupIcon]] [id, icon, offset]


|p4= icon: [[String]] - Class name of desired icon from CfgGroupIcons |PARAMETER4=
|p1= group: [[Group]]


|p5= offset: [[Array]] (Optional) - X and Y offsets of the icon in form [offsetX, offsetY] |PARAMETER5=
|p2= id: [[Number]] - the icon ID returned by [[addGroupIcon]]


| [[Nothing]] |RETURNVALUE=
|p3= icon: [[String]] - class name of desired icon from CfgGroupIcons


|p4= offset: [[Array]] - (Optional, default [0,0]) X and Y offsets of the icon in form [offsetX, offsetY]


|x1= <code>_target [[setGroupIcon]] [_icon, "hc_selectedEnemy"];
|r1= [[Nothing]]
_target [[setGroupIcon]] [_icon, "flag"];
_grp [[setGroupIcon]] [_iconsize, _iconsizeclass, _offset];
_grp [[setGroupIcon]] [_newid, _icon, _offset];
_grp [[setGroupIcon]] [_icon, _iconclass];</code>|EXAMPLE1=


____________________________________________________________________________________________
|x1= <sqf>
_target setGroupIcon [_icon, "hc_selectedEnemy"];
_target setGroupIcon [_icon, "flag"];


| [[addGroupIcon]], [[clearGroupIcons]], [[getGroupIcon]], [[getGroupIconParams]], [[groupIconSelectable]], [[groupIconsVisible]], [[onGroupIconClick]], [[removeGroupIcon]], [[setGroupIconParams]], [[setGroupIconsSelectable]], [[setGroupIconsVisible]] |SEEALSO=
_group setGroupIcon [_icon, _iconsClass, _offset];
</sqf>


| |MPBEHAVIOUR=  
|seealso= [[addGroupIcon]] [[clearGroupIcons]] [[getGroupIcon]] [[getGroupIcons]] [[getGroupIconParams]] [[groupIconSelectable]] [[groupIconsVisible]] [[onGroupIconClick]] [[removeGroupIcon]] [[setGroupIconParams]] [[setGroupIconsSelectable]] [[setGroupIconsVisible]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 07:10, 14 February 2023

Hover & click on the images for description

Description

Description:
Sets group icon properties.
Groups:
High Command

Syntax

Syntax:
group setGroupIcon [id, icon, offset]
Parameters:
group: Group
id: Number - the icon ID returned by addGroupIcon
icon: String - class name of desired icon from CfgGroupIcons
offset: Array - (Optional, default [0,0]) X and Y offsets of the icon in form [offsetX, offsetY]
Return Value:
Nothing

Examples

Example 1:
_target setGroupIcon [_icon, "hc_selectedEnemy"]; _target setGroupIcon [_icon, "flag"]; _group setGroupIcon [_icon, _iconsClass, _offset];

Additional Information

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

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