BIS fnc initVehicleCrew: Difference between revisions

Latest revision as of 17:27, 8 November 2023

1.00

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:: createVehicle crew driver

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: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Vehicles
-|1.00|= Game version
+|descr= Moves units into vehicle seats. When units don't exist, it will create them in a group of vehicle's side.
-____________________________________________________________________________________________
-| <pre>/*
+|s1= [object, params, deleteCrew, anySeat, agents] call [[BIS_fnc_initVehicleCrew]]
-	Author: Karel Moricky
-	Description:
+|p1= object: [[Object]]
-	Moves units into vehicle seats.
-	When units don't exist, it will create them in a group of vehicle's side
-	Parameter(s):
-: OBJECT - vehicle
-: ARRAY in format
-: OBJECT or STRING - unit or unit type (will be created)
-: STRING - role, can be "driver", "turret" or cargo"
-: NUMBER or ARRAY - cargo index or turret path
-(Optional): BOOL - True to delete existing crew (default: false)
-(Optional): BOOL - When desired seats are occuppied, move crew in the vehicle to any other available seat (default: false)
-(Optional): BOOL - True to create units as agents (default: false)
-	Returns:
-	ATTAY of OBJECTS - units
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p2= 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
-| <!-- [] call [[BIS_fnc_initVehicleCrew]]; --> |= Syntax
+|p3= deleteCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to delete existing crew
-|p1= |= Parameter 1
-| |= Return value
+|p4= anySeat: [[Boolean]] - (Optional, default [[false]]) when desired seats are occuppied, move crew in the vehicle to any other available seat
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p5= agents: [[Boolean]] - (Optional, default [[false]]) create crew as [[agents]]
-____________________________________________________________________________________________
-| |= See also
+|r1= [[Array]] - created units
+|x1= <sqf>[someVehicle, [player, "driver", 0], true, true] call BIS_fnc_initVehicleCrew;</sqf>
+|seealso= [[createVehicle]] [[crew]] [[driver]]
 }}
-<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: Vehicles|{{uc:initVehicleCrew}}]]
-[[Category:Functions|{{uc:initVehicleCrew}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:initVehicleCrew}}]]