GiveWeaponAmmo: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
No edit summary |
||
| (13 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | |||
{{Deprecated|giveWeapon|}} | |||
<!-- | |||
{{Needs_Checking|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. --[[User:Talidan2|Talidan2]] 17:06, 29 July 2007 (CDT)}} | |||
--> | |||
giveWeaponAmmo gives a specified ammount of ammo to a certain player, for a specified weapon (if they already have it). | giveWeaponAmmo gives a specified ammount of ammo to a certain player, for a specified weapon (if they already have it). | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">giveWeaponAmmo ( player thePlayer, int weapon, int ammo )</syntaxhighlight> | <syntaxhighlight lang="lua"> bool giveWeaponAmmo ( player thePlayer, int weapon, int ammo )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 9: | Line 14: | ||
*'''weapon:''' A whole number integer that refers to a [[weapon]] ID. | *'''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 | *'''ammo:''' A whole number integer serving as the ammo amount for the given weapon | ||
==Returns== | |||
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not. | |||
==Example== | ==Example== | ||
This example will give players an M4 weapon with 200 ammo followed by 5 more ammo when they spawn. | This example will give players an M4 weapon with 200 ammo followed by 5 more ammo when they spawn. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | function scriptOnSpawnpointUse ( thePlayer ) | ||
giveWeapon ( | giveWeapon ( thePlayer, 31, 200 ) -- Gives the M4 weapon with 200 ammo to any player when they use a spawnpoint | ||
giveWeaponAmmo ( | giveWeaponAmmo ( thePlayer, 31, 5 ) -- Gives the player 5 more ammo for the M4 | ||
end</syntaxhighlight> | end | ||
addEventHandler ( "onSpawnpointUse", root, onSpawnpointUse )</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Weapon functions}} | {{Weapon functions}} | ||
[[ru:giveWeaponAmmo]] | |||
Latest revision as of 08:35, 4 November 2020
|
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
Please use giveWeapon instead. |
giveWeaponAmmo gives a specified ammount of ammo to a certain player, for a specified weapon (if they already have it).
Syntax
bool giveWeaponAmmo ( player thePlayer, int weapon, int ammo )
Required Arguments
- 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
Returns a boolean value true or false that tells you if it was successful or not.
Example
This example will give players an M4 weapon with 200 ammo followed by 5 more ammo when they spawn.
function scriptOnSpawnpointUse ( thePlayer )
giveWeapon ( thePlayer, 31, 200 ) -- Gives the M4 weapon with 200 ammo to any player when they use a spawnpoint
giveWeaponAmmo ( thePlayer, 31, 5 ) -- Gives the player 5 more ammo for the M4
end
addEventHandler ( "onSpawnpointUse", root, onSpawnpointUse )