getGroupIconParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (global args)
m (arma 3 copy paste example)
 
(50 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|1.00|= Game version
|version1= 1.00
|arg= global|= Arguments in MP
____________________________________________________________________________________________


| Returns group icons params. [color,text,scale,visible] |= 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]] |= RETURNVALUE
|s1= [[getGroupIconParams]] group


|p1= group: [[Group]]


|x1= <pre>_icon = _this getVariable "icon";
|r1= [[Array]] in format [color, text, scale, visibility, WPvisibility WPcolor], where:
//[color,text,scale,visible]
* color: [[Array]] - icon color in format [r,g,b,a]
_params = getGroupIconParams _icon;
* text: [[String]] - icon text
_color        = _params select 0;
* scale: [[Number]] - icon scale
_text        = _params select 1;
* visibility: [[Boolean]] - icon visibility
_scale        = _params select 2;
* WPvisibility: [[Boolean]] - waypoint visibility
_visible    = _params select 3;</pre>|= EXAMPLE1
* WPcolor: [[Array]] - waypoint color in format [r,g,b,a]


____________________________________________________________________________________________
|x1= <sqf>_iconParams = getGroupIconParams group player;</sqf>


| [[addGroupIcon]], [[clearGroupIcons]], [[getGroupIcon]], [[groupIconSelectable]], [[groupIconsVisible]], [[onGroupIconClick]], [[removeGroupIcon]], [[setGroupIcon]], [[setGroupIconParams]], [[setGroupIconsSelectable]], [[setGroupIconsVisible]] |= SEEALSO
|x2= <sqf>getGroupIconParams group player params ["_color", "_text", "_scale", "_visibility", "_WPVisibility", "_WPColor"];</sqf>


| |= MPBEHAVIOUR
|seealso= [[addGroupIcon]] [[clearGroupIcons]] [[getGroupIcon]] [[groupIconSelectable]] [[groupIconsVisible]] [[onGroupIconClick]] [[removeGroupIcon]] [[setGroupIcon]] [[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>
[[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}}}}]]

Latest revision as of 21:26, 30 August 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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 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;
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 or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=getGroupIconParams&oldid=330302"