TakeAllWeapons: Difference between revisions
Jump to navigation
Jump to search
Enterprise (talk | contribs) No edit summary |
No edit summary |
||
Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">takeAllWeapons ( player thePlayer )</syntaxhighlight> | <syntaxhighlight lang="lua">bool takeAllWeapons ( player thePlayer )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== |
Revision as of 15:50, 14 November 2009
This function removes every weapons from a specified player, rendering him unarmed.
Note: weapons are removed when a player dies by default. This means that it is only appropriate to use this function while a player is alive.
Syntax
bool takeAllWeapons ( player thePlayer )
Required Arguments
- thePlayer: A player object referencing the specified player
Returns
Returns true if the function succeeded, false otherwise.
Example
This example removes all weapons from every player
takeAllWeapons ( getRootElement() ) --remove all the weapons outputChatBox ( "Weapons are not permitted!" ) --tell the players why they lost their weapons