RemovePlayerJetPack: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Visual improvement) |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Server function}} | |||
__NOTOC__ | __NOTOC__ | ||
{{Deprecated|removePedJetPack}} | |||
This function is used to remove a player's jetpack. | This function is used to remove a player's jetpack. | ||
| Line 6: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''thePlayer''': The [[player]] you want to remove the jetpack from. | ||
===Returns=== | ===Returns=== | ||
Returns 'true' if the player | Returns ''true'' if the player had a jetpack, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example adds a "jetpack" command in console, which allows toggling of a jetpack. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function jetPackCommand ( source, key ) | function jetPackCommand ( source, key ) | ||
if ( doesPlayerHaveJetPack ( source ) ) then -- if the player has a jetpack | |||
removePlayerJetPack ( source ) -- remove it | |||
else | |||
givePlayerJetPack ( source ) -- otherwise give him one | |||
end | |||
end | end | ||
addCommandHandler ( "jetpack", jetPackCommand ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Player functions}} | {{Player functions}} | ||
Latest revision as of 12:22, 26 June 2014
|
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
Please use removePedJetPack instead. |
This function is used to remove a player's jetpack.
Syntax
bool removePlayerJetPack ( player thePlayer )
Required Arguments
- thePlayer: The player you want to remove the jetpack from.
Returns
Returns true if the player had a jetpack, false otherwise.
Example
This example adds a "jetpack" command in console, which allows toggling of a jetpack.
function jetPackCommand ( source, key )
if ( doesPlayerHaveJetPack ( source ) ) then -- if the player has a jetpack
removePlayerJetPack ( source ) -- remove it
else
givePlayerJetPack ( source ) -- otherwise give him one
end
end
addCommandHandler ( "jetpack", jetPackCommand )
See Also
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState