fullCrew: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[#Examples\|Example ([0-9])\]\]" to "{{HashLink|#Example $1}}")
m (Some wiki formatting)
 
(11 intermediate revisions by 2 users not shown)
Line 10: Line 10:
|descr= Returns an array with all crew inside given vehicle, with or without empty seats.
|descr= Returns an array with all crew inside given vehicle, with or without empty seats.


{{Feature | important | With the introduction of person turrets (FFV), the returned ''cargoIndex'' works with [[moveInCargo]] but does not with [[action]]s such as "GetInCargo" and "MoveToCargo". To find out indexes for actions, use the "cargo" filter (See {{HashLink|#Example 3}}).}}
{{Feature|important|
With the introduction of person turrets (FFV), the returned ''cargoIndex'' works with [[moveInCargo]] but does not with [[action]]s such as "GetInCargo" and "MoveToCargo".
To find out indexes for actions, use the "cargo" filter (See {{Link|#Example 3}}).
}}


|s1= [[fullCrew]] vehicle
|s1= [[fullCrew]] vehicle
Line 16: Line 19:
|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]


|r1= [[Array]] - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret]:
|r1= [[Array]] - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret, assignedUnit, positionName]:
* unit: [[Object]]
* unit: [[Object]]
* role: [[String]] - not always lowercase (from 2.03 always lower case)
* role: [[String]] - not always lowercase before {{GVI|arma3|2.04|size= 0.75}}
* cargoIndex: [[Number]]
* cargoIndex: [[Number]]
* turretPath: [[Array]]
* turretPath: [[Array]]
* personTurret: [[Boolean]]
* personTurret: [[Boolean]]
* {{GVI|arma3|2.12|size= 0.75}} assignedUnit: [[Object]] - see ''assignAsXXX'' commands, [[assignAsDriver]] for example
* {{GVI|arma3|2.12|size= 0.75}} positionName: [[String]] - un[[localize]]d entry for turret's `gunnerName`, for example "$STR_A3_TURRETS_CARGOTURRET_R2"


|s2= [[fullCrew]] [vehicle, type, includeEmpty]
|s2= [[fullCrew]] [vehicle, type, includeEmpty]
Line 37: Line 42:
|p23since= arma3 1.56
|p23since= arma3 1.56


|r2= [[Array]] - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret]:
|r2= [[Array]] - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret, assignedUnit, positionName]:
* unit: [[Object]]
* unit: [[Object]]
* role: [[String]] - not always lowercase (from 2.03 always lower case)
* role: [[String]] - not always lowercase before {{GVI|arma3|2.04|size= 0.75}}
* cargoIndex: [[Number]]
* cargoIndex: [[Number]]
* turretPath: [[Array]]
* turretPath: [[Array]]
* personTurret: [[Boolean]]
* personTurret: [[Boolean]]
* {{GVI|arma3|2.12|size= 0.75}} assignedUnit: [[Object]] - see ''assignAsXXX'' commands, [[assignAsDriver]] for example
* {{GVI|arma3|2.12|size= 0.75}} positionName: [[String]] - un[[localize]]d entry for turret's `gunnerName`, for example "$STR_A3_TURRETS_CARGOTURRET_R2"


|x1= <code>_list = [[fullCrew]] [[vehicle]] [[player]];</code>
|x1= <sqf>
_list = fullCrew vehicle player;
/*
returns for example (on an armed WY-55 Hellcat):
[
[R Alpha 1-1:1, "driver", -1, [], false, R Alpha 1-1:1, "$STR_POSITION_DRIVER"],
[R Alpha 1-1:2, "turret", -1, [0], false, R Alpha 1-1:2, "$STR_A3_COPILOT"]
]
*/
</sqf>


|x2= <code>_list = [[fullCrew]] [<nowiki/>[[vehicle]] [[player]], "turret"];</code>
|x2= <sqf>
_list = fullCrew [vehicle player, "turret"];
/*
returns for example (on an armed WY-55 Hellcat):
[
[R Alpha 1-1:2, "turret", -1, [0], false, R Alpha 1-1:2, "$STR_A3_COPILOT"]
]
*/
</sqf>


|x3= <code>[[private]] _actionCompatibleCargoIndexes = [[fullCrew]] [heli, "cargo", [[true]]];
|x3= <sqf>
{{codecomment|/*
private _actionCompatibleCargoIndexes = fullCrew [heli, "cargo", true];
returns for example (on an armed WY-55 Hellcat):
/*
returns for example (on an empty armed WY-55 Hellcat):
[
[
[<nowiki/>[[objNull]], "cargo" ,2, [], [[false]]],
[objNull, "cargo", 2, [], false, objNull, "$STR_GETIN_POS_PASSENGER"],
[<nowiki/>[[objNull]], "cargo", 3, [], [[false]]],
[objNull, "cargo", 3, [], false, objNull, "$STR_GETIN_POS_PASSENGER"],
[<nowiki/>[[objNull]], "cargo", 4, [], [[false]]],
[objNull, "cargo", 4, [], false, objNull, "$STR_GETIN_POS_PASSENGER"],
[<nowiki/>[[objNull]], "cargo", 5, [], [[false]]]
[objNull, "cargo", 5, [], false, objNull, "$STR_GETIN_POS_PASSENGER"]
]
]
using the element's index is compatible with action cargo commands - see below
using the element's index is compatible with action cargo commands - see below
<nowiki/>*/}}
*/


{{cc|the following commands will put the player in the same seat:}}
// the following commands will put the player in the same seat:
[[player]] [[moveInCargo]] [heli, 2];
player moveInCargo [heli, 2];
[[player]] [[action]] ["GetInCargo", heli, 0];
player action ["GetInCargo", heli, 0];
</code>
</sqf>


|seealso= [[crew]], [[createVehicleCrew]], [[assignedVehicleRole]], [[allTurrets]]
|seealso= [[crew]] [[createVehicleCrew]] [[assignedVehicleRole]] [[allTurrets]] [[emptyPositions]]
}}
}}

