join: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Small improvements)
 
(56 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.34


|1.34|= Game version
|game2= ofpe
|version2= 1.00


|arg= global |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Join all units in the array to given group.  
|game5= arma2oa
|version5= 1.50


Maximum number of group members is:
|game6= tkoh
* OFP: 12
|version6= 1.00
* Arma: ?
* Arma 2: ?
* Arma 3: "unlimited" (3000+)
* VBS 2: "unlimited" (260+)


To have a group member leave a group, join him with the [[grpNull]] group (e.g. <tt>[guy1] [[join]] [[grpNull]]</tt>), but '''beware''', as brand new group is created for the leaving unit and this could result in the number of groups in a mission growing out of control. |= Description
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


| unitArray '''join''' group |= Syntax
|arg= global


|p1= unitArray: [[Array]] - units to join group |= Parameter 1
|eff= global


|p2= group: [[Group]] or [[Object]] |= Parameter 2
|gr1= Groups


| [[Nothing]] |= Return value
|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
 
{{!}}-
|x1= <code>[_unitOne, _unitTwo] [[join]] [[player]];</code> |= Example 1
{{!}} {{ofp}} {{!}}{{!}} 12
|x2= <code>[_unitOne, _unitTwo] [[join]] ([[group]] [[player]]);</code> |= Example 2
{{!}}-
____________________________________________________________________________________________
{{!}} Later titles {{!}}{{!}} 10000+
{{!}}}
Joins units into a given [[Group]].


| [[joinAs]], [[joinAsSilent]], [[joinSilent]], [[group]], [[leader]] |= See also
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.


|mp= This function is unsupported in MP in version 1.33 and before. |=
|s1= unitArray [[join]] group
}}
 
|p1= unitArray: [[Array]] - units to join group
 
|p2= group: [[Group]] or [[Object]]


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>[_unitOne, _unitTwo] join player;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>[_unitOne, _unitTwo] join (group player);</sqf>


[[Category:Scripting Commands|JOIN]]
|seealso= [[joinAs]] [[joinAsSilent]] [[joinSilent]] [[group]] [[leader]] [[doFollow]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands OFP 1.96|JOIN]]
[[Category:Scripting Commands OFP 1.46|JOIN]]
[[Category:Scripting Commands ArmA|JOIN]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Groups|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:39, 14 October 2022

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