setGroupIconsVisible: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " | }}" to " }}")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00
 
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50
 
|eff= local
|eff= local
|1.00


|gr1= High Command
|gr1= High Command


| Sets if group icons added with [[addGroupIcon]] are visible on map and in the HUD.<br><br>
|descr= Sets if group icons added with [[addGroupIcon]] are visible on map and in the HUD.
{{Feature|arma3| Since Arma 3 v1.93.145657 this command returns [[Nothing]] as it should}}


| '''setGroupIconsVisible''' [showOnMap, showOnHUD]
|s1= [[setGroupIconsVisible]] [showOnMap, showOnHUD]


|p1= [showOnMap, showOnHUD]: [[Array]]
|p1= showOnMap: [[Boolean]] - [[true]] to show on map. Default is [[false]]


|p2= showOnMap: [[Boolean]] - [[true]] to show on map. Default - [[false]]
|p2= showOnHUD: [[Boolean]] - [[true]] to show on HUD. Default is [[false]]


|p3= showOnHUD: [[Boolean]] - [[true]] to show on HUD. Default - [[false]]
|r1= [[Nothing]] (prior to {{arma3}} v1.94 this command returned [[Object]] of [[objNull|null]] value)


| [[Nothing]] (prior to Arma 3 v1.93.145657 this command returned [[Object]] of [[objNull | null]] value)
|x1= <sqf>
setGroupIconsVisible [true, true];
(group player) addGroupIcon ["b_inf", [0, 0]];
</sqf>


|x1= <code>[[setGroupIconsVisible]] [true,true]
|seealso= [[addGroupIcon]] [[clearGroupIcons]] [[getGroupIcon]] [[getGroupIconParams]] [[groupIconSelectable]] [[groupIconsVisible]] [[onGroupIconClick]] [[removeGroupIcon]] [[setGroupIcon]] [[setGroupIconParams]] [[setGroupIconsSelectable]]
([[group]] [[player]]) [[addGroupIcon]] ["b_inf", [0, 0]];</code>
}}


| [[addGroupIcon]], [[clearGroupIcons]], [[getGroupIcon]], [[getGroupIconParams]], [[groupIconSelectable]], [[groupIconsVisible]], [[onGroupIconClick]], [[removeGroupIcon]], [[setGroupIcon]], [[setGroupIconParams]], [[setGroupIconsSelectable]]
{{Note
|user= Larrow
|timestamp= 20220206095920
|text= If enabling for MARTA (Military Symbols) and using teamSwitch this command needs to be run again once switched to the new unit.
Possibly do it in a mission eventHandler of TeamSwitch.
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Sets if group icons added with addGroupIcon are visible on map and in the HUD.
Groups:
High Command

Syntax

Syntax:
setGroupIconsVisible [showOnMap, showOnHUD]
Parameters:
showOnMap: Boolean - true to show on map. Default is false
showOnHUD: Boolean - true to show on HUD. Default is false
Return Value:
Nothing (prior to Arma 3 v1.94 this command returned Object of null value)

Examples

Example 1:
setGroupIconsVisible [true, true]; (group player) addGroupIcon ["b_inf", [0, 0]];

Additional Information

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

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
Larrow - c
Posted on Feb 06, 2022 - 09:59 (UTC)
If enabling for MARTA (Military Symbols) and using teamSwitch this command needs to be run again once switched to the new unit. Possibly do it in a mission eventHandler of TeamSwitch.