joinAs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
m (Some wiki formatting)
 
(54 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|1.00|Game version=
|version1= 1.00
|arg= global|Multiplayer Arguments=
|eff= global|Multiplayer Effects=
____________________________________________________________________________________________


| Joins the unit to the given group, if position id is available, this one is used.  |DESCRIPTION=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| unit '''joinAs''' [group, id] |SYNTAX=
|game3= tkoh
|version3= 1.00


|p1= unit: [[Object]] |PARAMETER1=  
|game4= arma3
|version4= 0.50


|p2= [group, id]: [[Array]] |PARAMETER2=  
|arg= global
|eff= global


|p3= group: [[Group]] |PARAMETER3=  
|gr1= Groups


|p4= id: [[Number]] |PARAMETER4=
|descr= Joins the unit to the given group, if position id is available, this one is used.


| [[Nothing]] |RETURNVALUE=
|s1= unit [[joinAs]] [group, id]


|p1= unit: [[Object]]


|x1= <code>[[player]] [[joinAs]] [_group, 4];</code>|EXAMPLE1=
|p2= group: [[Group]]


|x2= To get the position id: <code>getUnitPositionId = {
|p3= id: [[Number]]
[[private]] ["_vvn", "_str"];
_vvn = [[vehicleVarName]] _this;
_this [[setVehicleVarName]] "";
_str = [[str]] _this;
_this [[setVehicleVarName]] _vvn;
[[parseNumber]] (_str [[select]] [(_str [[find]] ":") + 1])
};
[[player]] [[joinAs]] [<nowiki/>[[createGroup]] [[west]], 5];
_id = [[player]] [[call]] getUnitPositionId;
[[hint]] [[str]] _id; //5</code>|EXAMPLE2=
____________________________________________________________________________________________


| [[join]], [[joinAsSilent]], [[joinSilent]], [[group]] |SEEALSO=
|r1= [[Nothing]]


| |MPBEHAVIOUR=  
|x1= <sqf>player joinAs [_group, 4];</sqf>
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|x2= To get the position id:
<dl class='command_description'>
<sqf>
<!-- Note Section BEGIN -->
getUnitPositionId = {
private ["_vvn", "_str"];
_vvn = vehicleVarName _this;
_this setVehicleVarName "";
_str = str _this;
_this setVehicleVarName _vvn;
parseNumber (_str select [(_str find ":") + 1])
};
player joinAs [createGroup west, 5];
_id = player call getUnitPositionId;
hint str _id; // 5
</sqf>


<!-- Note Section END -->
|seealso= [[join]] [[joinAsSilent]] [[joinSilent]] [[group]]
</dl>
}}
 
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Groups|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:38, 15 August 2022

Hover & click on the images for description

Description

Description:
Joins the unit to the given group, if position id is available, this one is used.
Groups:
Groups

Syntax

Syntax:
unit joinAs [group, id]
Parameters:
unit: Object
group: Group
id: Number
Return Value:
Nothing

Examples

Example 1:
player joinAs [_group, 4];
Example 2:
To get the position id:
getUnitPositionId = { private ["_vvn", "_str"]; _vvn = vehicleVarName _this; _this setVehicleVarName ""; _str = str _this; _this setVehicleVarName _vvn; parseNumber (_str select [(_str find ":") + 1]) }; player joinAs [createGroup west, 5]; _id = player call getUnitPositionId; hint str _id; // 5

Additional Information

See also:
join joinAsSilent joinSilent group

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