TakeWeapon: Difference between revisions

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

Revision as of 17:13, 18 January 2014

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

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

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

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

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

 function( thePlayer )
   takeWeapon( thePlayer, 17 )
 end

)/code>

@@ Line 17: / Line 17: @@
 ==Example==
-This example removes weapon 28 from player ID 1. If successful, it displays a message in the chat box.
+This example removes weapon 28 from player.
 <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
+)/code>
-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==
 {{Weapon functions}}
 [[ru:takeWeapon]]