BIS fnc initVehicleCrew: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Vehicles |GROUP1=
|gr1 = Vehicles


| Moves units into vehicle seats. When units don't exist, it will create them in a group of vehicle's side. |Description=
| Moves units into vehicle seats. When units don't exist, it will create them in a group of vehicle's side.


| [object, params, deleteCrew, anySeat, agents] call [[BIS_fnc_initVehicleCrew]] |Syntax=
| [object, params, deleteCrew, anySeat, agents] call [[BIS_fnc_initVehicleCrew]]




|p1= object: [[Object]] |Parameter 1=
|p1= object: [[Object]]


|p2= params: [[Array]] - In format:
|p2= params: [[Array]] - In format:
Line 20: Line 20:
**"turret"
**"turret"
**"cargo"
**"cargo"
*2: index: [[Number]] or [[Array]] - Cargo index or turret path|Parameter 2=
*2: index: [[Number]] or [[Array]] - Cargo index or turret path


|p3= deleteCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to delete existing crew |Parameter 3=
|p3= deleteCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to delete existing crew


|p4= anySeat: [[Boolean]] - (Optional, default [[false]]) When desired seats are occuppied, move crew in the vehicle to any other available seat |Parameter 4=
|p4= anySeat: [[Boolean]] - (Optional, default [[false]]) When desired seats are occuppied, move crew in the vehicle to any other available seat


|p5= agents: [[Boolean]] - (Optional, default [[false]]) Create crew as [[agents]] |Parameter 5=
|p5= agents: [[Boolean]] - (Optional, default [[false]]) Create crew as [[agents]]


| [[Array]] - Created units |Return value=
| [[Array]] - Created units


|x1= <code>[ someVehicle, [<nowiki/>[[player]], "driver", 0], [[true]], [[true]] ] [[call]] [[BIS_fnc_initVehicleCrew]];</code> |Example 1=
|x1= <code>[ someVehicle, [<nowiki/>[[player]], "driver", 0], [[true]], [[true]] ] [[call]] [[BIS_fnc_initVehicleCrew]];</code>


| [[createVehicle]],[[crew]], [[driver]] |See also=
| [[createVehicle]],[[crew]], [[driver]]
}}
}}



Revision as of 23:11, 17 January 2021

Hover & click on the images for description

Description

Description:
Moves units into vehicle seats. When units don't exist, it will create them in a group of vehicle's side.
Execution:
call
Groups:
Vehicles

Syntax

Syntax:
[object, params, deleteCrew, anySeat, agents] call BIS_fnc_initVehicleCrew
Parameters:
object: Object
params: Array - In format:
  • 0: crewType: Object or String - unit or unit type (will be created)
  • 1: role: String - Can be:
    • "driver"
    • "turret"
    • "cargo"
  • 2: index: Number or Array - Cargo index or turret path
deleteCrew: Boolean - (Optional, default false) true to delete existing crew
anySeat: Boolean - (Optional, default false) When desired seats are occuppied, move crew in the vehicle to any other available seat
agents: Boolean - (Optional, default false) Create crew as agents
Return Value:
Array - Created units

Examples

Example 1:
[ someVehicle, [player, "driver", 0], true, true ] call BIS_fnc_initVehicleCrew;

Additional Information

See also:
createVehiclecrewdriver

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


Bottom Section