TakeWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function removes a specified weapon or ammo from a certain player's inventory.
This function removes a specified weapon or ammo from a certain player's inventory.


Line 17: Line 17:


==Example==
==Example==
This example removes weapon 28 from player ID 1. If successful, it displays a message in the chat box.
This example removes teargas from player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
thePlayer = getPlayerFromID ( 1 )
addCommandHandler( 'rtear',
if ( takeWeapon ( thePlayer, 28 ) )
  function( thePlayer )
     outputChatBox ( "Weapon 28 removed from " .. getPlayerName ( thePlayer ) .. "." )
     takeWeapon( thePlayer, 17 )
end</syntaxhighlight>
  end
 
)</syntaxhighlight>
This example will give the player an M4 weapon with 200 ammo followed by taking 5 ammo
<syntaxhighlight lang="lua">
giveWeapon ( thePlayer, 31, 200 )    -- Gives the M4 weapon with 200 ammo
takeWeapon ( thePlayer, 31, 5 )     -- Takes 5 ammo from the player's M4
</syntaxhighlight>
 


==See Also==
==See Also==
{{Weapon functions}}
{{Weapon functions}}
[[pl:takeWeapon]]
[[ru:takeWeapon]]
[[ru:takeWeapon]]

Latest revision as of 17:44, 13 September 2018

This function removes a specified weapon or ammo from a certain player's inventory.

Syntax

bool takeWeapon ( player thePlayer, int weaponId [, int ammo ] )

Required Arguments

  • thePlayer: A player object referencing the specified player.
  • weaponId: An integer that refers to a weapon that you wish to remove.

Optional Arguments

  • ammo: If used, this amount of ammo will be taken instead and the weapon will not be removed.

Returns

Returns a true if the weapon/ammo was removed successfully, false otherwise.

Example

This example removes teargas from player.

addCommandHandler( 'rtear',
  function( thePlayer )
    takeWeapon( thePlayer, 17 )
  end
)

See Also