SetWeaponAmmo: Difference between revisions

Revision as of 18:46, 6 January 2008

	This article needs checking.
	Reason(s): I cant actually think of a use for this function anymore. giveWeapon is capable of doing everything this function does - and from my testing this function doesnt allow giving ammo to a weapon that shares ammo with another, e.g. giving AK-47 ammo when a player has M4 will not work. --Talidan2 17:06, 29 July 2007 (CDT)

what about getWeaponAmmo, shouldn't we have that? --Norby89 06:49, 13 August 2007 (CDT)

Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo.

bool setWeaponAmmo ( player thePlayer, int weapon, int ammo )

thePlayer: A player object referencing the specified player
weapon: A whole number integer that refers to a weapon ID.
ammo: A whole number integer serving as the ammo amount for the given weapon

Returns a boolean value true or false that tells you if it was successful or not.

This example will give players an M4 weapon with 200 ammo followed by 5 more ammo when they spawn.

-- TODO: Old code was outdated

@@ Line 18: / Line 18: @@
 This example will give players an M4 weapon with 200 ammo followed by 5 more ammo when they spawn.
 <syntaxhighlight lang="lua">
-function scriptOnSpawnpointUse ( thePlayer )
+-- TODO: Old code was outdated
-    giveWeapon ( thePlayer, 31, 200 ) -- Gives the M4 weapon with 200 ammo to any player when they use a spawnpoint
-    setWeaponAmmo ( thePlayer, 31, 50 ) -- Sets ammo to 50 for the M4
-end
-addEventHandler ( "onSpawnpointUse", getRootElement(), scriptOnSpawnpointUse )
 </syntaxhighlight>
 ==See Also==
 {{Weapon functions}}
+{{Example_Needed}}