groupSelectedUnits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added example from functions module)
m (Text replacement - "\| *p([0-9]+) *=([^↵]+) -↵" to "|p$1=$2")
 
(48 intermediate revisions by 8 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


| Returns selected groups in sgroup. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''groupSelectedUnits''' unit |= Syntax
|game4= arma3
|version4= 0.50


|p1= unit: [[Object]] -  |= PARAMETER1
|gr1= Interaction


|p2= |= PARAMETER2
|descr= Returns selected units in source group for normal commanding mode (individual units). For the High Command equivalent, see [[hcSelected]].


|p3= |= PARAMETER3
|s1= [[groupSelectedUnits]] unit


| [[Array]] |= RETURNVALUE
|p1= unit: [[Object]]
|r1= [[Array]]


|x1= <sqf>_selectedUnits = groupSelectedUnits player;</sqf>


|x1= <pre>{//after leaving menu deselect all units (command menu is not opened -> no selection)
|seealso= [[groupSelectUnit]]
    player groupSelectUnit [_x, false];
} forEach (groupSelectedUnits player);</pre>|= EXAMPLE1
 
____________________________________________________________________________________________
 
|  |= SEEALSO
 
|  |= 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|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:51, 26 March 2024

Hover & click on the images for description

Description

Description:
Returns selected units in source group for normal commanding mode (individual units). For the High Command equivalent, see hcSelected.
Groups:
Interaction

Syntax

Syntax:
groupSelectedUnits unit
Parameters:
unit: Object
Return Value:
Array

Examples

Example 1:
_selectedUnits = groupSelectedUnits player;

Additional Information

See also:
groupSelectUnit

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