magazinesAmmoFull: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Reverted edits by HazJ (talk) to last revision by killzone_kid)
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
| arma3


|0.76|= Game version
|0.76
____________________________________________________________________________________________


| Returns array of arrays of all vehicle's magazines with extended information about them. Magazine type is available for loaded magazines only, otherwise it is -1.
|gr1= Unit Inventory


|gr2= Vehicle Inventory


<br><br>'''Output format''':
| Returns array of arrays of all vehicle's magazines with extended information about them.
<br>[[magazine1],[magazine2],[magazine3]...[magazineN]]
{{Feature | important | This command does not return empty magazines from containers, only from the weapon. Use [[magazinesAmmoCargo]] instead.}}


<br><br>'''Magazine format''':
| [[magazinesAmmoFull]] vehicle
<br>0: Magazine class name
<br>1: Magazine current ammo count
<br>2: Magazine state (true - loaded, false - not loaded)
<br>3: Magazine type (-1 - n/a, 0 - grenade, 1 - primary weapon mag, 2 - handgun mag, 4 - secondary weapon mag, 65536 - vehicle mag)
<br>4: Magazine location ("Vest", "Uniform", "Backpack", "") or corresponding [[currentMuzzle]] |= Description
____________________________________________________________________________________________


| [[magazinesAmmoFull]] vehicle |= Syntax
|p1= vehicle: [[Object]] - unit or vehicle


|p1= vehicle: [[Object]] - unit or vehicle.  |= PARAMETER1
|r1= [[Array]] of [[Array]]s in format:
* [[String]]: magazine class name
* [[Number]]: magazine ammo count
* [[Boolean]]: is magazine loaded
* [[Number]]: magazine type:
** -1 = n/a (default if magazine is not loaded)
** 0 - grenade
** 1 - primary weapon mag
** 2 - handgun mag
** 4 - secondary weapon mag
** 4096 - binocular weapon mag
** 65536 - vehicle mag
* [[String]]: magazine location: "Vest", "Uniform", "Backpack", "" or [[currentMuzzle]] if the magazine is loaded


| [[Array]] |= RETURNVALUE
|s2= [[magazinesAmmoFull]] [vehicle, includeEmpty] {{Since|arma3|1.99.146475|y}}
 
|p21= vehicle: [[Object]] - unit or vehicle
 
|p22= includeEmpty: [[Boolean]] - (Optional, default [[false]]) [[true]] to include empty magazines
 
|r2= same as [[#Syntax|Primary Syntax]]
   
   
|x1=<code>_magazinesAmmoFull = [[magazinesAmmoFull]] [[player]];
|x1= <code>_magazinesAmmoFull = [[magazinesAmmoFull]] [[player]];
/*
{{codecomment|/*
[
[
["30Rnd_65x39_caseless_mag",30,false,-1,"Uniform"],
["30Rnd_65x39_caseless_mag",30,false,-1,"Uniform"],
Line 39: Line 50:
["16Rnd_9x21_Mag",16,true,2,"hgun_P07_F"]
["16Rnd_9x21_Mag",16,true,2,"hgun_P07_F"]
]
]
<nowiki>*/</nowiki></code>|= EXAMPLE1
<nowiki/>*/}}</code>


|x2=<code>_magazinesAmmoFull = [[magazinesAmmoFull]] Mi_48;
|x2= <code>_magazinesAmmoFull = [[magazinesAmmoFull]] Mi_48;
/*
{{codecomment|/*
[
[
["250Rnd_30mm_APDS_shells",250,false,-1,""],
["250Rnd_30mm_APDS_shells",250,false,-1,""],
Line 49: Line 60:
["38Rnd_80mm_rockets",38,true,65536,"rockets_Skyfire"]
["38Rnd_80mm_rockets",38,true,65536,"rockets_Skyfire"]
]
]
<nowiki>*/</nowiki></code>|= EXAMPLE2
<nowiki/>*/}}</code>
____________________________________________________________________________________________
 
| [[magazinesAmmo]], [[magazinesAmmoCargo]], [[magazinesDetail]], [[magazines]], [[magazinesTurret]] |= SEEALSO


| |= MPBEHAVIOUR
|seealso= [[magazinesAmmo]], [[magazinesAmmoCargo]], [[magazinesDetail]], [[magazines]], [[magazinesTurret]]
____________________________________________________________________________________________
}}
}}


