TakeWeaponAmmo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
takeWeaponAmmo takes a specified ammount of ammo to a certain player, for a specified weapon (if they already have it).
{{Server function}}
{{Deprecated|takeWeapon|}}
 
takeWeaponAmmo takes a specified amount of ammo from a certain player, for a specified weapon (if they already have it).


==Syntax==  
==Syntax==  
Line 10: Line 13:
*'''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


==Example==
==Example==  
<section name="Server" class="server" show="true">
This example will give players an M4 weapon with 200 ammo followed by taking 5 ammo when they spawn.
This example will give players an M4 weapon with 200 ammo followed by taking 5 ammo when they spawn.
<syntaxhighlight lang="lua">function scriptOnSpawnpointUse ( player )
<syntaxhighlight lang="lua">function onSpawnpointUse ( thePlayer )
     giveWeapon ( player, 31, 200 ) -- Gives the M4 weapon with 200 ammo to any player when they use a spawnpoint
     giveWeapon ( thePlayer, 31, 200 )   -- Gives the M4 weapon with 200 ammo to any player when they use a spawnpoint
     takeWeaponAmmo ( player, 31, 5 ) -- Takes 5 ammo from the player's M4
     takeWeaponAmmo ( thePlayer, 31, 5 ) -- Takes 5 ammo from the player's M4
end
end
[lua]addEventHandler ( "onSpawnpointUse", getRootElement(), scriptOnSpawnpointUse )</syntaxhighlight>
addEventHandler ( "onSpawnpointUse", root, onSpawnpointUse )</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Weapon functions}}
{{Weapon functions}}
[[ru:takeWeaponAmmo]]

Latest revision as of 09:17, 4 November 2020

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use takeWeapon instead.


takeWeaponAmmo takes a specified amount of ammo from a certain player, for a specified weapon (if they already have it).

Syntax

takeWeaponAmmo ( 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

Example

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

function onSpawnpointUse ( thePlayer )
    giveWeapon ( thePlayer, 31, 200 )    -- Gives the M4 weapon with 200 ammo to any player when they use a spawnpoint
    takeWeaponAmmo ( thePlayer, 31, 5 )  -- Takes 5 ammo from the player's M4
end
addEventHandler ( "onSpawnpointUse", root, onSpawnpointUse )

See Also