join: Difference between revisions

Latest revision as of 20:39, 14 October 2022

1.34

1.00

Hover & click on the images for description

Description

Description:

Maximum number of units per group
Operation Flashpoint	12
Later titles	10000+

Joins units into a given Group.

To make a unit leave its current group, join it into grpNull (e.g. [MyUnit] join grpNull) - but beware: A new group is created for the leaving unit; this could result in the number of groups growing out of control.

Groups:

Groups

Syntax

Syntax:: unitArray join group
Parameters:: unitArray: Array - units to join group
: group: Group or Object
Return Value:: Nothing

Examples

Example 1:: [_unitOne, _unitTwo] join player;
Example 2:: [_unitOne, _unitTwo] join (group player);

Additional Information

See also:: joinAs joinAsSilent joinSilent group leader doFollow

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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands]]
+{{RV|type=command
-[[Category:Scripting Commands OFP 1.97]]
-[[Category:Scripting Commands OFP 1.46]]
-[[Category:Scripting Commands ArmA]]
-back to [[Scripting_Reference#J|COMREF]]
+|game1= ofp
+|version1= 1.34
-<h2 style="color:#000066">'''''unitArray'' join ''group'''''</h2>
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2
+|version4= 1.00
-'''unitArray:''' [[Array]]
+|game5= arma2oa
+|version5= 1.50
-'''group:''' [[Object or Group]]
+|game6= tkoh
+|version6= 1.00
-'''Type of returned value:'''
+|game7= arma3
+|version7= 0.50
-[[Nothing]]
+|arg= global
-'''Compatibility:'''
+|eff= global
-Changed in version '''1.34'''
+|gr1= Groups
-'''Description:'''
+|descr= {{{!}} class{{=}}"wikitable" style{{=}}"float: right; font-size: 0.9em; margin: 0 0 0.5em 1.5em"
+! colspan{{=}}"2" {{!}} Maximum number of<br>units per group
+{{!}}-
+{{!}} {{ofp}} {{!}}{{!}} 12
+{{!}}-
+{{!}} Later titles {{!}}{{!}} 10000+
+{{!}}}
+Joins units into a given [[Group]].
-Join all units in the array to given group.
+To make a unit leave its current group, join it into [[grpNull]] (e.g. <sqf inline>[MyUnit] join grpNull</sqf>) - but beware: A new group is created for the leaving unit; this could result in the number of groups growing out of control.
-'''Note:''' Total number of group members must not exceed 12.
+|s1= unitArray [[join]] group
-'''Note:''' This function is unsupported in MP in version 1.33 and before.
+|p1= unitArray: [[Array]] - units to join group
+|p2= group: [[Group]] or [[Object]]
-'''Example:'''
+|r1= [[Nothing]]
-[unitOne, unitTwo] '''join''' [[player]]
+|x1= <sqf>[_unitOne, _unitTwo] join player;</sqf>
+|x2= <sqf>[_unitOne, _unitTwo] join (group player);</sqf>
+|seealso= [[joinAs]] [[joinAsSilent]] [[joinSilent]] [[group]] [[leader]] [[doFollow]]
+}}