join: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Armed[ _]Assault(\|.*)]]" to "{{GameCategory|arma1|Scripting Commands}}")
m (Small improvements)
 
(39 intermediate revisions by 3 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 |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= global |Multiplayer Effects=
|game4= arma2
|version4= 1.00


|gr1= Groups |GROUP1=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| {{{!}} class{{=}}"wikitable" style{{=}}"float: right; font-size: 0.9em; margin: 0 0 0.5em 1.5em"
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50
 
|arg= global
 
|eff= global
 
|gr1= Groups
 
|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
! colspan{{=}}"2" {{!}} Maximum number of<br>units per group
{{!}}-
{{!}}-
{{!}} {{ofp}} {{!}}{{!}} 12
{{!}} {{ofp}} {{!}}{{!}} 12
{{!}}-
{{!}}-
{{!}} {{arma1}} {{!}}{{!}} 144
{{!}} Later titles {{!}}{{!}} 10000+
{{!}}-
{{!}} {{arma2}}{{!}}{{!}} ?
{{!}}-
{{!}} {{arma3}} {{!}}{{!}} 3000+
{{!}}}
{{!}}}
Join all units in the array to given group.  
Joins units into a given [[Group]].


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=
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.
____________________________________________________________________________________________


| unitArray '''join''' group |SYNTAX=
|s1= unitArray [[join]] group


|p1= unitArray: [[Array]] - units to join group |PARAMETER1=
|p1= unitArray: [[Array]] - units to join group


|p2= group: [[Group]] or [[Object]] |PARAMETER2=
|p2= group: [[Group]] or [[Object]]


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code>[_unitOne, _unitTwo] [[join]] [[player]];</code> |EXAMPLE1=
|x2= <code>[_unitOne, _unitTwo] [[join]] ([[group]] [[player]]);</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[joinAs]], [[joinAsSilent]], [[joinSilent]], [[group]], [[leader]] |SEEALSO=
|x1= <sqf>[_unitOne, _unitTwo] join player;</sqf>


| |=
|x2= <sqf>[_unitOne, _unitTwo] join (group player);</sqf>
 
|seealso= [[joinAs]] [[joinAsSilent]] [[joinSilent]] [[group]] [[leader]] [[doFollow]]
}}
}}
<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:Scripting Commands|JOIN]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|JOIN]]
[[Category:Scripting Commands OFP 1.46|JOIN]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{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