TakeWeapon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 15: | Line 15: | ||
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 ID 1. If successful, it displays a message in the chat box. | ||
<syntaxhighlight lang="lua">player = getPlayerFromID ( 1 ) | <syntaxhighlight lang="lua">player = getPlayerFromID ( 1 ) | ||
if ( | if ( takeWeapon ( player, 28 ) ) | ||
outputChatBox ( "Weapon 28 removed from ", getPlayerName ( player ), "." ) | outputChatBox ( "Weapon 28 removed from ", getPlayerName ( player ), "." ) | ||
end</syntaxhighlight> | end</syntaxhighlight> | ||
Revision as of 16:16, 4 December 2006
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