BIS fnc moveIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "_{10,} " to "")
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{Function|Comments=
____________________________________________________________________________________________


| tkoh |= Game name
| tkoh |Game name=


|1.00|= Game version
|1.00|Game version=
 
|gr1 = Object Manipulation |GROUP1=


|arg= local |= Arguments
|arg= local |= Arguments
____________________________________________________________________________________________


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


| [vehicle, unit, role] call [[BIS_fnc_moveIn]] |SYNTAX=
| [vehicle, unit, role] call [[BIS_fnc_moveIn]] |SYNTAX=
Line 27: Line 26:


| [[Boolean]] - [[true]] if moved in successfully |RETURNVALUE=
| [[Boolean]] - [[true]] if moved in successfully |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>[myCar, [[player]], "cargo"] [call]] [[BIS_fnc_moveIn]];</code> |EXAMPLE1=
|x1= <code>[myCar, [[player]], "cargo"] [call]] [[BIS_fnc_moveIn]];</code> |EXAMPLE1=
Line 34: Line 32:


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


|mp= ''unit'' must be '''[[local]]''' |= Multiplayer
|mp= ''unit'' must be '''[[local]]''' |Multiplayer=


| [[moveInDriver]], [[moveInGunner]], [[moveInCommander]], [[moveInCargo]], [[moveInTurret]], [[moveInAny]] |SEEALSO=
| [[moveInDriver]], [[moveInGunner]], [[moveInCommander]], [[moveInCargo]], [[moveInTurret]], [[moveInAny]] |SEEALSO=
Line 49: Line 46:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:moveIn}}]]
 
[[Category:Functions|{{uc:moveIn}}]]
[[Category:Functions|{{uc:moveIn}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:moveIn}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:moveIn}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moveIn}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moveIn}}]]

Revision as of 00:27, 17 January 2021

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:
moveInDrivermoveInGunnermoveInCommandermoveInCargomoveInTurretmoveInAny

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

Notes

Bottom Section