SetWeaponClipAmmo: Difference between revisions

Revision as of 17:22, 23 December 2014

This function sets the ammo left in a custom weapon's magazine/clip.

Syntax

bool setWeaponClipAmmo ( weapon theWeapon, int clipAmmo )

Required Arguments

theWeapon: The weapon to set the clip ammo of.
clipAmmo: The amount of ammo in the clip.

Returns

This function returns true if the arguments are valid and the weapon clip ammo could be changed; fañse otherwise.

Example

This example adds a /weapon command that creates a M4 where the player uses it, and gives 1 clip ammo to it.

function createWeaponWithLowClipAmmo()
	local wep = createWeapon("m4", getElementPosition(localPlayer))
	setWeaponClipAmmo(wep, 1) -- Give the weapon 1 clip ammo, so it will reload at the next shoot.
end
addCommandHandler("weapon", createWeaponWithLowClipAmmo)

Requirements

This template will be deleted.

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Set the ammo in a custom weapons magazine/clip.
+This function sets the ammo left in a [[Element/Weapon|custom weapon]]'s magazine/clip.
 ==Syntax==
@@ Line 9: / Line 9: @@
 * '''theWeapon:''' The [[Element/Weapon|weapon]] to set the clip ammo of.
 * '''clipAmmo:''' The amount of ammo in the clip.
-===Example===
+===Returns===
+This function returns ''true'' if the arguments are valid and the weapon clip ammo could be changed; ''fañse'' otherwise.
+==Example==
+This example adds a ''/weapon'' command that creates a M4 where the player uses it, and gives 1 clip ammo to it.
 <syntaxhighlight lang="lua">
-function createWepCmd()
+function createWeaponWithLowClipAmmo()
-	local wep = createWeapon("m4", 0, 0, 0)
+	local wep = createWeapon("m4", getElementPosition(localPlayer))
-	setWeaponClipAmmo(wep, 50)
+	setWeaponClipAmmo(wep, 1) -- Give the weapon 1 clip ammo, so it will reload at the next shoot.
 end
-addCommandHandler("weapon", createWepCmd)
+addCommandHandler("weapon", createWeaponWithLowClipAmmo)
 </syntaxhighlight>
 ==Requirements==
 {{Requirements|n/a|1.3.0-9.04555|}}
-==See Also==
+==See also==
 {{Weapon functions}}