RemovePlayerJetPack: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
No edit summary  | 
				No edit summary  | 
				||
| Line 1: | Line 1: | ||
{{Server function}}  | |||
__NOTOC__  | __NOTOC__  | ||
This function is used to remove a player's jetpack.  | This function is used to remove a player's jetpack.  | ||
| Line 6: | Line 7: | ||
===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==  | ||
<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}}  | ||
Revision as of 17:44, 16 August 2007
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
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