BIS fnc moveIn: Difference between revisions

Latest revision as of 23:05, 12 July 2022

1.00

0.50

LALocal

Hover & click on the images for description

Description

Description:: Moves a unit into vehicle. Compatible with assignedVehicleRole output.
Execution:: call
Groups:: Object Manipulation

Syntax

Syntax:

[vehicle, unit, role] call BIS_fnc_moveIn

Parameters:

vehicle: Object

unit: Object - the unit to move into vehicle - must be local

role: Array - wanted seat, in format ["role"] or ["role", turretPath]. Can be one of:

"driver"
"gunner"
"commander"
"cargo"
"turret"
"": will load unit in the first available seat (using moveInAny)

Return Value:

Boolean - true if moved in successfully

Examples

Example 1:: [myCar, player, "cargo"] call BIS_fnc_moveIn;
Example 2:: [myTank, player, ["turret", [0]]] call BIS_fnc_moveIn;
Example 3:: [myTank, player, ["turret", -1]] call BIS_fnc_moveIn; // will moveInDriver the player

Additional Information

See also:: moveInDriver moveInGunner moveInCommander moveInCargo moveInTurret moveInAny

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: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| tkoh |Game name=
+|game1= tkoh
+|version1= 1.00
-|1.00|Game version=
+|game2= arma3
+|version2= 0.50
-|arg= local |= Arguments
+|gr1= Object Manipulation
-____________________________________________________________________________________________
-| Moves a unit into vehicle. Compatible with [[assignedVehicleRole]] output. |DESCRIPTION=
+|arg= local
-____________________________________________________________________________________________
-| [vehicle, unit, role] call [[BIS_fnc_moveIn]] |SYNTAX=
+|descr= Moves a unit into vehicle. Compatible with [[assignedVehicleRole]] output.
-|p1= vehicle: [[Object]] |PARAMETER1=
+|s1= [vehicle, unit, role] call [[BIS_fnc_moveIn]]
-|p2= unit: [[Object]] - the unit to move into ''vehicle'' |PARAMETER2=
+|p1= vehicle: [[Object]]
+|p2= unit: [[Object]] - the unit to move into ''vehicle'' - must be [[Multiplayer Scripting#Locality|local]]
 |p3= role: [[Array]] - wanted seat, in format [''"role"''] or [''"role"'', turretPath]. Can be one of:
@@ Line 24: / Line 25: @@
 * "cargo"
 * "turret"
-* "": will load ''unit'' in the first available seat (using [[moveInAny]]) |PARAMETER3=
+* "": will load ''unit'' in the first available seat (using [[moveInAny]])
-| [[Boolean]] - [[true]] if moved in successfully |RETURNVALUE=
+|r1= [[Boolean]] - [[true]] if moved in successfully
-____________________________________________________________________________________________
-|x1= <code>[myCar, [[player]], "cargo"] [call]] [[BIS_fnc_moveIn]];</code> |EXAMPLE1=
+|x1= <sqf>[myCar, player, "cargo"] call BIS_fnc_moveIn;</sqf>
-|x2= <code>[myTank, [[player]], ["turret", [0]]] [call]] [[BIS_fnc_moveIn]];</code> |EXAMPLE2=
+|x2= <sqf>[myTank, player, ["turret", [0]]] call BIS_fnc_moveIn;</sqf>
-|x3= <code>[myTank, [[player]], ["turret", -1]] [call]] [[BIS_fnc_moveIn]]; {{codecomment|// will [[moveInDriver]] the player}}</code> |EXAMPLE3=
+|x3= <sqf>[myTank, player, ["turret", -1]] call BIS_fnc_moveIn; // will moveInDriver the player</sqf>
-____________________________________________________________________________________________
-|mp= ''unit'' must be '''[[local]]''' |Multiplayer=
+|seealso= [[moveInDriver]] [[moveInGunner]] [[moveInCommander]] [[moveInCargo]] [[moveInTurret]] [[moveInAny]]
-| [[moveInDriver]], [[moveInGunner]], [[moveInCommander]], [[moveInCargo]], [[moveInTurret]], [[moveInAny]] |SEEALSO=
 }}
-<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:Function Group: Misc|{{uc:moveIn}}]]
-[[Category:Functions|{{uc:moveIn}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:moveIn}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:moveIn}}]]