<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:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->
Line 79: Line 75:
--[[User:Actium|Actium]] ([[User talk:Actium|talk]]) 15:40, 20 December 2014 (CET)
--[[User:Actium|Actium]] ([[User talk:Actium|talk]]) 15:40, 20 December 2014 (CET)
</dd>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on February 10, 2015 - 04:40 (UTC)</dd>
<dd class="notedate">Posted on February 10, 2015 - 04:40 (UTC)</dd>
<dt class="note">[[User:Pierre MGI|Pierre MGI]]</dt>
<dt class="note">[[User:Pierre MGI|Pierre MGI]]</dt>
Line 93: Line 85:


This is the case of WY-55 Hellcat. This function returns an empty array.
This is the case of WY-55 Hellcat. This function returns an empty array.
</dd>
<dd class="notedate">Posted on April 5, 2019 - 22:28 (UTC)</dd>
<dt class="note">[[User:Yuval|Yuval]]</dt>
<dd class="note">
This command does not include magazines loaded into weapons stored inside player's backpack (or every other container).
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 00:51, 17 February 2021

Game1 needed - Version1 needed
Hover & click on the images for description

Description

Description:
This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Groups:
Unit InventoryVehicle Inventory

Syntax

Syntax:
Syntax needed
Parameters:
vehicle: Object - unit or vehicle
Return Value:
Array of Arrays in format:
  • String: magazine class name
  • Number: magazine ammo count
  • Boolean: is magazine loaded
  • Number: magazine type:
    • -1 = n/a (default if magazine is not loaded)
    • 0 - grenade
    • 1 - primary weapon mag
    • 2 - handgun mag
    • 4 - secondary weapon mag
    • 4096 - binocular weapon mag
    • 65536 - vehicle mag
  • String: magazine location: "Vest", "Uniform", "Backpack", "" or currentMuzzle if the magazine is loaded

Alternative Syntax

Syntax:
magazinesAmmoFull [vehicle, includeEmpty] Template:Since
Parameters:
vehicle: Object - unit or vehicle
includeEmpty: Boolean - (Optional, default false) true to include empty magazines
Return Value:
same as Primary Syntax

Examples

Example 1:
_magazinesAmmoFull = magazinesAmmoFull player; /* [ ["30Rnd_65x39_caseless_mag",30,false,-1,"Uniform"], ["30Rnd_65x39_caseless_mag",30,false,-1,"Vest"], ["16Rnd_9x21_Mag",16,false,-1,"Vest"], ["SmokeShellGreen",1,true,0,"SmokeShellGreenMuzzle"], ["Chemlight_green",1,true,0,"ChemlightGreenMuzzle"], ["HandGrenade",1,true,0,"HandGrenadeMuzzle"], ["30Rnd_65x39_caseless_mag",30,true,1,"arifle_MX_ACO_pointer_F"], ["16Rnd_9x21_Mag",16,true,2,"hgun_P07_F"] ] */
Example 2:
_magazinesAmmoFull = magazinesAmmoFull Mi_48; /* [ ["250Rnd_30mm_APDS_shells",250,false,-1,""], ["250Rnd_30mm_HE_shells",250,true,65536,"gatling_30mm"], ["8Rnd_LG_scalpel",8,true,65536,"missiles_SCALPEL"], ["38Rnd_80mm_rockets",38,true,65536,"rockets_Skyfire"] ] */

Additional Information

See also:
magazinesAmmomagazinesAmmoCargomagazinesDetailmagazinesmagazinesTurret

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


Posted on December 20, 2014 - 14:40 (UTC)
Actium
When used on vehicles this will only return all magazines associated with a single turretPath (which one depends on the actual armament of the vehicle, usually the first armed turretPath or alternatively turretPath [-1]).
If you want to get all turrets' magazines, use allTurrets and magazinesTurret. --Actium (talk) 15:40, 20 December 2014 (CET)
Posted on February 10, 2015 - 04:40 (UTC)
Pierre MGI
As Actium said, this function seems to extract data from: configfile >> "CfgVehicles" >> _the_vehicle_you_want >> "Turrets" >> "MainTurret">> "magazines". Some vehicles return an empty field {} because magazines are in straight in: configfile >> "CfgVehicles" >> _the_vehicle_you_want >> "magazines" (often dedicated to flares only). This is the case of WY-55 Hellcat. This function returns an empty array.
Posted on April 5, 2019 - 22:28 (UTC)
Yuval
This command does not include magazines loaded into weapons stored inside player's backpack (or every other container).
Retrieved from "https://community.bistudio.com/wiki?title=magazinesAmmoFull&oldid=247191"