magazinesTurret: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
(option empty mags)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns all magazines of given turret. Use turret path [-1] for driver's turret. Alternatively, use [[magazinesAllTurrets]]|DESCRIPTION=
| Returns all magazines of given turret. Use turret path [-1] for driver's turret. Alternatively, use [[magazinesAllTurrets]].
{{Informative | When main syntax is used, command excludes empty magazines for driver turret [-1] but returns empty magazines for all other turrets. Since Arma 3 v2.01.146669 alternative syntax is available that make empty magazine handling optional and consistent.}}|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 18: Line 19:


| [[Array]] of [[String|Strings]] |RETURNVALUE=
| [[Array]] of [[String|Strings]] |RETURNVALUE=
| s2=vehicle '''magazinesTurret''' [turretPath, includeEmpty]       (Since Arma 3 v2.01.146669)|SYNTAX2=
|p21= vehicle: [[Object]] |PARAMETER21=
|p22= [turretPath, includeEmpty]: [[Array]] |PARAMETER22=
|p23= turretPath: [[Array]] - turret path |PARAMETER23=
|p24= includeEmpty (Optional): [[Bool]], [[true]] - include empty magazines, [[false]] - exclude empty magazines, not defined - old behavior (see description)|PARAMETER24=
| r2=[[Array]] of [[String|Strings]] |RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   

Revision as of 11:51, 7 September 2020

Hover & click on the images for description

Description

Description:
Returns all magazines of given turret. Use turret path [-1] for driver's turret. Alternatively, use magazinesAllTurrets.
When main syntax is used, command excludes empty magazines for driver turret [-1] but returns empty magazines for all other turrets. Since Arma 3 v2.01.146669 alternative syntax is available that make empty magazine handling optional and consistent.
Groups:
Uncategorised

Syntax

Syntax:
vehicle magazinesTurret turretPath
Parameters:
vehicle: Object
turretPath: Array
Return Value:
Array of Strings

Alternative Syntax

Syntax:
vehicle magazinesTurret [turretPath, includeEmpty]       (Since Arma 3 v2.01.146669)
Parameters:
vehicle: Object
[turretPath, includeEmpty]: Array
turretPath: Array - turret path
includeEmpty (Optional): Bool, true - include empty magazines, false - exclude empty magazines, not defined - old behavior (see description)
Return Value:
Array of Strings

Examples

Example 1:
_mags = vehicle player magazinesTurret [0, 0];
Example 2:
_mags = _tank magazinesTurret [0];

Additional Information

See also:
magazinesAllTurretsaddMagazineTurretremoveMagazinesTurretremoveMagazineTurretweaponsTurretloadMagazinemagazinesmagazinesDetail, magazinesAmmomagazinesAmmoFulladdWeaponTurretremoveWeaponTurretturretLocal

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