TakeWeapon

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 weapon 28 from player ID 1. If successful, it displays a message in the chat box.

thePlayer = getPlayerFromID ( 1 )
if ( takeWeapon ( thePlayer, 28 ) )
    outputChatBox ( "Weapon 28 removed from " .. getPlayerName ( thePlayer ) .. "." )
end

This example will give the player an M4 weapon with 200 ammo followed by taking 5 ammo

giveWeapon ( thePlayer, 31, 200 )    -- Gives the M4 weapon with 200 ammo
takeWeapon ( thePlayer, 31, 5 )      -- Takes 5 ammo from the player's M4

See Also

• getWeaponProperty
• getPickupWeapon
• getOriginalWeaponProperty
• getSlotFromWeapon
• getWeaponIDFromName
• getWeaponNameFromID
• setWeaponAmmo
• setWeaponProperty