BIS fnc moveIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|+$" to "")
m (Some wiki formatting)
 
(12 intermediate revisions by the same user not shown)
Line 9: Line 9:
|gr1= Object Manipulation
|gr1= Object Manipulation


|arg= local |= Arguments
|arg= local


|descr= Moves a unit into vehicle. Compatible with [[assignedVehicleRole]] output.
|descr= Moves a unit into vehicle. Compatible with [[assignedVehicleRole]] output.


|s1=[vehicle, unit, role] call [[BIS_fnc_moveIn]]
|s1= [vehicle, unit, role] call [[BIS_fnc_moveIn]]


|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]


|p2= unit: [[Object]] - the unit to move into ''vehicle''
|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:
|p3= role: [[Array]] - wanted seat, in format [''"role"''] or [''"role"'', turretPath]. Can be one of:
Line 27: Line 27:
* "": will load ''unit'' in the first available seat (using [[moveInAny]])
* "": will load ''unit'' in the first available seat (using [[moveInAny]])


|r1=[[Boolean]] - [[true]] if moved in successfully
|r1= [[Boolean]] - [[true]] if moved in successfully


|x1= <code>[myCar, [[player]], "cargo"] [call]] [[BIS_fnc_moveIn]];</code>
|x1= <sqf>[myCar, player, "cargo"] call BIS_fnc_moveIn;</sqf>


|x2= <code>[myTank, [[player]], ["turret", [0]]] [call]] [[BIS_fnc_moveIn]];</code>
|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>
|x3= <sqf>[myTank, player, ["turret", -1]] call BIS_fnc_moveIn; // will moveInDriver the player</sqf>


|mp= ''unit'' must be '''[[local]]'''
|seealso= [[moveInDriver]] [[moveInGunner]] [[moveInCommander]] [[moveInCargo]] [[moveInTurret]] [[moveInAny]]
 
|seealso= [[moveInDriver]], [[moveInGunner]], [[moveInCommander]], [[moveInCargo]], [[moveInTurret]], [[moveInAny]]
}}
}}

Latest revision as of 23:05, 12 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_moveIn&oldid=327172"