TakeWeapon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (→See Also) |
||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server | {{Server function}} | ||
This function removes a specified weapon from a certain player's inventory. | This function removes a specified weapon or ammo from a certain player's inventory. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool takeWeapon ( player thePlayer, int weaponId )</syntaxhighlight> | <syntaxhighlight lang="lua">bool takeWeapon ( player thePlayer, int weaponId [, int ammo ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePlayer''': A player object referencing the specified player. | *'''thePlayer''': A player object referencing the specified player. | ||
*'''weaponId''': An integer that refers to a [[weapon]] that you wish to remove. | *'''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=== | ||
Returns a ''true'' if the weapon was removed successfully, ''false'' otherwise. | Returns a ''true'' if the weapon/ammo was removed successfully, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example removes | This example removes teargas from player. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler( 'rtear', | |||
function( thePlayer ) | |||
end</syntaxhighlight> | takeWeapon( thePlayer, 17 ) | ||
end | |||
)</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Weapon functions}} | {{Weapon functions|server}} | ||
[[pl:takeWeapon]] | |||
[[ru:takeWeapon]] | |||
Latest revision as of 22:39, 6 September 2024
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
)