setAmmo: Difference between revisions
m (See Also ammo) |
m (template:command argument fix) |
||
| Line 16: | Line 16: | ||
| unit '''setAmmo''' [weapon, count] |= Syntax | | unit '''setAmmo''' [weapon, count] |= Syntax | ||
|p1= unit: [[Object]] - Gunner or vehicle. |= | |p1= unit: [[Object]] - Gunner or vehicle. |PARAMETER1= | ||
|p2= [weapon, count]: [[Array]] |= | |p2= [weapon, count]: [[Array]] |PARAMETER2= | ||
|p3= weapon: [[String]] |= | |p3= weapon: [[String]] |PARAMETER3= | ||
|p4= count: [[Number]] |= | |p4= count: [[Number]] |PARAMETER4= | ||
| [[Nothing]] |= | | [[Nothing]] |RETURNVALUE= | ||
|x1= Set player's handgun magazine ammo count to 10 rounds: | |x1= Set player's handgun magazine ammo count to 10 rounds: | ||
<code>[[player]] [[setAmmo]] <nowiki>[</nowiki>[[handgunWeapon]] [[player]], 10];</code>|= | <code>[[player]] [[setAmmo]] <nowiki>[</nowiki>[[handgunWeapon]] [[player]], 10];</code>|EXAMPLE1= | ||
|x2= Set player's current weapon magazine ammo count to 1 round: | |x2= Set player's current weapon magazine ammo count to 1 round: | ||
<code>[[player]] [[setAmmo]] <nowiki>[</nowiki>[[currentWeapon]] [[player]], 1];</code>|= | <code>[[player]] [[setAmmo]] <nowiki>[</nowiki>[[currentWeapon]] [[player]], 1];</code>|EXAMPLE2= | ||
|x3= If player is a gunner in a vehicle, set current weapon magazine ammo count to 5 rounds: | |x3= If player is a gunner in a vehicle, set current weapon magazine ammo count to 5 rounds: | ||
<code>[[if]] ([[local]] [[vehicle]] [[player]]) [[then]] { | <code>[[if]] ([[local]] [[vehicle]] [[player]]) [[then]] { | ||
| Line 36: | Line 36: | ||
} [[else]] { | } [[else]] { | ||
[[hint]] "Vehicle must be local to this machine for 'setAmmo' to work"; | [[hint]] "Vehicle must be local to this machine for 'setAmmo' to work"; | ||
};</code>|= | };</code>|EXAMPLE3= | ||
|x4= If you try to set more ammo than the magazine can hold, it will be clipped at default magazine capacity: | |x4= If you try to set more ammo than the magazine can hold, it will be clipped at default magazine capacity: | ||
<code>[[player]] [[setAmmo]] <nowiki>[</nowiki>[[primaryWeapon]] [[player]], 1000000]; //full mag with default ammo count | <code>[[player]] [[setAmmo]] <nowiki>[</nowiki>[[primaryWeapon]] [[player]], 1000000]; //full mag with default ammo count | ||
</code>|= | </code>|EXAMPLE4= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[ammo]], [[setFuel]], [[setHit]] |= | | [[ammo]], [[setFuel]], [[setHit]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 10:36, 7 April 2019
Description
- Description:
- Sets custom ammo count in the currently loaded magazine of the specified weapon. The unit must be local to the computer where command is executed.
- Groups:
- Uncategorised
Syntax
- Syntax:
- unit setAmmo [weapon, count]
- Parameters:
- unit: Object - Gunner or vehicle.
- [weapon, count]: Array
- weapon: String
- count: Number
- Return Value:
- Nothing
Examples
- Example 1:
- Set player's handgun magazine ammo count to 10 rounds:
player setAmmo [handgunWeapon player, 10]; - Example 2:
- Set player's current weapon magazine ammo count to 1 round:
player setAmmo [currentWeapon player, 1]; - Example 3:
- If player is a gunner in a vehicle, set current weapon magazine ammo count to 5 rounds:
if (local vehicle player) then { vehicle player setAmmo [currentWeapon vehicle player, 5]; } else { hint "Vehicle must be local to this machine for 'setAmmo' to work"; }; - Example 4:
- If you try to set more ammo than the magazine can hold, it will be clipped at default magazine capacity:
player setAmmo [primaryWeapon player, 1000000]; //full mag with default ammo count
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