BIS fnc moveIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
Line 29: Line 29:
|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= <code>[myCar, player, "cargo"] [call]] [[BIS_fnc_moveIn]];</code>


|x2= <code>[myTank, [[player]], ["turret", [0]]] [call]] [[BIS_fnc_moveIn]];</code>
|x2= <code>[myTank, player, ["turret", [0]]] [call]] [[BIS_fnc_moveIn]];</code>


|x3= <code>[myTank, [[player]], ["turret", -1]] [call]] [[BIS_fnc_moveIn]]; {{codecomment|// will [[moveInDriver]] the player}}</code>
|x3= <code>[myTank, player, ["turret", -1]] [call]] [[BIS_fnc_moveIn]]; {{codecomment|// will [[moveInDriver]] the player}}</code>


|mp= ''unit'' must be '''[[Multiplayer Scripting#Locality|local]]'''
|mp= ''unit'' must be '''[[Multiplayer Scripting#Locality|local]]'''

Revision as of 22:35, 12 July 2022

Hover & click on the images for description

Description

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

Syntax

Syntax:
[vehicle, unit, role] call BIS_fnc_moveIn
Parameters:
vehicle: Object
unit: Object - the unit to move into vehicle
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