fullCrew: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(44 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |game1= arma3 | ||
|1.34 | |version1= 1.34 | ||
| | |arg= global | ||
| | |gr1= Object Manipulation | ||
| | |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 {{Link|#Example 3}}). | |||
}} | }} | ||
|s1= [[fullCrew]] vehicle | |||
|p1= vehicle: [[Object]] | |||
|r1= [[Array]] - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret, assignedUnit, positionName]: | |||
[[ | * unit: [[Object]] | ||
* role: [[String]] - not always lowercase before {{GVI|arma3|2.04|size= 0.75}} | |||
* cargoIndex: [[Number]] | |||
* turretPath: [[Array]] | |||
* 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] | |||
|p21= vehicle: [[Object]] | |||
< | |||
< | |p22= type: [[String]] - role filter (case-insensitive). An invalid value (e.g "") will return all positions. Available values: | ||
* "driver" | |||
* "commander" | |||
* "gunner" | |||
* "turret" | |||
* "cargo" | |||
</ | |||
|p23= includeEmpty: [[Boolean]] - (Optional, default [[false]]) include empty crew seats | |||
|p23since= arma3 1.56 | |||
|r2= [[Array]] - list of arrays in format [unit, role, cargoIndex, turretPath, personTurret, assignedUnit, positionName]: | |||
* unit: [[Object]] | |||
* role: [[String]] - not always lowercase before {{GVI|arma3|2.04|size= 0.75}} | |||
* cargoIndex: [[Number]] | |||
* turretPath: [[Array]] | |||
* 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= <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= <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= <sqf> | |||
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]; | |||
</sqf> | |||
|seealso= [[crew]] [[createVehicleCrew]] [[assignedVehicleRole]] [[allTurrets]] [[emptyPositions]] | |||
}} |
Latest revision as of 17:05, 29 April 2023
Description
- Description:
- Returns an array with all crew inside given vehicle, with or without empty seats.
- 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]:
- unit: Object
- role: String - not always lowercase before 2.04
- cargoIndex: Number
- turretPath: Array
- personTurret: Boolean
- 2.12 assignedUnit: Object - see assignAsXXX commands, assignAsDriver for example
- 2.12 positionName: String - unlocalized entry for turret's `gunnerName`, for example "$STR_A3_TURRETS_CARGOTURRET_R2"
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 1.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]:
- unit: Object
- role: String - not always lowercase before 2.04
- cargoIndex: Number
- turretPath: Array
- personTurret: Boolean
- 2.12 assignedUnit: Object - see assignAsXXX commands, assignAsDriver for example
- 2.12 positionName: String - unlocalized entry for turret's `gunnerName`, for example "$STR_A3_TURRETS_CARGOTURRET_R2"
Examples
- Example 1:
- Example 2:
- 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
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