magazinesTurret: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Add alt syntax example for better comprehension)
 
(47 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2oa |Game name=
|game1= arma2oa
|version1= 1.52


|1.52|Game version=
|game2= tkoh
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma3
|version3= 0.50


|gr1= Turrets |GROUP1=
|arg= global
____________________________________________________________________________________________


| Returns all magazines of given turret. Use turret path [-1] for driver's turret. Alternatively, use [[magazinesAllTurrets]].
|gr1= Turrets
{{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 makes empty magazine handling optional and consistent.}}|DESCRIPTION=
____________________________________________________________________________________________


| vehicle '''magazinesTurret''' turretPath|SYNTAX=
|descr= Returns all magazines of given turret. Use turret path [-1] for driver's turret. Alternatively, use [[magazinesAllTurrets]].
{{Feature|informative|When main syntax is used, command excludes empty magazines for driver turret [-1] but returns empty magazines for all the other turrets.}}


|p1= vehicle: [[Object]] |PARAMETER1=
|s1= vehicle [[magazinesTurret]] turretPath
|p2= turretPath: [[Array]] |PARAMETER2=


| [[Array]] of [[String|Strings]] |RETURNVALUE=
|p1= vehicle: [[Object]]


| s2=vehicle '''magazinesTurret''' [turretPath, includeEmpty]       (Since Arma 3 v2.01.146669)|SYNTAX2=
|p2= turretPath: [[Array]] format [[Turret Path]]


|p21= vehicle: [[Object]] |PARAMETER21=
|r1= [[Array]] of [[String]]s
|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=
|s2= vehicle [[magazinesTurret]] [turretPath, includeEmpty]
____________________________________________________________________________________________
 
|x1= <code>_mags = [[vehicle]] [[player]] [[magazinesTurret]] [0, 0];</code> |EXAMPLE1=
|x2= <code>_mags = _tank [[magazinesTurret]] [0];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[magazinesAllTurrets]], [[addMagazineTurret]], [[removeMagazinesTurret]], [[removeMagazineTurret]], [[weaponsTurret]], [[loadMagazine]], [[magazines]], [[magazinesDetail]],  [[magazinesAmmo]], [[magazinesAmmoFull]], [[addWeaponTurret]], [[removeWeaponTurret]], [[turretLocal]] |SEEALSO=
|s2since= arma3 2.02


}}
|p21= vehicle: [[Object]]
 
|p22= turretPath: [[Array]] format [[Turret Path]]
 
|p23= includeEmpty: [[Boolean]] - (Optional, default [[true]]) - [[true]] = include empty magazines (behaviour as the primary syntax, but consistent), [[false]] = exclude empty magazines
 
|r2= [[Array]] of [[String]]s


<h3 style="display:none">Notes</h3>
|x1= <sqf>_mags = vehicle player magazinesTurret [0, 0];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>_mags = _tank magazinesTurret [[0], false];</sqf>


[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|seealso= [[magazinesAllTurrets]] [[addMagazineTurret]] [[removeMagazinesTurret]] [[removeMagazineTurret]] [[weaponsTurret]] [[loadMagazine]] [[magazines]] [[magazinesDetail]] [[magazinesAmmo]] [[magazinesAmmoFull]] [[addWeaponTurret]] [[removeWeaponTurret]] [[turretLocal]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:30, 22 November 2024

A2 OA Logo.png1.52tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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 the other turrets.
Groups:
Turrets

Syntax

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

Alternative Syntax

Syntax:
vehicle magazinesTurret [turretPath, includeEmpty]
Parameters:
vehicle: Object
turretPath: Array format Turret Path
includeEmpty: Boolean - (Optional, default true) - true = include empty magazines (behaviour as the primary syntax, but consistent), false = exclude empty magazines
Return Value:
Array of Strings

Examples

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

Additional Information

See also:
magazinesAllTurrets addMagazineTurret removeMagazinesTurret removeMagazineTurret weaponsTurret loadMagazine magazines magazinesDetail magazinesAmmo magazinesAmmoFull addWeaponTurret removeWeaponTurret turretLocal

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=magazinesTurret&oldid=370313"