TakeAllWeapons: Difference between revisions
Jump to navigation
Jump to search
(→Syntax: thePlayer -> thePed) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function removes every weapons from a specified ped, rendering it unarmed. | This function removes every weapons from a specified [[ped]], rendering it unarmed. | ||
{{Note|Weapons are removed when a ped dies by default. This means that it is only appropriate to use this function while a ped is alive.}} | {{Note|Weapons are removed when a ped dies by default. This means that it is only appropriate to use this function while a ped is alive.}} | ||
| Line 16: | Line 16: | ||
This example removes all weapons from every player | This example removes all weapons from every player | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
takeAllWeapons ( | takeAllWeapons ( root ) --remove all the weapons | ||
outputChatBox ( "Weapons are not permitted!" ) --tell the players why they lost their weapons</syntaxhighlight> | outputChatBox ( "Weapons are not permitted!" ) --tell the players why they lost their weapons</syntaxhighlight> | ||
| Line 22: | Line 22: | ||
{{Weapon functions}} | {{Weapon functions}} | ||
[[ru:takeAllWeapons]] | [[ru:takeAllWeapons]] | ||
[[pl:takeAllWeapons]] | |||
Latest revision as of 07:09, 4 November 2020
This function removes every weapons from a specified ped, rendering it unarmed.
| Note: Weapons are removed when a ped dies by default. This means that it is only appropriate to use this function while a ped is alive. |
Syntax
bool takeAllWeapons ( ped thePed )
Required Arguments
- thePed: A ped element referencing the specified ped
Returns
Returns true if the function succeeded, false otherwise.
Example
This example removes all weapons from every player
takeAllWeapons ( root ) --remove all the weapons outputChatBox ( "Weapons are not permitted!" ) --tell the players why they lost their weapons