Latest revision as of 17:05, 29 April 2023

Arma 3 logo black.png1.34
GAGlobal
Hover & click on the images for description

Description

Description:
Returns an array with all crew inside given vehicle, with or without empty seats.
⚠
With the introduction of person turrets (FFV), the returned cargoIndex works with moveInCargo but does not with actions such as "GetInCargo" and "MoveToCargo". To find out indexes for actions, use the "cargo" filter (See Example 3).
Groups:
Object Manipulation

Syntax

Syntax:
fullCrew vehicle
Parameters:
vehicle: Object
Return Value:
Array - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret, assignedUnit, positionName]:

Alternative Syntax

Syntax:
fullCrew [vehicle, type, includeEmpty]
Parameters:
vehicle: Object
type: String - role filter (case-insensitive). An invalid value (e.g "") will return all positions. Available values:
  • "driver"
  • "commander"
  • "gunner"
  • "turret"
  • "cargo"
since Arma 3 logo black.png1.56
includeEmpty: Boolean - (Optional, default false) include empty crew seats
Return Value:
Array - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret, assignedUnit, positionName]:

Examples

Example 1:
_list = fullCrew vehicle player; /* returns for example (on an armed WY-55 Hellcat): [ [R Alpha 1-1:1, "driver", -1, [], false, R Alpha 1-1:1, "$STR_POSITION_DRIVER"], [R Alpha 1-1:2, "turret", -1, [0], false, R Alpha 1-1:2, "$STR_A3_COPILOT"] ] */
Example 2:
_list = fullCrew [vehicle player, "turret"]; /* returns for example (on an armed WY-55 Hellcat): [ [R Alpha 1-1:2, "turret", -1, [0], false, R Alpha 1-1:2, "$STR_A3_COPILOT"] ] */
Example 3:
private _actionCompatibleCargoIndexes = fullCrew [heli, "cargo", true]; /* returns for example (on an empty armed WY-55 Hellcat): [ [objNull, "cargo", 2, [], false, objNull, "$STR_GETIN_POS_PASSENGER"], [objNull, "cargo", 3, [], false, objNull, "$STR_GETIN_POS_PASSENGER"], [objNull, "cargo", 4, [], false, objNull, "$STR_GETIN_POS_PASSENGER"], [objNull, "cargo", 5, [], false, objNull, "$STR_GETIN_POS_PASSENGER"] ] using the element's index is compatible with action cargo commands - see below */ // the following commands will put the player in the same seat: player moveInCargo [heli, 2]; player action ["GetInCargo", heli, 0];

Additional Information

See also:
crew createVehicleCrew assignedVehicleRole allTurrets emptyPositions

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=fullCrew&oldid=340310"