groupSelectUnit: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (see also & example formating)
(description, example)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Select unit from unit's group. |= Description
| Selects a unit from players's group. If player is a leader, the effect of this command is similar to player pressing F1, F2, F3... buttons to highlight units in his squad, after which the unit command menu is shown. If leader is AI, player will get usual communication menu to interact with the leader. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| unitName '''groupSelectUnit''' [unit, booleanValue] |= Syntax
| player '''groupSelectUnit''' [unit, select] |= Syntax


|p1= unitName: [[Object]] - desc |= PARAMETER1  
|p1= player: [[Object]] |= PARAMETER1  


|p2= [unit, booleanValue]: [[Array]]|= PARAMETER2  
|p2= [unit, select]: [[Array]]|= PARAMETER2  


|p3= unit: [[Object]] - desc |= PARAMETER3  
|p3= unit: [[Object]] |= PARAMETER3  


|p4= booleanValue: [[Boolean]] - desc|= PARAMETER3  
|p4= select: [[Boolean]] |= PARAMETER3  


| [[Nothing]] |= RETURNVALUE  
| [[Nothing]] |= RETURNVALUE  




|x1= <code>{//after leaving menu deselect all units (command menu is not opened -> no selection)
|x1= After leaving menu, deselect all units (command menu is not opened -> no selection)<code>{
     [[player]] [[groupSelectUnit]] [_x, [[false]]];
     [[player]] [[groupSelectUnit]] [_x, [[false]]];
} [[forEach]] ([[groupSelectedUnits]] [[player]]);</code>|= EXAMPLE1
} [[forEach]] ([[groupSelectedUnits]] [[player]]);</code>|= EXAMPLE1
|x2= Select all units when player is the leader:<code>{
    [[player]] [[groupSelectUnit]] [_x, [[true]]];
} [[forEach]] [[units]] [[player]];</code>|= EXAMPLE2
|x3= Open communication with group leader:<code>[[player]] [[groupSelectUnit]] <nowiki>[</nowiki>[[leader]] [[player]], [[true]]];</code>|= EXAMPLE3


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 12:52, 3 October 2015

Hover & click on the images for description

Description

Description:
Selects a unit from players's group. If player is a leader, the effect of this command is similar to player pressing F1, F2, F3... buttons to highlight units in his squad, after which the unit command menu is shown. If leader is AI, player will get usual communication menu to interact with the leader.
Groups:
Uncategorised

Syntax

Syntax:
player groupSelectUnit [unit, select]
Parameters:
player: Object
[unit, select]: Array
unit: Object
select: Boolean
Return Value:
Nothing

Examples

Example 1:
After leaving menu, deselect all units (command menu is not opened -> no selection){ player groupSelectUnit [_x, false]; } forEach (groupSelectedUnits player);
Example 2:
Select all units when player is the leader:{ player groupSelectUnit [_x, true]; } forEach units player;
Example 3:
Open communication with group leader:player groupSelectUnit [leader player, true];

Additional Information

See also:
groupSelectedUnits

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

Notes

Bottom Section