TakeAllWeapons: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function removes every weapons from a specified player, rendering him unarmed. | |||
This function removes every weapons from a specified player, rendering him unarmed | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">TakeAllWeapons ( | <syntaxhighlight lang="lua">TakeAllWeapons ( thePlayer )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''thePlayer''': A [[player]] object referencing the specified player | ||
===Returns=== | |||
Returns ''true'' if the function succeeded, ''false'' otherwise. | |||
==Example== | ==Example== | ||
Revision as of 11:27, 14 August 2006
This function removes every weapons from a specified player, rendering him unarmed.
Syntax
TakeAllWeapons ( thePlayer )
Required Arguments
- thePlayer: A player object referencing the specified player
Returns
Returns true if the function succeeded, false otherwise.
Example
player = getPlayerFromID ( 1 ) TakeAllWeapons ( player ) outputChatBox ( "All weapons removed from ", getPlayerName ( player ), "." )
See Also
- getWeaponProperty
- getPickupWeapon
- getOriginalWeaponProperty
- getSlotFromWeapon
- getWeaponIDFromName
- getWeaponNameFromID
- setWeaponAmmo
- setWeaponProperty