TakeWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 17: Line 17:


==Example==
==Example==
This example removes weapon 28 from player.
This example removes teargas from player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler( 'rtear',
addCommandHandler( 'rtear',

Revision as of 17:15, 18 January 2014

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