getCompatiblePylonMagazines: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *arma3 * \| +([0-2]\.[0-9]{2}) * " to "|game1= arma3 |version1= $1 ")
m (Some wiki formatting)
 
(12 intermediate revisions by 3 users not shown)
Line 8: Line 8:
|descr= Get array of compatible pylon magazines
|descr= Get array of compatible pylon magazines


|s1= vehicle [[getCompatiblePylonMagazines]] pylon
|s1= vehicle [[getCompatiblePylonMagazines]] pylon


|p1= vehicle: [[Object]] - aircraft object
|p1= vehicle: [[Object]] or [[String]] - aircraft object or config class
|p2= pylon: [[Number]] - pylon id or [[String]] - pylon class name from <tt>TransportPylonsComponent &gt;&gt; pylons</tt> class (see Example 4). 0 or "" to return all compatible magazines from all pylons


|r1= [[Array]]
|p2= pylon: [[Number]] or [[String]]
* If [[String]] - pylon class name from {{hl|TransportPylonsComponent &gt;&gt; pylons}} class
* If [[Number]] - pylon ID
* If an invalid pylon ID or class name is provided, such as 0 or "", all compatible magazines from all pylons are returned.


|s2= vehicleClass [[getCompatiblePylonMagazines]] pylon
|r1= [[Array]] of [[String]]s, or [[Array]] of [[Array]] of [[String]]s


|p21= vehicleClass: [[String]] - aircraft config class
|x1= <sqf>
|p22= pylon: [[Number]] - pylon id or [[String]] - pylon class name from |<tt>TransportPylonsComponent &gt;&gt; pylons</tt> class (see Example 4). 0 or "" to return all compatible magazines from all pylons
// returns array of arrays containing all compatible magazines
vehicle player getCompatiblePylonMagazines 0;
</sqf>


|r2= [[Array]]
|x2= <sqf>
// returns array of compatible magazines for the 3rd pylon if it exists; otherwise returns array of arrays (see above)
jet1 getCompatiblePylonMagazines 3;
</sqf>


|x1= <code>[[vehicle]] [[player]] [[getCompatiblePylonMagazines]] 0; {{cc|returns array of arrays containing all compatible magazines}}</code>
|x3= <sqf>
|x2= <code>"Plane_Fighter_01_Base_F" [[getCompatiblePylonMagazines]] 3; {{cc|returns array of compatible magazines for the 3rd pylon}}</code>
// returns array of compatible magazines for "pylon1" class, defined in
|x3= <code>jet1 [[getCompatiblePylonMagazines]] "pylon1"; {{cc|returns array of compatible magazines for the 1st pylon}}</code>
// configFile >> "CfgVehicles" >> "B_Plane_CAS_01_dynamicLoadout_F" >> "Components" >> "TransportPylonsComponent" >> "Pylons"
"B_Plane_CAS_01_dynamicLoadout_F" getCompatiblePylonMagazines "pylon1";
</sqf>


|seealso= [[Arma 3: Vehicle Loadouts]],[[getPylonMagazines]],[[setAmmoOnPylon]],[[ammoOnPylon]],[[animatePylon]],[[animateBay]],[[setPylonsPriority]],[[setPylonLoadout]]
|seealso= [[Arma 3: Vehicle Loadouts]] [[getPylonMagazines]] [[setAmmoOnPylon]] [[ammoOnPylon]] [[animatePylon]] [[animateBay]] [[setPylonsPriority]] [[setPylonLoadout]]
}}
}}

Latest revision as of 20:43, 7 May 2022

Hover & click on the images for description

Description

Description:
Get array of compatible pylon magazines
Groups:
Vehicle Loadouts

Syntax

Syntax:
vehicle getCompatiblePylonMagazines pylon
Parameters:
vehicle: Object or String - aircraft object or config class
pylon: Number or String
  • If String - pylon class name from TransportPylonsComponent >> pylons class
  • If Number - pylon ID
  • If an invalid pylon ID or class name is provided, such as 0 or "", all compatible magazines from all pylons are returned.
Return Value:
Array of Strings, or Array of Array of Strings

Examples

Example 1:
// returns array of arrays containing all compatible magazines vehicle player getCompatiblePylonMagazines 0;
Example 2:
// returns array of compatible magazines for the 3rd pylon if it exists; otherwise returns array of arrays (see above) jet1 getCompatiblePylonMagazines 3;
Example 3:
// returns array of compatible magazines for "pylon1" class, defined in // configFile >> "CfgVehicles" >> "B_Plane_CAS_01_dynamicLoadout_F" >> "Components" >> "TransportPylonsComponent" >> "Pylons" "B_Plane_CAS_01_dynamicLoadout_F" getCompatiblePylonMagazines "pylon1";

Additional Information

See also:
Arma 3: Vehicle Loadouts getPylonMagazines setAmmoOnPylon ammoOnPylon animatePylon animateBay setPylonsPriority setPylonLoadout

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