TakeWeapon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | |||
This function removes a specified weapon from a certain player's inventory. | This function removes a specified weapon from a certain player's inventory. | ||
| Line 16: | Line 17: | ||
<syntaxhighlight lang="lua">player = getPlayerFromID ( 1 ) | <syntaxhighlight lang="lua">player = getPlayerFromID ( 1 ) | ||
if ( takeWeapon ( player, 28 ) ) | if ( takeWeapon ( player, 28 ) ) | ||
outputChatBox ( "Weapon 28 removed from " .. getPlayerName ( player ) .. "." ) | |||
end</syntaxhighlight> | end</syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Weapon functions}} | {{Weapon functions}} | ||
Revision as of 18:07, 15 August 2007
This function removes a specified weapon from a certain player's inventory.
Syntax
bool takeWeapon ( player thePlayer, int weaponId )
Required Arguments
- thePlayer: A player object referencing the specified player.
- weaponId: An integer that refers to a weapon that you wish to remove.
Returns
Returns a true if the weapon 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.
player = getPlayerFromID ( 1 )
if ( takeWeapon ( player, 28 ) )
outputChatBox ( "Weapon 28 removed from " .. getPlayerName ( player ) .. "." )
end
See Also
- getWeaponProperty
- getPickupWeapon
- getOriginalWeaponProperty
- getSlotFromWeapon
- getWeaponIDFromName
- getWeaponNameFromID
- setWeaponAmmo
- setWeaponProperty